Package google.maps.navconnect.v1

ดัชนี

บริการสำหรับลูกค้า NavConnect ในการสร้างและรับการเดินทาง

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

สร้างการเดินทาง ต้องเรียกใช้ก่อนที่แอปพลิเคชันบนอุปกรณ์เคลื่อนที่จะเริ่มการเดินทางได้ การเดินทางที่แสดงผลจะมีฟิลด์ auth_token ตั้งค่าไว้

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

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

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร parent

  • navigationconnect.trips.create

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

รับการเดินทาง

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

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

  • https://www.googleapis.com/auth/cloud-platform
สิทธิ์ IAM

ต้องมีสิทธิ์ IAM ต่อไปนี้ในทรัพยากร name

  • navigationconnect.trips.get

ดูข้อมูลเพิ่มเติมได้ที่เอกสารประกอบเกี่ยวกับ IAM

AuthToken

โทเค็นการตรวจสอบสิทธิ์

ช่อง
token

string

เอาต์พุตเท่านั้น โทเค็นการตรวจสอบสิทธิ์ที่ควรส่งผ่านไปยังแอปพลิเคชันบนอุปกรณ์เคลื่อนที่
expire_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่โทเค็นการตรวจสอบสิทธิ์จะหมดอายุ

CreateTripRequest

ข้อความคำขอสำหรับ NavConnectService.CreateTrip

ช่อง
parent

string

ต้องระบุ ทรัพยากรระดับบนสุดที่จะสร้างการเดินทางนี้ รูปแบบ: projects/{project_number}
trip_id

string

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

ค่านี้ต้องเป็น UUID ของ RFC-4122 ที่ถูกต้อง
trip

Trip

ต้องระบุ การเดินทางที่จะสร้าง

GetTripRequest

ข้อความคำขอสำหรับ NavConnectService.GetTrip

ช่อง
name

string

ต้องระบุ ชื่อทรัพยากรของการเดินทางที่จะรับ รูปแบบ: projects/{project}/trips/{trip_id}
route_polyline_format

RoutePolylineFormat

ไม่บังคับ รูปแบบของเส้นประกอบเส้นทางที่จะแสดงผล หากไม่ได้ตั้งค่าไว้ ระบบจะแสดงผลเส้นประกอบของเส้นทาง SIMPLE

RoutePolylineFormat

ระบุรูปแบบของเส้นประกอบเส้นทาง

Enum
ROUTE_POLYLINE_FORMAT_UNSPECIFIED ไม่ได้ระบุรูปแบบเส้นหลายเส้นของเส้นทาง
SIMPLE ระบบจะแสดงผลเส้นประกอบของเส้นทางเป็นอาร์เรย์ของจุดแบบง่ายที่แสดงเป็น google.type.LatLng
ENCODED ระบบจะแสดงผลเส้นประกอบของเส้นทางเป็นสตริงที่เข้ารหัส ดู https://developers.google.com/maps/documentation/utilities/polylinealgorithm
S2ENCODED ระบบจะเข้ารหัสเส้นประกอบของเส้นทางเป็น S2Polyline ดูที่ https://s2geometry.io/devguide/basic_types.html
GEO_JSON ระบบจะแสดงผลเส้นประกอบของเส้นทางเป็น LineString ของ GeoJSON ดู https://tools.ietf.org/html/rfc7946#section-3.1.4

ตำแหน่ง

ตำแหน่งตามที่แอปพลิเคชันบนอุปกรณ์เคลื่อนที่รายงาน

ช่อง
point

LatLng

เอาต์พุตเท่านั้น ละติจูด/ลองจิจูดของสถานที่
source_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่ได้แหล่งที่มาของสถานที่ตามที่ไคลเอ็นต์ระบุ
server_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่เซิร์ฟเวอร์ได้รับการอัปเดตตำแหน่งนี้

เส้นทาง

เส้นประกอบของเส้นทาง

ช่อง
traffic_information[]

SpeedReadingInterval

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

หมายเหตุ

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

ฟิลด์ Union format รูปแบบเส้นทาง

รูปแบบที่ป้อนจะควบคุมโดยพารามิเตอร์ route_polyline_format หากไม่ได้ตั้งค่า ระบบจะใช้เส้นประกอบแบบง่ายเป็นค่าเริ่มต้น format จะเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
simple_polyline

SimplePolyline

