เมื่อ Routes API คำนวณเส้นทาง ระบบจะใช้จุดอ้างอิงและพารามิเตอร์การกำหนดค่าที่คุณระบุเป็นอินพุต จากนั้น API จะส่งคืนการตอบกลับที่มีเส้นทางเริ่มต้นและเส้นทางอื่นอย่างน้อย 1 เส้นทาง
คำตอบของคุณอาจมีเส้นทางประเภทต่างๆ และข้อมูลอื่นๆ ตามช่องที่คุณขอ ดังนี้
เพื่อรวมข้อมูลนี้ไว้ในคำตอบ | ดูเอกสารนี้ |
---|---|
เส้นทางที่ประหยัดเชื้อเพลิงหรือพลังงานมากที่สุดโดยอิงตามประเภทเครื่องยนต์ของรถ | กำหนดค่าเส้นทางที่เป็นมิตรต่อสิ่งแวดล้อม |
เส้นทางสำรองสูงสุด 3 เส้นทาง | ส่งคำขอเส้นทางอื่น |
เส้นประกอบของทั้งเส้นทาง สำหรับขาแต่ละข้างของเส้นทาง และสำหรับก้าว ของขาแต่ละก้าว | ส่งคำขอเส้นประกอบเส้นทาง |
ค่าผ่านทางโดยประมาณเมื่อพิจารณาถึงส่วนลดค่าผ่านทางหรือบัตรผ่านสำหรับคนขับหรือยานพาหนะ | คำนวณค่าผ่านทาง |
คำตอบที่แปลแล้วตามรหัสภาษาและหน่วยวัด (ระบบอิมพีเรียลหรือเมตริก) | ขอค่าที่แปลแล้ว |
หากต้องการจัดรูปแบบวิธีการนําทางเป็นสตริงข้อความ HTML ให้เพิ่ม HTML_FORMATTED_NAVIGATION_INSTRUCTIONS ลงใน extraComputations |
การคำนวณเพิ่มเติม |
สำหรับรายการตัวเลือกอินพุตทั้งหมด โปรดดูตัวเลือกเส้นทางที่มีอยู่และเนื้อหาคำขอ
ด้วยคำตอบดังกล่าว คุณจะให้ข้อมูลที่จำเป็นต่อการเลือกเส้นทางที่เหมาะสมสำหรับความต้องการของลูกค้าได้
เกี่ยวกับฟิลด์มาสก์
เมื่อเรียกใช้เมธอดเพื่อคำนวณเส้นทาง คุณต้องระบุมาสก์ของช่องที่กำหนดช่องที่คุณต้องการให้แสดงในคำตอบ โดยจะไม่มีรายการเริ่มต้นของฟิลด์ที่แสดงผล หากคุณไม่ใส่รายการนี้ เมธอดจะแสดงข้อผิดพลาด
ตัวอย่างในเอกสารนี้จะแสดงออบเจ็กต์การตอบสนองทั้งหมดโดยไม่นำฟิลด์มาสก์มาพิจารณา ในสภาพแวดล้อมการใช้งานจริง การตอบกลับของคุณจะรวมเฉพาะช่องที่คุณระบุในมาสก์ของช่องเท่านั้น
โปรดดูข้อมูลเพิ่มเติมที่หัวข้อเลือกข้อมูลที่จะแสดง
เกี่ยวกับการแสดงลิขสิทธิ์
คุณต้องรวมข้อความลิขสิทธิ์ต่อไปนี้เมื่อแสดงผลลัพธ์ให้แก่ผู้ใช้ของคุณ:
Powered by Google, ©YEAR Google
เช่น
Powered by Google, ©2023 Google
เกี่ยวกับเส้นทาง ขา และจำนวนก้าว
ก่อนที่จะดูการตอบกลับที่ Routes API แสดงผล คุณควรเข้าใจองค์ประกอบที่ประกอบกันเป็นเส้นทางดังนี้
คำตอบของคุณอาจมีข้อมูลเกี่ยวกับองค์ประกอบของเส้นทางเหล่านี้แต่ละอย่าง
เส้นทาง: การเดินทางทั้งหมดตั้งแต่จุดอ้างอิงต้นทาง ผ่านจุดอ้างอิงระดับกลาง ไปจนถึงจุดอ้างอิงของจุดหมาย เส้นทางประกอบด้วยขา 1 ขาขึ้นไป
เส้นทาง: เส้นทางจากจุดอ้างอิงหนึ่งในเส้นทางไปยังจุดอ้างอิงถัดไปในเส้นทาง ขาแต่ละข้างประกอบด้วยก้าวที่แยกกันอย่างน้อย 1 ก้าว
เส้นทางประกอบด้วย ขาแยกสำหรับเส้นทางจากจุดอ้างอิงแต่ละจุดไปยังจุดถัดไป ตัวอย่างเช่น หากเส้นทางมีจุดอ้างอิงต้นทางจุดเดียวและจุดอ้างอิงปลายทางจุดเดียว เส้นทางดังกล่าวก็จะมีขาเดียว สำหรับจุดอ้างอิงเพิ่มเติมแต่ละรายการที่คุณเพิ่มไปยังเส้นทางหลังต้นทางและปลายทาง ซึ่งเรียกว่าจุดอ้างอิงกลาง API จะเพิ่มขาแยกต่างหาก
API จะไม่เพิ่มขาสำหรับจุดอ้างอิงกลางแบบส่งผ่าน ตัวอย่างเช่น เส้นทางที่มีจุดอ้างอิงต้นทาง จุดอ้างอิงระหว่างทาง และจุดอ้างอิงปลายทางมีเพียงขาเดียวจากต้นทางไปยังปลายทาง ขณะที่ผ่านจุดอ้างอิง ดูข้อมูลเพิ่มเติมเกี่ยวกับจุดอ้างอิงส่งผ่านได้ที่กำหนดจุดอ้างอิงส่งผ่าน
ขั้นตอน: คำสั่งเดียวตามเส้นทาง "ก้าว" คือหน่วยอะตอม ที่ดีที่สุดของเส้นทาง เช่น ก้าวหนึ่งอาจระบุว่า "เลี้ยวซ้าย บนถนนหลัก''
คำตอบที่แสดงในคำตอบ
ออบเจ็กต์ JSON ที่แสดงการตอบกลับ API มีพร็อพเพอร์ตี้ระดับบนสุดต่อไปนี้
routes
คืออาร์เรย์ขององค์ประกอบประเภทเส้นทาง อาร์เรย์routes
มีองค์ประกอบ 1 รายการสำหรับแต่ละเส้นทางที่ API แสดงผล อาร์เรย์มีองค์ประกอบได้สูงสุด 5 รายการ ได้แก่ เส้นทางเริ่มต้น เส้นทางที่เป็นมิตรต่อสิ่งแวดล้อม และเส้นทางทางเลือกสูงสุด 3 เส้นทางgeocodingResults
ซึ่งเป็นอาร์เรย์ขององค์ประกอบประเภท GeocodingResults สำหรับสถานที่ทุกแห่งในคำขอ (ต้นทาง จุดหมาย หรือจุดอ้างอิงระหว่างกลาง) ที่คุณระบุเป็นสตริงที่อยู่หรือเป็น Plus Code API จะดำเนินการค้นหารหัสสถานที่ แต่ละองค์ประกอบของอาร์เรย์จะมีรหัสสถานที่ที่สอดคล้องกับตำแหน่ง ไม่รวมตำแหน่งในคำขอที่ระบุเป็นรหัสสถานที่หรือเป็นพิกัดละติจูด/ลองจิจูด หากคุณระบุตำแหน่งทั้งหมดโดยใช้รหัสสถานที่หรือพิกัดละติจูดและลองจิจูด ระบบจะไม่ระบุอาร์เรย์นี้fallbackInfo
ประเภท FallbackInfo หาก API ไม่สามารถคำนวณเส้นทางจากพร็อพเพอร์ตี้อินพุตทั้งหมดได้ API นี้อาจสำรองใช้วิธีคำนวณแบบอื่น เมื่อใช้โหมดสำรอง ช่องนี้จะมีข้อมูลโดยละเอียดเกี่ยวกับการตอบกลับสำรอง ไม่เช่นนั้นระบบจะไม่ตั้งค่าช่องนี้
คำตอบจะมีแบบฟอร์มดังนี้
{ // The routes array. "routes": [ { object (Route) } ], // The place ID lookup results. "geocodingResults": [ { object (GeocodedWaypoint) } ], // The fallback property. "fallbackInfo": { object (FallbackInfo) } }
ถอดรหัสอาร์เรย์เส้นทาง
การตอบกลับจะมีอาร์เรย์ routes
ซึ่งองค์ประกอบอาร์เรย์แต่ละรายการเป็นประเภท Route
องค์ประกอบอาร์เรย์แต่ละรายการจะแสดงเส้นทางทั้งเส้นทางจากต้นทางไปยังปลายทาง API จะแสดงผลเส้นทางอย่างน้อย 1 เส้นทาง ซึ่งเรียกว่าเส้นทางเริ่มต้นเสมอ
คุณสามารถขอเส้นทางเพิ่มเติม หากคุณขอเส้นทางที่เป็นมิตรต่อสิ่งแวดล้อม อาร์เรย์จะมีองค์ประกอบ 2 รายการ ได้แก่ เส้นทางเริ่มต้นและเส้นทางที่เป็นมิตรต่อสิ่งแวดล้อม หรือตั้งค่า computeAlternativeRoutes
เป็น true
ในคำขอเพื่อเพิ่มเส้นทางอื่นไปยังคำตอบได้สูงสุด 3 เส้นทาง
แต่ละเส้นทางในอาร์เรย์จะระบุด้วยพร็อพเพอร์ตี้อาร์เรย์ routeLabels
ดังนี้
ค่า | คำอธิบาย |
---|---|
DEFAULT_ROUTE |
ระบุเส้นทางเริ่มต้น |
FUEL_EFFICIENT |
ระบุเส้นทางที่เป็นมิตรต่อสิ่งแวดล้อม |
DEFAULT_ROUTE_ALTERNATE |
ระบุเส้นทางอื่น |
อาร์เรย์ legs
มีคำจำกัดความของแต่ละเส้นทาง พร็อพเพอร์ตี้ที่เหลือ เช่น distanceMeters
, duration
และ polyline,
จะมีข้อมูลเกี่ยวกับเส้นทางโดยรวม ดังนี้
{ "routeLabels": [ enum (RouteLabel) ], "legs": [ { object (RouteLeg) } ], "distanceMeters": integer, "duration": string, "routeLabels": [string], "staticDuration": string, "polyline": { object (Polyline) }, "description": string, "warnings": [ string ], "viewport": { object (Viewport) }, "travelAdvisory": { object (RouteTravelAdvisory) } "routeToken": string }
เส้นทางเริ่มต้นและเส้นทางที่เป็นมิตรต่อสิ่งแวดล้อมอาจเหมือนกันเนื่องจากสภาพการขับขี่ในปัจจุบันและปัจจัยอื่นๆ ในกรณีนี้ อาร์เรย์ routeLabels
จะมีทั้งป้ายกำกับ DEFAULT_ROUTE
และ FUEL_EFFICIENT
{ "routes": [ { "routeLabels": [ "DEFAULT_ROUTE", "FUEL_EFFICIENT" ], … } ] }
ทำความเข้าใจอาร์เรย์ขา
route
แต่ละรายการในการตอบกลับจะมีอาร์เรย์ legs
โดยที่องค์ประกอบอาร์เรย์ legs
แต่ละรายการเป็นประเภท RouteLeg
ขาแต่ละข้างในอาร์เรย์จะกำหนดเส้นทางจากจุดอ้างอิงหนึ่งไปยังจุดอ้างอิงถัดไปตลอดเส้นทาง เส้นทางต้องมีขาอย่างน้อย 1 ขาเสมอ
พร็อพเพอร์ตี้ legs
มีคําจํากัดความของแต่ละขั้นตอนตลอดเส้นทางในอาร์เรย์ steps
พร็อพเพอร์ตี้ที่เหลือ เช่น distanceMeters
, duration
และ polyline
มีข้อมูลเกี่ยวกับขา
{ "distanceMeters": integer, "duration": string, "staticDuration": string, "polyline": { object (Polyline) }, "startLocation": { object (Location) }, "endLocation": { object (Location) }, "steps": [ { object (RouteLegStep) } ], "travelAdvisory": { object (RouteLegTravelAdvisory) } }
ทำความเข้าใจอาร์เรย์ขั้นตอน
แต่ละขาในการตอบสนองจะมีอาร์เรย์ steps
โดยที่องค์ประกอบอาร์เรย์ steps
แต่ละรายการเป็นประเภท RouteLegStep
ขั้นตอนจะสอดคล้องกับคำสั่งเดียวตามรอบขา ขามักมีอย่างน้อย 1 ก้าว
องค์ประกอบแต่ละรายการในอาร์เรย์ steps
จะมีพร็อพเพอร์ตี้ navigationInstruction
ประเภท NavigationInstruction ซึ่งมีวิธีการแบบทีละขั้นตอน เช่น
"navigationInstruction": { "maneuver": "TURN_LEFT", "instructions": "Turn left toward Frontage Rd" }
instructions
อาจมีข้อมูลเพิ่มเติมเกี่ยวกับขั้นตอนนี้ ตัวอย่างเช่น
"navigationInstruction": { "maneuver": "TURN_SLIGHT_LEFT", "instructions": "Slight left (signs for I-90 W/Worcester)nParts of this road may be closed at certain times or days" }
พร็อพเพอร์ตี้ที่เหลือในขั้นตอนจะอธิบายข้อมูลเกี่ยวกับขั้นตอน เช่น distanceMeters
, duration
และ polyline
{ "distanceMeters": integer, "staticDuration": string, "polyline": { object (Polyline) }, "startLocation": { object (Location) }, "endLocation": { object (Location) }, "navigationInstruction": { object (NavigationInstruction) } }
ระบุภาษาของคำแนะนำขั้นตอน
API จะแสดงผลข้อมูลเส้นทางในภาษาท้องถิ่น โดยถอดเสียงเป็นสคริปต์ที่ผู้ใช้อ่านได้ (หากจำเป็น) พร้อมกับสังเกตภาษาที่ต้องการ ระบบจะแสดงคอมโพเนนต์ที่อยู่ทั้งหมดในภาษาเดียวกัน
ใช้พารามิเตอร์
languageCode
ของคำขอเพื่อตั้งค่าภาษาเส้นทางอย่างชัดแจ้งจากรายการภาษาที่รองรับ Google มักจะอัปเดตภาษาที่รองรับ ดังนั้นรายการนี้จึงอาจไม่ครบถ้วนสมบูรณ์หากไม่มีชื่อในภาษาที่ระบุ API จะใช้การจับคู่ที่ตรงกันที่สุด
ภาษาที่ระบุอาจมีผลต่อชุดผลลัพธ์ที่ API เลือกจะแสดงผล และลำดับในการแสดง โปรแกรมเข้ารหัสพิกัดภูมิศาสตร์จะแปลตัวย่อแตกต่างกันไปตามภาษา เช่น ตัวย่อสำหรับประเภทถนน หรือคำพ้องความหมายที่ใช้ได้ในภาษาหนึ่ง แต่ใช้ได้ในอีกภาษาหนึ่งไม่ได้ เช่น utca และ tér เป็นคำพ้องความหมายของ ถนนในฮังการี
ทำความเข้าใจอาร์เรย์ผลการเข้ารหัสทางภูมิศาสตร์
สำหรับสถานที่ทุกแห่งในคำขอ (ต้นทาง จุดหมาย หรือจุดอ้างอิงระหว่างกลาง) ที่ระบุเป็นสตริงที่อยู่หรือเป็น Plus Code API จะพยายามค้นหาตำแหน่งที่เกี่ยวข้องมากที่สุดซึ่งมีรหัสสถานที่ที่สอดคล้องกัน องค์ประกอบแต่ละรายการของอาร์เรย์ geocodingResults
ประกอบด้วยช่อง placeID
ที่มีสถานที่เป็นรหัสสถานที่และช่อง type
ซึ่งระบุประเภทสถานที่ เช่น street_address
, premise
หรือ airport
อาร์เรย์ geocodingResults
มี 3 ฟิลด์ ดังนี้
origin
: หากระบุเป็นสตริงที่อยู่หรือเป็น Plus Code จะหมายถึงรหัสสถานที่ของต้นทาง ไม่เช่นนั้น ช่องนี้จะไม่แสดงในคำตอบdestination
: หากระบุเป็นสตริงที่อยู่หรือเป็น Plus Code ระบบจะใช้รหัสสถานที่ของปลายทาง ไม่เช่นนั้น ช่องนี้จะไม่รวมอยู่ในคำตอบintermediates
: อาร์เรย์ที่มีรหัสสถานที่ของจุดอ้างอิงระดับกลางที่ระบุเป็นสตริงที่อยู่หรือเป็น Plus Code หากคุณระบุจุดอ้างอิงตรงกลางโดยใช้รหัสสถานที่หรือพิกัดละติจูดและลองจิจูด รายการนี้จะไม่แสดงในคำตอบ ใช้พร็อพเพอร์ตี้intermediateWaypointRequestIndex
ในการตอบกลับเพื่อกำหนดจุดอ้างอิงระดับกลางในคำขอที่สอดคล้องกับรหัสสถานที่ในคำตอบ
"geocodingResults": { "origin": { "geocoderStatus": {}, "type": [ enum (Type) ], "placeId": string }, "destination": { "geocoderStatus": {}, "type": [ enum (Type) ], "placeId": string }, "intermediates": [ { "geocoderStatus": {}, "intermediateWaypointRequestIndex": integer, "type": [ enum (Type) ], "placeId": string }, { "geocoderStatus": {}, "intermediateWaypointRequestIndex": integer, "type": [ enum (Type) ], "placeId": string } ] }
ทำความเข้าใจค่าคำตอบที่แปลแล้ว
ค่าการตอบกลับที่แปลแล้วเป็นช่องคำตอบเพิ่มเติมที่มีข้อความแปลสำหรับค่าพารามิเตอร์ที่แสดงผล ข้อความที่แปลแล้วมีให้สำหรับระยะเวลาการเดินทาง ระยะทาง และระบบหน่วย (เมตริกหรือระบบอิมพีเรียล) คุณขอค่าที่แปลโดยใช้มาสก์ของช่อง รวมถึงระบุภาษาและหน่วยหน่วยหรือใช้ค่าที่อนุมานโดย API ได้ ดูรายละเอียดได้ที่ LocalizedValues
เช่น หากระบุรหัสภาษาสำหรับหน่วยเยอรมัน (de) และอิมพีเรียล คุณจะได้ค่า distanceMeters
เป็น 49889.7 แต่ยังเป็นข้อความที่แปลแล้วซึ่งมีการวัดระยะทางในหน่วยภาษาเยอรมันและหน่วยอิมพีเรียล เช่น "31 Meile"
ต่อไปนี้คือตัวอย่างของสิ่งที่คุณจะเห็นสำหรับค่าที่แปลแล้ว
{ "localized_values": { "distance": { "text": "31,0 Meile/n" }, "duration": { "text": 38 Minuten}. "static_duration": { "text": 36 Minuten}. } }
หากคุณไม่ระบุภาษาหรือระบบหน่วย API จะอนุมานภาษาและหน่วยดังนี้
- เมธอด
ComputeRoutes
จะอนุมานหน่วยตำแหน่งและระยะทางจากจุดอ้างอิงต้นทาง ดังนั้นสําหรับคําขอการกำหนดเส้นทางในสหรัฐอเมริกา API จะอนุมานภาษาen-US
และหน่วยIMPERIAL
- เมธอด
ComputeRouteMatrix
มีค่าเริ่มต้นเป็นภาษา "en-US" และหน่วย METRIC