Method: computeRouteMatrix

รับรายการต้นทางและปลายทาง แล้วแสดงผลสตรีมที่มีข้อมูลเส้นทางสำหรับชุดค่าผสมต้นทางและปลายทางแต่ละชุด

หมายเหตุ: วิธีการนี้กำหนดให้คุณระบุมาสก์ช่องคำตอบในอินพุต คุณสามารถระบุฟิลด์มาสก์การตอบกลับได้โดยใช้พารามิเตอร์ของ 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/v1:computeRouteMatrix

URL ใช้ไวยากรณ์การแปลง gRPC

เนื้อหาของคำขอ

เนื้อความของคำขอมีข้อมูลซึ่งมีโครงสร้างดังต่อไปนี้

การแสดง JSON
{
  "origins": [
    {
      object (RouteMatrixOrigin)
    }
  ],
  "destinations": [
    {
      object (RouteMatrixDestination)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "departureTime": string
}
ช่อง
origins[]

object (RouteMatrixOrigin)

ต้องระบุ อาร์เรย์ของต้นทาง ซึ่งกําหนดแถวของเมทริกซ์การตอบสนอง มีข้อจำกัดด้านขนาดหลายอย่างเกี่ยวกับจำนวนสมาชิกในเซ็ตของต้นทางและปลายทาง ดังนี้

  • จำนวนองค์ประกอบ (ต้นทาง × ปลายทาง) ต้องไม่เกิน 625 ไม่ว่าในกรณีใดก็ตาม
  • จํานวนองค์ประกอบ (ต้นทาง × ปลายทาง) ต้องไม่เกิน 100 หากตั้งค่า routingPreference เป็น TRAFFIC_AWARE_OPTIMAL
  • จำนวนจุดอ้างอิง (ต้นทาง + ปลายทาง) ที่ระบุเป็น placeId ต้องไม่เกิน 50
destinations[]

object (RouteMatrixDestination)

ต้องระบุ อาร์เรย์ของปลายทาง ซึ่งจะกำหนดคอลัมน์ของเมทริกซ์การตอบสนอง

travelMode

enum (RouteTravelMode)

ไม่บังคับ ระบุรูปแบบการเดินทาง

routingPreference

enum (RoutingPreference)

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

departureTime

string (Timestamp format)

ไม่บังคับ เวลาออกเดินทาง หากไม่ได้ตั้งค่านี้ ค่าเริ่มต้นจะเป็นเวลาที่ส่งคำขอ หากคุณตั้งค่านี้เป็นเวลาที่เกิดขึ้นแล้ว คำขอจะล้มเหลว

การประทับเวลาจะอยู่ในรูปแบบ RFC3339 UTC "Zulu" ที่มีความละเอียดระดับนาโนวินาทีและมีตัวเลขเศษส่วนสูงสุด 9 หลัก ตัวอย่างเช่น "2014-10-02T15:01:23Z" และ "2014-10-02T15:01:23.045123456Z"

เนื้อหาการตอบกลับ

หากสำเร็จ เนื้อหาการตอบกลับจะมีสตรีมของอินสแตนซ์ RouteMatrixElement รายการ

ขอบเขตการให้สิทธิ์

ต้องใช้ขอบเขต OAuth ต่อไปนี้

  • https://www.googleapis.com/auth/maps-platform.routespreferred

สำหรับข้อมูลเพิ่มเติม โปรดดูที่ภาพรวมของ OAuth 2.0