เอาต์พุตเท่านั้น เส้นทางเป็นรายการละติจูดลองจิจูดแบบง่าย
encoded_polyline

string

เอาต์พุตเท่านั้น เส้นทางเป็นเส้นประกอบที่เข้ารหัส ดู https://developers.google.com/maps/documentation/utilities/polylinealgorithm
s2_polyline

bytes

เอาต์พุตเท่านั้น เส้นทางเป็น S2Polyline ที่เข้ารหัส ดูที่ https://s2geometry.io/devguide/basic_types.html
geo_json

Struct

เอาต์พุตเท่านั้น เส้นทางเป็น LineString ของ GeoJSON ดู https://tools.ietf.org/html/rfc7946#section-3.1.4

SimplePolyline

แสดงเส้นประกอบโดยใช้รายการจุดอย่างง่าย

ช่อง
points[]

LatLng

เอาต์พุตเท่านั้น รายการจุดที่เรียงตามลำดับซึ่งแสดงถึงเส้นประกอบ

SpeedReadingInterval

ตัวบ่งชี้ความหนาแน่นของการเข้าชมในส่วนที่ต่อเนื่องของเส้นทาง เมื่อกำหนดเส้นทางที่มีจุด P_0, P_1, ... , P_N (ดัชนีที่อิงตาม 0) แล้ว SpeedReadingInterval จะกำหนดช่วงและอธิบายการจราจรของช่วงนั้นโดยใช้Speedหมวดหมู่

ช่อง
speed

Speed

เอาต์พุตเท่านั้น ความเร็วของการจราจรในช่วงเวลานี้
start_polyline_point_index

int32

เอาต์พุตเท่านั้น ดัชนีเริ่มต้นของช่วงเวลานี้ในเส้นทาง
end_polyline_point_index

int32

เอาต์พุตเท่านั้น ดัชนีสิ้นสุดของช่วงเวลานี้ในเส้นทาง

ความเร็ว

การจัดประเภทความเร็วของเส้นหลายเส้นตามข้อมูลการจราจร

Enum
SPEED_UNSPECIFIED ไม่ได้ระบุความเร็ว
NORMAL ความเร็วปกติ การจราจรไม่ล่าช้า
SLOW ตรวจพบการจราจรชะลอตัว ปริมาณการจราจรเล็กน้อยถึงปานกลาง
TRAFFIC_JAM การจราจรล่าช้า รวมถึงการจราจรหยุดนิ่ง

หยุด

จุดแวะพักในการเดินทางซึ่งต้องดำเนินงานบางอย่าง

ช่อง
point

LatLng

ต้องระบุ ตำแหน่งของป้ายในรูปแบบละติจูด/ลองจิจูด

การเดินทาง

การเดินทาง

ช่อง
name

string

เอาต์พุตเท่านั้น ตัวระบุ ชื่อทรัพยากรของการเดินทาง รูปแบบ: projects/{project_number}/trips/{trip_id}
config

TripConfig

เปลี่ยนแปลงไม่ได้ การกำหนดค่าสำหรับการเดินทาง
android_app_id

string

อินพุตเท่านั้น เปลี่ยนแปลงไม่ได้ รหัสแอปพลิเคชัน Android ของแอปพลิเคชันบนอุปกรณ์เคลื่อนที่จะใช้การเดินทาง ต้องตั้งค่า android_app_id หรือ ios_app_id อย่างน้อย 1 รายการ
ios_app_id

string

อินพุตเท่านั้น เปลี่ยนแปลงไม่ได้ รหัสชุด iOS ของแอปพลิเคชันบนอุปกรณ์เคลื่อนที่จะใช้การเดินทาง ต้องตั้งค่า android_app_id หรือ ios_app_id อย่างน้อย 1 รายการ
auth_token

AuthToken

เอาต์พุตเท่านั้น โทเค็นที่ไม่โปร่งใสซึ่งให้สิทธิ์เข้าถึงเพื่อเริ่มการเดินทาง NavConnect ใน Google Maps หรือ Waze และให้สิทธิ์แอปพลิเคชันเหล่านี้ในการอัปเดตการเดินทาง CreateTrip เท่านั้นที่ส่งคืน
state

State

เอาต์พุตเท่านั้น สถานะการเดินทาง
execution

TripExecution

เอาต์พุตเท่านั้น ข้อมูลล่าสุดเกี่ยวกับการเดินทาง ระบบอาจไม่ได้ตั้งค่านี้หากการเดินทางอยู่ในสถานะข้อผิดพลาด
create_time

