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

เมื่อเรียกใช้เมธอด 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.