เลือกช่องที่จะส่งคืน

เมื่อเรียกใช้เมธอด ComputeRoutes() คุณต้องระบุช่องที่ต้องการให้แสดงผลในการตอบกลับ คุณทำได้โดยใช้มาสก์ฟิลด์การตอบกลับ ซึ่ง คุณระบุด้วยพารามิเตอร์ URL $fields หรือ fields หรือโดยใช้ ส่วนหัว HTTP/gRPC X-Goog-FieldMask ดูข้อมูลเพิ่มเติมได้ที่ พารามิเตอร์ของระบบ

มาสก์ฟิลด์

ค่าของมาสก์ฟิลด์คือรายการเส้นทางของฟิลด์ที่คั่นด้วยคอมมา เส้นทางฟิลด์แต่ละรายการ คือรายการชื่อฟิลด์ที่คั่นด้วยจุดซึ่งแสดงถึงลำดับชั้นของข้อความ ชื่อฟิลด์คือคีย์ออบเจ็กต์ JSON หรือชื่อแท็กฟิลด์ Protobuf เส้นทางฟิลด์ เริ่มต้นจากประเภทข้อความตอบกลับระดับบนสุด และอาจ ตามด้วยจุดอย่างน้อย 1 จุด แล้วตามด้วยชื่อฟิลด์ระดับถัดไป โดยทั่วไปแล้ว เส้นทางฟิลด์จะสร้างขึ้นในลักษณะต่อไปนี้

topLevelField[.secondLevelField][.thirdLevelField][...]

ฟิลด์มาสก์กรณีพิเศษคือไวลด์การ์ด "*" ซึ่งเลือกฟิลด์ระดับรูททั้งหมด

ตัวอย่าง

ตัวอย่างต่อไปนี้แสดงวิธีตั้งค่ามาสก์ฟิลด์สำหรับเมธอด ComputeRoutes()

ตัวอย่างที่ 1

ฟิลด์มาสก์ของฟิลด์ที่มีอยู่ทั้งหมด (สำหรับการตรวจสอบด้วยตนเอง)

X-Goog-FieldMask: *

ตัวอย่างที่ 2

ฟิลด์มาสก์ของระยะเวลา ระยะทาง และเส้นหลายจุดระดับเส้นทาง (ตัวอย่างการตั้งค่าเวอร์ชันที่ใช้งานจริง)

X-Goog-FieldMask: routes.duration,routes.distanceMeters,routes.polyline

เราไม่แนะนำให้ใช้มาสก์ช่องการตอบกลับแบบไวลด์การ์ด (*) หรือการระบุมาสก์ช่องที่ระดับบนสุด (เส้นทาง) ในการใช้งานจริง การเลือกเฉพาะ ฟิลด์ที่คุณต้องการมีข้อดีดังนี้

  • ช่วยให้เซิร์ฟเวอร์ของเราประหยัดรอบการประมวลผล ซึ่งช่วยให้เราแสดงผลลัพธ์ของคุณได้โดยมีเวลาในการตอบสนองที่ต่ำกว่า

  • ช่วยให้ประสิทธิภาพเวลาในการตอบสนองมีความเสถียร เราอาจเพิ่มช่องคำตอบเพิ่มเติมในอนาคต และช่องใหม่เหล่านั้นอาจต้องใช้เวลาในการคำนวณเพิ่มเติม หากเลือก ทุกช่อง หรือหากเลือกทุกช่องที่ระดับบนสุด คุณอาจพบว่า ประสิทธิภาพลดลงเนื่องจากระบบจะรวมช่องใหม่ที่เราเพิ่มลงในคำตอบของคุณโดยอัตโนมัติ

  • ส่งผลให้ขนาดการตอบกลับเล็กลง ซึ่งจะทำให้มีปริมาณงานของเครือข่ายสูงขึ้น

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีสร้างเส้นทางฟิลด์ได้ที่ field_mask.proto