Timestamp

เอาต์พุตเท่านั้น เวลาตามเซิร์ฟเวอร์เมื่อสร้างการเดินทาง
update_time

Timestamp

เอาต์พุตเท่านั้น เวลาที่เซิร์ฟเวอร์ได้รับการอัปเดตการเดินทางล่าสุด

รัฐ

สถานะการเดินทางที่เป็นไปได้ทั้งหมด

Enum
STATE_UNSPECIFIED ไม่ได้ระบุสถานะการเดินทาง
NEW ระบบสร้างการเดินทางแล้ว แต่ยังไม่ได้เริ่ม
ENROUTE ผู้ขนส่งกำลังเดินทางไปยังจุดหมาย
ARRIVED ผู้ขนส่งมาถึงจุดหมายแล้ว
SUSPENDED การเดินทางถูกระงับ
FAILED การเดินทางไม่สำเร็จ
CLIENT_ERROR การเดินทางล้มเหลวเนื่องจากข้อผิดพลาดเกี่ยวกับไคลเอ็นต์
CANCELED นักพัฒนาแอปเป็นผู้ยกเลิกการเดินทางโดยตรง

TripConfig

การกำหนดค่าสำหรับการเดินทาง

ช่อง
enable_high_frequency_updates

bool

ไม่บังคับ จะเปิดใช้การอัปเดตการเดินทางความถี่สูงหรือไม่

หมายเหตุ: การเปิดใช้ฟีเจอร์นี้จะบันทึกการเดินทางภายใต้การใช้งานระดับองค์กร และมีอัตราค่าบริการระดับองค์กร
enable_pubsub

bool

ไม่บังคับ จะเปิดใช้การแจ้งเตือน Pub/Sub สำหรับการเดินทางหรือไม่
pubsub_field_mask

FieldMask

ไม่บังคับ หากตั้งค่าไว้ ระบบจะรวมเฉพาะฟิลด์การเดินทางที่ระบุไว้ในชุดย่อยในการแจ้งเตือน Pub/Sub

หากไม่ได้ตั้งค่า ระบบจะรวมช่องการเดินทางทั้งหมดไว้ในการแจ้งเตือน Pub/Sub (ลักษณะการทำงานเริ่มต้น)

ระบบไม่รองรับฟิลด์ต่อไปนี้

  • android_app_id
  • ios_app_id
  • auth_token
  • config

หมายเหตุ: ระบบจะไม่สนใจฟิลด์นี้หาก enable_pubsub เป็นเท็จ
enable_remaining_route_reporting

bool

ไม่บังคับ จะเปิดใช้การรายงานเส้นทางที่เหลือสำหรับการเดินทางหรือไม่

หมายเหตุ: การเปิดใช้ฟีเจอร์นี้จะบันทึกการเดินทางภายใต้การใช้งานระดับองค์กร และมีอัตราค่าบริการระดับองค์กร

TripExecution

ข้อมูลเกี่ยวกับการเดินทาง

ช่อง
origin

Location

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

Stop

เอาต์พุตเท่านั้น จุดหมายของการเดินทางตามที่แอปพลิเคชันบนอุปกรณ์เคลื่อนที่รายงาน
location

Location

เอาต์พุตเท่านั้น สัญญาณตำแหน่งที่แสดงตำแหน่งสุดท้ายที่ทราบของผู้ขนส่ง ซึ่งจะเป็นตำแหน่งที่สแนปถนนหากมี
remaining_route

Route

เอาต์พุตเท่านั้น ระบุเส้นประกอบสำหรับเส้นทางส่วนที่เหลือ
traveled_duration

Duration

เอาต์พุตเท่านั้น เวลาที่ใช้เดินทางจนถึงตอนนี้
remaining_duration

Duration

เอาต์พุตเท่านั้น เวลาที่เหลือในการเดินทางนี้ตามที่ Google ประมาณไว้
traveled_distance_meters

int32

เอาต์พุตเท่านั้น ระยะทางที่เดินทางจากต้นทางเป็นเมตร
remaining_distance_meters

int32

เอาต์พุตเท่านั้น ระยะทางที่เหลือไปยังจุดหมายเป็นเมตร
stop_added_in_route

bool

เอาต์พุตเท่านั้น ระบุว่ามีการเพิ่มจุดแวะพักระหว่างเส้นทางหรือไม่