เลือกข้อมูลที่จะแสดง

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

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

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

ดูข้อมูลเพิ่มเติมเกี่ยวกับพารามิเตอร์ของ URL ได้ที่พารามิเตอร์ระบบ

กำหนดมาสก์ของช่องการตอบกลับ

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

สร้างเส้นทางช่องดังนี้

topLevelField[.secondLevelField][.thirdLevelField][...]
  • มาสก์ช่องเส้นทางการประมวลผล
    • REST: ระบุช่องของออบเจ็กต์ Route ในการตอบสนองที่จะส่งกลับ ซึ่งนำหน้าด้วย routes. เช่น routes.distanceMeters
    • gRPC: ระบุช่องของออบเจ็กต์ Route ในการตอบสนองที่จะแสดงผล
  • มาสก์ฟิลด์สำหรับเมตริกซ์เส้นทางประมวลผล

ดูข้อมูลเพิ่มเติมเกี่ยวกับวิธีสร้างฟิลด์มาสก์ได้ที่ field_mask.proto

กำหนดฟิลด์มาสก์ที่จะใช้

คุณกำหนดฟิลด์มาสก์ที่ต้องการใช้ได้โดยทำดังนี้

  1. ขอฟิลด์ทั้งหมดโดยใช้มาสก์ของช่อง *
  2. ดูลำดับชั้นของช่องในคำตอบและพิจารณาช่องที่ต้องการ
  3. สร้างมาสก์ของช่องโดยใช้ลำดับชั้นของช่อง

เช่น คำตอบบางส่วนจากเส้นทางขนส่งสาธารณะ

 "routes": [
  {
    "legs": [
    {
      "distanceMeters": 12886,
    }
...
]}]

หากต้องการแสดงผลเฉพาะช่อง distanceMeters มาสก์ของช่องจะมีลักษณะดังนี้

routes.legs.distanceMeters

อีกตัวอย่างหนึ่ง: หากต้องการให้แสดงทุกอย่างภายใต้ legs ในคำตอบ มาสก์ของช่องคุณจะต้องดังนี้

routes.legs

ระบุเส้นทางช่อง

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

REST โทรหา computeRoutes

ในตัวอย่างแรก คุณใช้การเรียก REST ไปยังเมธอด computeRoutes เพื่อคำนวณเส้นทาง ในตัวอย่างนี้ คุณระบุมาสก์ช่องเพื่อแสดงช่อง Route.distanceMeters และ Route.duration ในคำตอบได้ในส่วนหัว อย่าลืมใส่คำนำหน้าชื่อช่องตาม routes 

-H X-Goog-FieldMask: routes.distanceMeters,routes.duration

REST โทรหา computeRouteMatrix

สำหรับเมธอด REST computeRouteMatrix ที่ใช้คำนวณเมทริกซ์เส้นทาง ในส่วนหัว ให้ระบุเพื่อให้แสดงผล originIndex, destinationIndex และ duration สำหรับชุดค่าผสมแต่ละชุดของต้นทางและปลายทาง ดังนี้

-H X-Goog-FieldMask: originIndex,destinationIndex,duration

การโทร gRPC

สำหรับ gRPC ให้ตั้งค่าตัวแปรที่มีมาสก์ฟิลด์การตอบสนอง จากนั้นคุณจะส่งผ่านตัวแปรนั้นไปยังคำขอได้

const (
  fieldMask = "routes.distanceMeters,routes.duration,routes.polyline.encodedPolyline"
)

ข้อควรพิจารณาเกี่ยวกับเส้นทางช่อง

ใส่เฉพาะช่องที่คุณกําหนดในคําตอบ โดยแสดงผลเฉพาะ ช่องที่คุณต้องการ

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

ขอโทเค็นเส้นทาง

หากต้องการขอให้ Routes API แสดงผลโทเค็นเส้นทางสำหรับเส้นทางที่สร้างขึ้น ให้ทำตามข้อกำหนดในการส่งคืนโทเค็นเส้นทาง จากนั้นใช้มาสก์ฟิลด์ routes.route_token เพื่อขอโทเค็น

  1. ตั้งค่า travel_mode เป็น DRIVING
  2. โปรดตั้งค่า routing_preference เป็น TRAFFIC_AWARE หรือ TRAFFIC_AWARE_OPTIMAL
  3. ตรวจสอบว่าไม่มีจุดอ้างอิงของเส้นทางที่เป็นจุดอ้างอิง via จุด
  4. ระบุมาสก์ช่องโทเค็นเส้นทาง 
    -H X-Goog-FieldMask: routes.route_token

คุณใช้เส้นทางที่วางแผนไว้ใน SDK การนำทางได้ โปรดดูรายละเอียดเพิ่มเติมที่หัวข้อ วางแผนเส้นทาง (Android) หรือวางแผนเส้นทาง (iOS)

ตัวอย่างโทเค็นเส้นทาง

ต่อไปนี้คือตัวอย่างเนื้อหาของคำขอ cURL สำหรับต้นทางเดียว เส้นทางปลายทางเดียว โดยใช้มาสก์ช่องเพื่อขอโทเค็นเส้นทาง พร้อมทั้งระยะเวลา ระยะทาง และเส้นทางโพลีไลน์

curl -X POST -d
{"origin":{
    "location": {
        "latLng":{
            "latitude":  -37.8167,
            "longitude": 144.9619
        }
    }
},
"destination":{
    "location": {
        "latLng":{
            "latitude":-37.8155,
            "longitude": 144.9663
        }
    }
},
"routingPreference":"TRAFFIC_AWARE",
"travelMode":"DRIVE"
}
-H 'X-Goog-Api-Key: YOUR_API_KEY' \
-H X-Goog-FieldMask: routes.route_token,routes.duration,routes.distanceMeters,routes.polyline.encodedPolyline
'https://routes.googleapis.com/directions/v2:computeRoutes'

ดูรายละเอียดเพิ่มเติมได้ที่เอกสารอ้างอิง Compute Routes API