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

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