รับรายการต้นทางและปลายทาง แล้วแสดงผลสตรีมที่มีข้อมูลเส้นทางสำหรับชุดค่าผสมของต้นทางและปลายทางแต่ละรายการ
หมายเหตุ: วิธีการนี้กำหนดให้คุณระบุมาสก์ช่องคำตอบในอินพุต คุณสามารถระบุฟิลด์มาสก์การตอบกลับได้โดยใช้พารามิเตอร์ของ URL $fields
หรือ fields
หรือใช้ส่วนหัว HTTP/gRPC X-Goog-FieldMask
(ดูพารามิเตอร์และส่วนหัว URL ที่ใช้ได้ ค่าดังกล่าวเป็นรายการเส้นทางของช่องที่คั่นด้วยคอมมา โปรดดูเอกสารประกอบโดยละเอียดเกี่ยวกับวิธีสร้างเส้นทางช่อง
ตัวอย่างเช่น ด้วยวิธีนี้
- ฟิลด์มาสก์ของช่องที่ใช้ได้ทั้งหมด (สำหรับการตรวจสอบด้วยตนเอง):
X-Goog-FieldMask: *
- ฟิลด์มาสก์ของระยะเวลาเส้นทาง ระยะทาง สถานะองค์ประกอบ เงื่อนไข และดัชนีองค์ประกอบ (ตัวอย่างการตั้งค่าการสร้าง):
X-Goog-FieldMask: originIndex,destinationIndex,status,condition,distanceMeters,duration
คุณจำเป็นต้องใส่ status
ในมาสก์ของช่อง ไม่เช่นนั้นข้อความทั้งหมดจะเรียบร้อยดี Google ไม่แนะนำให้ใช้มาสก์ช่องคำตอบที่เป็นไวลด์การ์ด (*
) เนื่องจากเหตุผลต่อไปนี้
- การเลือกเฉพาะช่องที่คุณต้องการจะช่วยให้เซิร์ฟเวอร์ของเราประหยัดรอบการประมวลผล ซึ่งช่วยให้เราแสดงผลลัพธ์ให้คุณได้เร็วขึ้น
- การเลือกเฉพาะฟิลด์ที่คุณต้องการในงานที่ใช้งานจริงจะทำให้ประสิทธิภาพของเวลาในการตอบสนองเสถียร เราอาจเพิ่มช่องคำตอบเพิ่มเติมในอนาคต และช่องใหม่เหล่านั้นอาจต้องใช้เวลาในการประมวลผลเพิ่มเติม หากเลือกช่องทั้งหมดหรือทุกช่องที่ระดับบนสุด คุณอาจพบว่าประสิทธิภาพการทำงานลดลงเนื่องจากระบบจะรวมช่องใหม่ใดๆ ที่เราเพิ่มไว้ในคำตอบโดยอัตโนมัติ
- การเลือกเฉพาะช่องที่ต้องการจะทำให้คำตอบมีขนาดเล็กลงและทำให้การรับส่งข้อมูลของเครือข่ายมีประสิทธิภาพมากขึ้น
คำขอ HTTP
POST https://routespreferred.googleapis.com/v1alpha:computeRouteMatrix
URL ใช้ไวยากรณ์การแปลง gRPC
เนื้อหาของคำขอ
เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้
การแสดง JSON |
---|
{ "origins": [ { object ( |
ช่อง | |
---|---|
origins[] |
ต้องระบุ อาร์เรย์ของต้นทาง ซึ่งกําหนดแถวของเมทริกซ์การตอบสนอง มีข้อจํากัดด้านขนาดหลายประการสําหรับ Cardinality ของต้นทางและปลายทาง ดังนี้
|
destinations[] |
ต้องระบุ อาร์เรย์ของปลายทาง ซึ่งจะเป็นตัวกำหนดคอลัมน์ของเมทริกซ์การตอบกลับ |
travel |
ไม่บังคับ ระบุรูปแบบการเดินทาง |
routing |
ไม่บังคับ ระบุวิธีคํานวณเส้นทาง เซิร์ฟเวอร์จะพยายามใช้การตั้งค่าเส้นทางที่เลือกไว้เพื่อคำนวณเส้นทาง หากค่ากำหนดการกำหนดเส้นทางทำให้เกิดข้อผิดพลาดหรือเวลาในการตอบสนองที่นานขึ้น ระบบจะแสดงข้อผิดพลาด คุณสามารถระบุตัวเลือกนี้ได้เฉพาะเมื่อ |
departure |
ไม่บังคับ เวลาออกเดินทาง หากไม่ได้ตั้งค่านี้ ค่าเริ่มต้นจะเป็นเวลาที่ส่งคำขอ หากคุณตั้งค่านี้เป็นเวลาที่ผ่านไปแล้ว คำขอจะดำเนินการไม่สำเร็จ การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่างเช่น |
เนื้อหาการตอบกลับ
หากสำเร็จ เนื้อหาการตอบกลับจะมีสตรีมของอินสแตนซ์ RouteMatrixElement
รายการ
ขอบเขตการให้สิทธิ์
ต้องใช้ขอบเขต OAuth ต่อไปนี้
https://www.googleapis.com/auth/maps-platform.routespreferred
สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0