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

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