Method: computeCustomRoutes

จะคำนวณเส้นทางที่ดีที่สุดสำหรับวัตถุประสงค์ของเส้นทางโดยพิจารณาจากชุดจุดอ้างอิงและจุดระหว่างกลาง ตลอดจนวัตถุประสงค์ของเส้นทาง นอกจากนี้ยังแสดงผลเส้นทางที่เร็วที่สุดและสั้นที่สุดเป็นเส้นทางอ้างอิง

หมายเหตุ: คุณต้องระบุมาสก์ช่องคำตอบในอินพุตสำหรับวิธีนี้ คุณสามารถระบุฟิลด์มาสก์การตอบกลับได้โดยใช้พารามิเตอร์ของ URL $fields หรือ fields หรือใช้ส่วนหัว HTTP/gRPC X-Goog-FieldMask (ดูพารามิเตอร์และส่วนหัว URL ที่ใช้ได้ ค่าดังกล่าวเป็นรายการเส้นทางของช่องที่คั่นด้วยคอมมา ดูเอกสารประกอบโดยละเอียดเกี่ยวกับวิธีสร้างเส้นทางฟิลด์

เช่น ในเมธอดนี้

  • ฟิลด์มาสก์ของช่องที่ใช้ได้ทั้งหมด (สำหรับการตรวจสอบด้วยตนเอง): X-Goog-FieldMask: *
  • ฟิลด์มาสก์ของระยะทาง ระยะเวลา โทเค็น และข้อมูลค่าผ่านทางของเส้นทาง: X-Goog-FieldMask: routes.route.distanceMeters,routes.route.duration,routes.token,routes.route.travelAdvisory.tollInfo

Google ไม่แนะนําให้ใช้ฟิลด์มาสก์คำตอบไวลด์การ์ด (*) หรือระบุฟิลด์มาสก์ที่ระดับบนสุด (routes) เนื่องจากเหตุผลต่อไปนี้

  • การเลือกเฉพาะฟิลด์ที่คุณต้องการช่วยให้เซิร์ฟเวอร์ของเราประหยัดรอบการคำนวณ ทำให้เราสามารถส่งคืนผลลัพธ์ให้คุณโดยมีเวลาในการตอบสนองที่น้อยลง
  • การเลือกเฉพาะฟิลด์ที่คุณต้องการในงานที่ใช้งานจริงจะทำให้ประสิทธิภาพของเวลาในการตอบสนองเสถียร เราอาจเพิ่มช่องคำตอบเพิ่มเติมในอนาคต และช่องใหม่เหล่านั้นอาจต้องใช้เวลาในการประมวลผลเพิ่มเติม หากเลือกช่องทั้งหมดหรือทุกช่องที่ระดับบนสุด คุณอาจพบว่าประสิทธิภาพการทำงานลดลงเนื่องจากระบบจะรวมช่องใหม่ใดๆ ที่เราเพิ่มไว้ในคำตอบโดยอัตโนมัติ
  • การเลือกเฉพาะช่องที่ต้องการจะทำให้การตอบกลับมีขนาดเล็กลง ทำให้อัตราการส่งข้อมูลของเครือข่ายสูงขึ้น

คำขอ HTTP

POST https://routespreferred.googleapis.com/v1:computeCustomRoutes

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

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

เนื้อหาของคำขอมีข้อมูลที่มีโครงสร้างต่อไปนี้

การแสดง JSON
{
  "origin": {
    object (Waypoint)
  },
  "destination": {
    object (Waypoint)
  },
  "intermediates": [
    {
      object (Waypoint)
    }
  ],
  "travelMode": enum (RouteTravelMode),
  "routingPreference": enum (RoutingPreference),
  "polylineQuality": enum (PolylineQuality),
  "polylineEncoding": enum (PolylineEncoding),
  "departureTime": string,
  "routeModifiers": {
    object (RouteModifiers)
  },
  "routeObjective": {
    object (RouteObjective)
  },
  "languageCode": string,
  "units": enum (Units)
}
ช่อง
origin

object (Waypoint)

ต้องระบุ จุดอ้างอิงต้นทาง

destination

object (Waypoint)

ต้องระบุ จุดสังเกตปลายทาง

intermediates[]

object (Waypoint)

ไม่บังคับ ชุดของจุดอ้างอิงตลอดเส้นทาง (ไม่รวมจุดเทอร์มินัล) สำหรับการหยุดแวะหรือที่ผ่าน รองรับจุดอ้างอิงระดับกลางสูงสุด 25 จุด

travelMode

enum (RouteTravelMode)

ไม่บังคับ ระบุรูปแบบการเดินทาง รองรับเฉพาะ DRIVE และ "TWO_WHEELER" เท่านั้น

routingPreference

enum (RoutingPreference)

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

polylineQuality

enum (PolylineQuality)

ไม่บังคับ ระบุค่ากําหนดสำหรับคุณภาพของเส้นประกอบ

polylineEncoding

enum (PolylineEncoding)

ไม่บังคับ ระบุการเข้ารหัสที่ต้องการสำหรับเส้นประกอบ

departureTime

string (Timestamp format)

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

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

routeModifiers

object (RouteModifiers)

ไม่บังคับ ชุดเงื่อนไขที่ต้องเป็นไปตามที่ส่งผลต่อวิธีคำนวณเส้นทาง

routeObjective

object (RouteObjective)

ต้องระบุ วัตถุประสงค์ของเส้นทางที่จะเพิ่มประสิทธิภาพ

languageCode

string

ไม่บังคับ รหัสภาษา BCP-47 เช่น "en-US" หรือ "sr-Latn" โปรดดูข้อมูลเพิ่มเติมที่หัวข้อตัวระบุภาษา Unicode โปรดดูรายการภาษาที่รองรับในการสนับสนุนภาษา หากคุณไม่ได้ระบุค่านี้ ระบบจะอนุมานภาษาที่แสดงจากสถานที่ตั้งของคำขอเส้นทาง

units

enum (Units)

ไม่บังคับ ระบุหน่วยวัดสำหรับฟิลด์แสดงผล ซึ่งรวมถึงช่อง instruction ใน NavigationInstruction หน่วยวัดที่ใช้สำหรับเส้นทาง ช่วง ระยะทางของก้าว และระยะเวลาจะไม่ได้รับผลกระทบจากค่านี้ หากคุณไม่ได้ระบุค่านี้ ระบบจะอนุมานหน่วยการแสดงผลจากตําแหน่งคําขอ

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

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

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

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

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

ดูข้อมูลเพิ่มเติมได้ที่ภาพรวม OAuth 2.0