Package maps.fleetengine.delivery.v1

ดัชนี

DeliveryService

บริการขนส่งสินค้าส่วนสุดท้าย

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

สร้างและส่งคืนกลุ่มออบเจ็กต์ Task ใหม่
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

สร้างและแสดงผล DeliveryVehicle ใหม่
CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

สร้างและแสดงผลออบเจ็กต์ Task ใหม่
GetDeliveryVehicle

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

แสดงผลอินสแตนซ์ DeliveryVehicle ที่ระบุ
GetTask

rpc GetTask(GetTaskRequest) returns (Task)

รับข้อมูลเกี่ยวกับ Task
GetTaskTrackingInfo

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

แสดงผลอินสแตนซ์ TaskTrackingInfo ที่ระบุ
ListDeliveryVehicles

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

รับ DeliveryVehicle ทั้งหมดที่ตรงกับเกณฑ์การกรองที่ระบุ
ListTasks

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

รับ Task ทั้งหมดที่ตรงกับเกณฑ์การกรองที่ระบุ
UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

เขียนข้อมูล DeliveryVehicle ที่อัปเดตไปยัง Fleet Engine และกำหนด Tasks ให้กับ DeliveryVehicle คุณอัปเดตชื่อของ DeliveryVehicle ไม่ได้ คุณสามารถอัปเดต remaining_vehicle_journey_segments แต่ต้องมี VehicleJourneySegment ทั้งหมดจึงจะคงไว้ใน DeliveryVehicle ได้ ระบบดึงข้อมูล task_id จาก remaining_vehicle_journey_segments และ Tasks ที่เกี่ยวข้องจะถูกกำหนดให้กับ DeliveryVehicle หากยังไม่ได้กำหนด
UpdateTask

rpc UpdateTask(UpdateTaskRequest) returns (Task)

อัปเดตข้อมูล Task

BatchCreateTasksRequest

ข้อความคำขอ BatchCreateTask

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน หมายเหตุ: หากตั้งค่าช่องนี้ ช่องส่วนหัวในข้อความ CreateTaskRequest จะต้องว่างเปล่า หรือต้องตรงกับช่องนี้
parent

string

ต้องระบุ ทรัพยากรระดับบนสุดที่งานทั้งหมดแชร์ ค่านี้ต้องอยู่ในรูปแบบ providers/{provider} provider ต้องเป็นรหัสโปรเจ็กต์ Google Cloud เช่น sample-cloud-project ช่องระดับบนสุดในข้อความ CreateTaskRequest ต้องว่างเปล่าหรือต้องตรงกับช่องนี้
requests[]

CreateTaskRequest

ต้องระบุ ข้อความคำขอที่ระบุทรัพยากรที่จะสร้าง หมายเหตุ: คุณสร้างงานในกลุ่มได้สูงสุด 500 งาน

BatchCreateTasksResponse

ข้อความตอบกลับ BatchCreateTask

ช่อง
tasks[]

Task

Tasks ที่สร้าง

CreateDeliveryVehicleRequest

ข้อความคำขอ CreateDeliveryVehicle

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
parent

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider} ผู้ให้บริการต้องเป็นรหัสโปรเจ็กต์ Google Cloud เช่น sample-cloud-project
delivery_vehicle_id

string

ต้องระบุ รหัสยานพาหนะที่นำส่งต้องไม่ซ้ำกันและขึ้นอยู่กับข้อจำกัดต่อไปนี้

  • ต้องเป็นสตริง Unicode ที่ถูกต้อง
  • จำกัดให้มีความยาวไม่เกิน 64 อักขระ
  • ทำให้เป็นมาตรฐานตามแบบฟอร์มการปรับมาตรฐาน Unicode
  • ต้องไม่มีอักขระ ASCII ต่อไปนี้: '/', ':', '?', ',' หรือ '#'
delivery_vehicle

DeliveryVehicle

ต้องระบุ เอนทิตี DeliveryVehicle ที่จะสร้าง เมื่อสร้างยานพาหนะสำหรับนำส่งใหม่ คุณอาจตั้งค่าช่องที่ไม่บังคับต่อไปนี้

  • ประเภท
  • last_location
  • แอตทริบิวต์

หมายเหตุ: ระบบจะไม่พิจารณาช่อง name ของ DeliveryVehicle ไม่ต้องตั้งค่าช่อง DeliveryVehicle อื่นๆ ทั้งหมด ไม่เช่นนั้น ระบบจะแสดงผลข้อผิดพลาด

CreateTaskRequest

ข้อความคำขอ CreateTask

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
parent

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider} provider ต้องเป็นรหัสโปรเจ็กต์ Google Cloud เช่น sample-cloud-project
task_id

string

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

  • ต้องเป็นสตริง Unicode ที่ถูกต้อง
  • จำกัดให้มีความยาวไม่เกิน 64 อักขระ
  • ทำให้เป็นมาตรฐานตามแบบฟอร์มการปรับมาตรฐาน Unicode
  • ต้องไม่มีอักขระ ASCII ต่อไปนี้: '/', ':', '?', ',' หรือ '#'
task

Task

ต้องระบุ เอนทิตีงานที่จะสร้าง เมื่อสร้างงาน คุณต้องระบุข้อมูลในช่องต่อไปนี้

  • type
  • state (ต้องตั้งค่าเป็น OPEN)
  • tracking_id (ไม่ต้องตั้งค่าสำหรับงาน UNAVAILABLE หรือ SCHEDULED_STOP รายการ แต่ต้องตั้งค่าสำหรับงานประเภทอื่นๆ ทั้งหมด)
  • planned_location (ไม่บังคับสำหรับ UNAVAILABLE งาน)
  • task_duration

หมายเหตุ: ระบบจะไม่พิจารณาช่อง name ของงาน ต้องไม่ตั้งค่าช่องงานอื่นๆ ทั้งหมด ไม่เช่นนั้น ระบบจะแสดงผลข้อผิดพลาด

DeliveryRequestHeader

RequestHeader มีช่องที่ใช้กับคำขอ Delivery RPC ทั้งหมด

ช่อง
language_code

string

รหัสภาษา BCP-47 เช่น en-US หรือ sr-Latn ดูข้อมูลเพิ่มเติมได้ที่ http://www.unicode.org/reports/tr35/#Unicode_locale_identifier ถ้าไม่ได้ระบุคำตอบไว้ คำตอบอาจเป็นภาษาใดก็ได้ โดยตั้งค่าเป็นภาษาอังกฤษ (ถ้ามี) ตัวอย่างค่าในช่อง: en-US
region_code

string

ต้องระบุ รหัสภูมิภาค CLDR ของภูมิภาคที่ส่งคำขอ ตัวอย่างค่าในช่อง: US
sdk_version

string

เวอร์ชันของ SDK ที่เรียกใช้ (หากมี) รูปแบบเวอร์ชันคือ "major.minor.patch" เช่น 1.1.2
os_version

string

เวอร์ชันของระบบปฏิบัติการที่ SDK การเรียกใช้ทำงานอยู่ ตัวอย่างค่าในช่อง: 4.4.1, 12.1
device_model

string

รุ่นของอุปกรณ์ที่ SDK การเรียกใช้ทำงานอยู่ ตัวอย่างค่าในช่อง: iPhone12,1, SM-G920F
sdk_type

SdkType

ประเภทของ SDK ที่ส่งคำขอ
maps_sdk_version

string

เวอร์ชันของ MapSDK ที่ SDK การเรียกใช้ใช้อยู่ (หากมี) รูปแบบเวอร์ชันคือ "major.minor.patch" เช่น 5.2.1
nav_sdk_version

string

เวอร์ชันของ NavSDK ที่ SDK การเรียกใช้ใช้อยู่ (หากมี) รูปแบบเวอร์ชันคือ "major.minor.patch" เช่น 2.1.0
platform

Platform

แพลตฟอร์มของ SDK การเรียกใช้
manufacturer

string

ผู้ผลิตอุปกรณ์ Android จาก SDK การเรียกใช้ ใช้ได้กับ Android SDK เท่านั้น ตัวอย่างค่าในช่อง: Samsung
android_api_level

int32

ระดับ API ของ Android ของ SDK การเรียกใช้ ใช้ได้กับ Android SDK เท่านั้น ตัวอย่างค่าในช่อง: 23
trace_id

string

รหัสที่ไม่บังคับซึ่งมีไว้สำหรับการบันทึกเพื่อระบุคำขอ

แพลตฟอร์ม

แพลตฟอร์มของ SDK การเรียกใช้

Enum
PLATFORM_UNSPECIFIED ค่าเริ่มต้น ระบบจะใช้ค่านี้หากละเว้นแพลตฟอร์ม
ANDROID คำขอนี้มาจาก Android
IOS คำขอนี้มาจาก iOS
WEB คำขอมาจากเว็บ

SdkType

ประเภท SDK ที่เป็นไปได้

Enum
SDK_TYPE_UNSPECIFIED ค่าเริ่มต้น ระบบจะใช้ค่านี้หากละเว้น sdk_type
CONSUMER SDK การเรียกใช้คือเวอร์ชัน "ผู้บริโภค"
DRIVER SDK ในการเรียกใช้คือ Driver
JAVASCRIPT SDK ในการเรียกใช้คือ JavaScript

DeliveryVehicle

ข้อความ DeliveryVehicle รถนำส่งจะขนส่งพัสดุจากคลังสินค้าไปยังสถานที่นำส่งและจากจุดรับไปยังคลังสินค้า ในบางกรณี รถนำส่งจะขนส่งการจัดส่งจากสถานที่รับสินค้าไปยังสถานที่นำส่งโดยตรงด้วย

หมายเหตุ: gRPC และ REST API จะใช้รูปแบบการตั้งชื่อฟิลด์ที่แตกต่างกัน เช่น ช่อง DeliveryVehicle.current_route_segment ใน gRPC API และช่อง DeliveryVehicle.currentRouteSegment ใน REST API อ้างอิงถึงช่องเดียวกัน

ช่อง
name

string

ชื่อที่ไม่ซ้ำกันของยานพาหนะนำส่งนี้ รูปแบบคือ providers/{provider}/deliveryVehicles/{vehicle}
last_location

DeliveryVehicleLocation

ตำแหน่งที่รายงานล่าสุดของยานพาหนะที่นำส่ง
navigation_status

DeliveryVehicleNavigationStatus

สถานะการนำทางของรถนำส่ง
current_route_segment

bytes

เส้นประกอบที่เข้ารหัสซึ่งระบุเส้นทางที่การนำทางแนะนำให้ไปยังจุดอ้างอิงถัดไป แอปไดรเวอร์จะอัปเดตข้อมูลนี้เมื่อถึงจุดแวะหรือผ่าน และเมื่อการนำทางเปลี่ยนเส้นทาง LatLngเหล่านี้จะแสดงผลใน Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) หรือ Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) สำหรับงานที่ใช้งานอยู่ทั้งหมดที่มอบหมายให้กับยานพาหนะ

มีบางกรณีที่ระบบอาจไม่ได้ใช้ช่องนี้เพื่อป้อนข้อมูลของ Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) หรือ Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) ดังนี้

  • ปลายทางของ current_route_segment ไม่ตรงกับ DeliveryVehicle.remaining_vehicle_journey_segments[0].stop (gRPC) หรือ DeliveryVehicle.remainingVehicleJourneySegments[0].stop (REST)

  • แอปไดรเวอร์ไม่ได้อัปเดตตำแหน่งเมื่อเร็วๆ นี้ ดังนั้นค่าที่อัปเดตล่าสุดสำหรับช่องนี้อาจไม่ใช่ข้อมูลล่าสุด

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

ในกรณีเหล่านี้ Fleet Engine จะป้อนข้อมูลในช่องนี้ด้วยเส้นทางจากยานพาหนะที่ผ่านล่าสุดไปยัง TrafficStop ที่กำลังจะมีขึ้น เพื่อให้มั่นใจว่าผู้บริโภคของฟิลด์นี้ได้รับข้อมูลที่ดีที่สุดเกี่ยวกับเส้นทางปัจจุบันของยานพาหนะที่ใช้นำส่ง
current_route_segment_end_point

LatLng

ตำแหน่งที่ current_route_segment สิ้นสุด ปัจจุบันข้อมูลนี้ไม่มีข้อมูลในแอปไดรเวอร์ แต่คุณสามารถระบุในการเรียกใช้ UpdateDeliveryVehicle ได้ โดยจะเป็น LatLng จากป้ายจอดรถที่กำลังจะจอด หรือ LatLng สุดท้ายของ current_route_segment ก็ได้ จากนั้น Fleet Engine จะพยายามหาค่าของ VehicleStop จริงให้ครอบคลุมที่สุด

ระบบจะไม่สนใจช่องนี้ในการเรียกใช้ UpdateDeliveryVehicle หากช่อง current_route_segment ว่างเปล่า
remaining_distance_meters

Int32Value

ระยะทางขับรถที่เหลือสำหรับ current_route_segment โดยทั่วไปแอปไดรเวอร์จะระบุช่องนี้ แต่มีบางกรณีที่ Fleet Engine จะลบล้างค่าที่ส่งโดยแอป ดูข้อมูลเพิ่มเติมได้ที่ DeliveryVehicle.current_route_segment ช่องนี้จะแสดงผลใน Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) หรือ Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) สำหรับ Task ทั้งหมดที่ใช้งานอยู่ซึ่งกำหนดให้กับยานพาหนะสำหรับนำส่ง

Fleet Engine จะละเว้นช่องนี้ใน UpdateDeliveryVehicleRequest หากช่อง current_route_segment ว่างเปล่า
remaining_duration

Duration

ระยะเวลาขับรถที่เหลืออยู่สำหรับ current_route_segment โดยทั่วไปแอปไดรเวอร์จะระบุช่องนี้ แต่มีบางกรณีที่ Fleet Engine จะลบล้างค่าที่ส่งโดยแอป ดูข้อมูลเพิ่มเติมได้ที่ DeliveryVehicle.current_route_segment ช่องนี้จะแสดงผลใน Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) หรือ Task.remainingVehicleJourneySegments[0].drivingDuration (REST) สำหรับงานที่ใช้งานอยู่ทั้งหมดที่มอบหมายให้กับยานพาหนะนำส่ง

Fleet Engine จะละเว้นช่องนี้ใน UpdateDeliveryVehicleRequest หากช่อง current_route_segment ว่างเปล่า
remaining_vehicle_journey_segments[]

VehicleJourneySegment

กลุ่มการเดินทางที่กำหนดให้กับยานพาหนะสำหรับจัดส่งนี้ โดยเริ่มจากตำแหน่งที่รายงานล่าสุดของยานพาหนะ จะไม่มีการกรอกข้อมูลในช่องนี้ในการตอบกลับของ ListDeliveryVehicles
attributes[]

DeliveryVehicleAttribute

รายการแอตทริบิวต์ยานพาหนะสำหรับนำส่งแบบกำหนดเอง ยานพาหนะที่นำส่งสินค้ามีแอตทริบิวต์ได้สูงสุด 100 รายการ และแต่ละแอตทริบิวต์ต้องมีคีย์ที่ไม่ซ้ำกัน
type

DeliveryVehicleType

ประเภทของยานพาหนะสำหรับนำส่งนี้ หากไม่ได้ตั้งค่า ระบบจะใช้ค่าเริ่มต้นเป็น AUTO

DeliveryVehicleType

ประเภทของยานพาหนะที่นำส่งสินค้า

Enum
DELIVERY_VEHICLE_TYPE_UNSPECIFIED ค่านี้ไม่ได้นำไปใช้งาน
AUTO รถยนต์
TWO_WHEELER จักรยานยนต์ โมเพ็ด หรือยานพาหนะ 2 ล้ออื่นๆ
BICYCLE การขนย้ายที่ขับเคลื่อนด้วยแรงมนุษย์
PEDESTRIAN ผู้ขนส่งที่เป็นมนุษย์ซึ่งโดยทั่วไปจะเดินหรือวิ่ง สัญจรไปตามทางเท้า

DeliveryVehicleAttribute

อธิบายแอตทริบิวต์ยานพาหนะเป็นคู่คีย์-ค่า "คีย์:ค่า" สตริงต้องมีความยาวไม่เกิน 256 อักขระ

ช่อง
key

string

คีย์ของแอตทริบิวต์
value

string

ค่าแอตทริบิวต์
ช่องการรวม delivery_vehicle_attribute_value ค่าของแอตทริบิวต์อาจเป็นสตริง บูลีน หรือประเภท Double delivery_vehicle_attribute_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
string_value

string

ค่าแอตทริบิวต์ที่พิมพ์โดยสตริง

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

bool

ค่าแอตทริบิวต์ที่พิมพ์ด้วยบูลีน
number_value

double

ค่าแอตทริบิวต์ที่พิมพ์คู่

DeliveryVehicleLocation

ตำแหน่ง ความเร็ว และการมุ่งหน้าของรถในช่วงเวลาใดเวลาหนึ่ง

ช่อง
location

LatLng

ตำแหน่งของยานพาหนะ เมื่อระบบส่งไปยัง Fleet Engine ตำแหน่งของรถจะเป็นตำแหน่ง GPS เมื่อได้รับคำตอบ ตำแหน่งของรถอาจเป็นตำแหน่ง GPS, ตำแหน่งเสริม หรือตำแหน่งอื่นๆ โดยประมาณก็ได้ แหล่งที่มามีการระบุไว้ใน location_sensor
horizontal_accuracy
(deprecated)

DoubleValue

เลิกใช้งานแล้ว: ใช้ latlng_accuracy แทน
latlng_accuracy

DoubleValue

ความแม่นยำ location เป็นเมตรเป็นรัศมี
heading

Int32Value

ทิศทางที่ยานพาหนะเคลื่อนที่ หน่วยเป็นองศา 0 หมายถึงทิศเหนือ ช่วงที่ถูกต้องคือ [0,360)
bearing_accuracy
(deprecated)

DoubleValue

เลิกใช้งานแล้ว: ใช้ heading_accuracy แทน
heading_accuracy

DoubleValue

ความแม่นยำของ heading เป็นองศา
altitude

DoubleValue

ระดับความสูงมีหน่วยเป็นเมตรสูงกว่า WGS84
vertical_accuracy
(deprecated)

DoubleValue

เลิกใช้งานแล้ว: ใช้ altitude_accuracy แทน
altitude_accuracy

DoubleValue

ความแม่นยำ altitude เป็นเมตร
speed_kmph
(deprecated)

Int32Value

ความเร็วของยานพาหนะเป็นกิโลเมตรต่อชั่วโมง เลิกใช้งานแล้ว: ใช้ speed แทน
speed

DoubleValue

ความเร็วของยานพาหนะในหน่วยเมตร/วินาที
speed_accuracy

DoubleValue

ความแม่นยำ speed ในเมตร/วินาที
update_time

Timestamp

เวลาที่เซ็นเซอร์รายงาน location ตามนาฬิกาของเซ็นเซอร์
server_time

Timestamp

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

DeliveryVehicleLocationSensor

ผู้ให้บริการข้อมูลตำแหน่ง (เช่น GPS)
is_road_snapped

BoolValue

จัด location เข้ากับถนนหรือไม่
is_gps_sensor_enabled

BoolValue

อินพุตเท่านั้น ระบุว่าเซ็นเซอร์ GPS เปิดใช้บนอุปกรณ์เคลื่อนที่หรือไม่
time_since_update

Int32Value

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

Int32Value

อินพุตเท่านั้น เลิกใช้งานแล้ว: ขณะนี้ระบบใช้สัญญาณอื่นๆ เพื่อระบุว่าสถานที่ตั้งเก่าเกินไปหรือไม่
raw_location

LatLng

ตำแหน่งของรถดิบ (ไม่ได้ประมวลผลโดยปลากะพงบนท้องถนน)
raw_location_time

Timestamp

การประทับเวลาที่เชื่อมโยงกับตำแหน่งดิบ
raw_location_sensor

DeliveryVehicleLocationSensor

แหล่งที่มาของตำแหน่งดิบ ค่าเริ่มต้นคือ GPS
raw_location_accuracy

DoubleValue

ความแม่นยำของ raw_location เป็นรัศมี หน่วยเป็นเมตร
supplemental_location

LatLng

ตำแหน่งเสริมซึ่งระบุโดยแอปการผสานรวม
supplemental_location_time

Timestamp

การประทับเวลาที่เชื่อมโยงกับตำแหน่งเสริม
supplemental_location_sensor

DeliveryVehicleLocationSensor

แหล่งที่มาของสถานที่เสริม ค่าเริ่มต้นคือ CUSTOMER_SUPPLIED_LOCATION
supplemental_location_accuracy

DoubleValue

ความแม่นยำของ supplemental_location เป็นรัศมี หน่วยเป็นเมตร
road_snapped
(deprecated)

bool

เลิกใช้งานแล้ว: ใช้ is_road_snapped แทน

DeliveryVehicleLocationSensor

เซ็นเซอร์หรือวิธีการที่ใช้ระบุตำแหน่ง

Enum
UNKNOWN_SENSOR ไม่ได้ระบุหรือไม่รู้จักเซ็นเซอร์
GPS GPS หรือ GPS ที่ได้รับการสนับสนุน
NETWORK GPS ที่ได้รับการสนับสนุน รหัสเสาสัญญาณมือถือ หรือจุดเข้าใช้งาน Wi-Fi
PASSIVE รหัสเสาสัญญาณมือถือหรือจุดเข้าใช้งาน Wi-Fi
ROAD_SNAPPED_LOCATION_PROVIDER ตำแหน่งที่ระบุโดยอุปกรณ์เคลื่อนที่ให้เป็นตำแหน่งที่น่าจะเป็นถนนมากที่สุด
CUSTOMER_SUPPLIED_LOCATION สถานที่ตั้งที่ลูกค้าเป็นผู้ระบุจากแหล่งที่มาอิสระ โดยปกติแล้ว ค่านี้จะใช้สำหรับตำแหน่งที่ให้ไว้จากแหล่งที่มาอื่นๆ ที่ไม่ใช่อุปกรณ์เคลื่อนที่ที่ใช้ Driver SDK หากมีการอธิบายแหล่งที่มาเดิมด้วยค่า enum อื่นๆ ให้ใช้ค่านั้น โดยปกติ สถานที่ที่ระบุ CUSTOMER_SUPPLIED_LOCATION จะได้รับผ่าน last_location.supplemental_location_sensor ของ DeliveryVehicle
FLEET_ENGINE_LOCATION ตำแหน่งที่คำนวณโดย Fleet Engine โดยพิจารณาจากสัญญาณที่มี เอาต์พุตเท่านั้น ระบบจะปฏิเสธค่านี้หากได้รับในคำขอ
FUSED_LOCATION_PROVIDER Fused Location Provider ของ Android
CORE_LOCATION ผู้ให้บริการตำแหน่งในระบบปฏิบัติการ Apple

DeliveryVehicleNavigationStatus

สถานะการนำทางของรถ

Enum
UNKNOWN_NAVIGATION_STATUS สถานะการนำทางที่ไม่ระบุ
NO_GUIDANCE การไปยังส่วนต่างๆ ของแอปคนขับอยู่ในโหมด FREE_NAV
ENROUTE_TO_DESTINATION การนำทางแบบเลี้ยวต่อเลี้ยวพร้อมใช้งาน และการนำทางในแอปคนขับเข้าสู่โหมด GUIDED_NAV
OFF_ROUTE รถได้ออกนอกเส้นทางที่แนะนำ
ARRIVED_AT_DESTINATION รถจะอยู่ห่างจากจุดหมายภายในระยะประมาณ 50 เมตร

GetDeliveryVehicleRequest

ข้อความคำขอ GetDeliveryVehicle

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
name

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider}/deliveryVehicles/{delivery_vehicle} provider ต้องเป็นรหัสโปรเจ็กต์ Google Cloud เช่น sample-cloud-project

GetTaskRequest

ข้อความคำขอ GetTask

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
name

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider}/tasks/{task} provider ต้องเป็นรหัสโปรเจ็กต์ Google Cloud เช่น sample-cloud-project

GetTaskTrackingInfoRequest

ข้อความคำขอ GetTaskTrackingInfoRequest

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
name

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider}/taskTrackingInfo/{tracking_id} provider ต้องเป็นรหัสโปรเจ็กต์ Google Cloud และ tracking_id ต้องเป็นรหัสติดตามที่เชื่อมโยงกับงาน ชื่อตัวอย่างอาจเป็น providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id ได้

ListDeliveryVehiclesRequest

ข้อความคำขอ ListDeliveryVehicles

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
parent

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider} provider ต้องเป็นรหัสโปรเจ็กต์ Google Cloud เช่น sample-cloud-project
page_size

int32

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

string

ไม่บังคับ โทเค็นของหน้าเว็บที่ได้รับจากการโทร ListDeliveryVehicles ก่อนหน้า คุณต้องระบุข้อมูลนี้เพื่อเรียกหน้าถัดไป

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ ListDeliveryVehicles ต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ
filter

string

ไม่บังคับ คำค้นหาตัวกรองที่จะใช้เมื่อแสดงข้อมูลยานพาหนะที่นำส่ง ดูตัวอย่างไวยากรณ์ตัวกรองได้ที่ http://aip.dev/160 หากคุณไม่ระบุค่าหรือระบุสตริงว่างสำหรับตัวกรอง ระบบจะแสดงผลยานพาหนะสำหรับนำส่งทั้งหมด

โปรดทราบว่าคำค้นหาที่รองรับสำหรับ ListDeliveryVehicles จะอยู่ในแอตทริบิวต์ยานพาหนะ (เช่น attributes.<key> = <value> หรือ attributes.<key1> = <value1> AND attributes.<key2> = <value2>) เท่านั้น นอกจากนี้ แอตทริบิวต์ทั้งหมดจะจัดเก็บเป็นสตริง ดังนั้นการเปรียบเทียบแอตทริบิวต์ที่สนับสนุนเพียงอย่างเดียวคือการเปรียบเทียบสตริง ในการเปรียบเทียบกับค่าตัวเลขหรือบูลีน คุณต้องใส่ค่าดังกล่าวอย่างชัดแจ้งว่าเป็นสตริง (เช่น attributes.<key> = "10" หรือ attributes.<key> = "true")

จำนวนข้อจำกัดสูงสุดที่อนุญาตในการค้นหาของตัวกรองคือ 50 ข้อจำกัดเป็นส่วนหนึ่งของการค้นหาในรูปแบบ attribute.<KEY> <COMPARATOR> <VALUE> ตัวอย่างเช่น attributes.foo = bar คือข้อจำกัด 1 รายการ
viewport

Viewport

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

ListDeliveryVehiclesResponse

ข้อความตอบกลับ ListDeliveryVehicles

ช่อง
delivery_vehicles[]

DeliveryVehicle

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

string

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

int64

จำนวนยานพาหนะสำหรับนำส่งทั้งหมดที่ตรงกับเกณฑ์คำขอในทุกหน้า

ListTasksRequest

ข้อความคำขอ ListTasks

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
parent

string

ต้องระบุ ต้องอยู่ในรูปแบบ providers/{provider} provider ต้องเป็นรหัสโปรเจ็กต์ Google Cloud เช่น sample-cloud-project
page_size

int32

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

string

ไม่บังคับ โทเค็นหน้าเว็บที่ได้รับจากการโทร ListTasks ครั้งก่อน คุณสามารถระบุข้อมูลนี้เพื่อเรียกดูหน้าถัดไปได้

เมื่อใส่เลขหน้า พารามิเตอร์อื่นๆ ทั้งหมดที่ให้กับ ListTasks ต้องตรงกับการเรียกใช้ที่ระบุโทเค็นของหน้าเว็บ
filter

string

ไม่บังคับ คําค้นหาตัวกรองที่จะนำไปใช้เมื่อแสดงรายการ Tasks ดูตัวอย่างไวยากรณ์ตัวกรองได้ที่ http://aip.dev/160 หากคุณไม่ระบุค่าหรือกรองสตริงว่าง ระบบจะแสดงผล Tasks ทั้งหมด สำหรับข้อมูลเกี่ยวกับพร็อพเพอร์ตี้ของงานที่คุณกรองได้ โปรดดูแสดงรายการงาน

ListTasksResponse

การตอบกลับ ListTasks ที่มีชุดงานที่ตรงกับเกณฑ์ตัวกรองใน ListTasksRequest

ช่อง
tasks[]

Task

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

string

ส่งโทเค็นนี้ใน ListTasksRequest เพื่อแสดงรายการผลลัพธ์ต่อไป หากมีการแสดงผลลัพธ์ทั้งหมด แสดงว่าฟิลด์นี้จะเป็นสตริงว่างเปล่า หรือไม่ปรากฎในคำตอบ
total_size

int64

จำนวนงานทั้งหมดที่ตรงกับเกณฑ์คำขอในทุกหน้า

LocationInfo

สถานที่ตั้งที่มีตัวระบุเพิ่มเติม

ช่อง
point

LatLng

พิกัดของตำแหน่ง

งาน

งานใน API การนำส่งแสดงถึงการดำเนินการเดียวที่จะติดตาม โดยทั่วไปแล้ว งานที่เกี่ยวข้องกับการจัดส่งและการหยุดงานจะมีความแตกต่าง การจัดส่งหนึ่งๆ สามารถเชื่อมโยงกับ Tasks ได้หลายรายการ เช่น อาจมีงาน 1 รายการสำหรับการรับสินค้า และอีก 1 งานสำหรับการรับส่งหรือโอน นอกจากนี้ ยานพาหนะที่แตกต่างกันจะจัดการงานที่แตกต่างกันสำหรับการจัดส่งหนึ่งๆ ได้ ตัวอย่างเช่น รถคันหนึ่งให้บริการรับสินค้าได้ โดยนำการจัดส่งไปยังฮับ ส่วนยานพาหนะอีกคันขับเคลื่อนการจัดส่งเดียวกันจากฮับไปยังสถานที่นำส่ง

หมายเหตุ: gRPC และ REST API จะใช้รูปแบบการตั้งชื่อฟิลด์ที่แตกต่างกัน เช่น ช่อง Task.journey_sharing_info ใน gRPC API และช่อง Task.journeySharingInfo ใน REST API อ้างอิงถึงช่องเดียวกัน

ช่อง
name

string

ต้องอยู่ในรูปแบบ providers/{provider}/tasks/{task}
type

Type

ต้องระบุ เปลี่ยนแปลงไม่ได้ กำหนดประเภทของงาน เช่น การพักเบรกหรือการจัดส่ง
state

State

ต้องระบุ สถานะการดำเนินการปัจจุบันของงาน
task_outcome

TaskOutcome

ผลลัพธ์ของงาน
task_outcome_time

Timestamp

การประทับเวลาที่ระบุว่าผู้ให้บริการตั้งค่าผลลัพธ์ของ Task เมื่อใด
task_outcome_location

LocationInfo

ตำแหน่งที่มีการกำหนดผลลัพธ์ของ Task ค่านี้ได้รับการอัปเดตโดยเป็นส่วนหนึ่งของ UpdateTask หากผู้ให้บริการไม่อัปเดตค่านี้อย่างชัดเจน Fleet Engine จะป้อนข้อมูลตำแหน่งยานพาหนะที่ทราบล่าสุด (ตำแหน่งไฟล์ข้อมูล RAW) ให้โดยค่าเริ่มต้น
task_outcome_location_source

TaskOutcomeLocationSource

ระบุว่าค่าของ task_outcome_location มาจากไหน
tracking_id

string

เปลี่ยนแปลงไม่ได้ ช่องนี้จะอำนวยความสะดวกในการจัดเก็บรหัสเพื่อให้คุณหลีกเลี่ยงการใช้การแมปที่ซับซ้อนได้ คุณไม่สามารถตั้งค่า tracking_id สำหรับงานประเภท UNAVAILABLE และ SCHEDULED_STOP รหัสเหล่านี้อยู่ภายใต้ข้อจำกัดต่อไปนี้

  • ต้องเป็นสตริง Unicode ที่ถูกต้อง
  • จำกัดให้มีความยาวไม่เกิน 64 อักขระ
  • ทำให้เป็นมาตรฐานตามแบบฟอร์มการปรับมาตรฐาน Unicode
  • ต้องไม่มีอักขระ ASCII ต่อไปนี้: '/', ':', '?', ',' หรือ '#'
delivery_vehicle_id

string

เอาต์พุตเท่านั้น รหัสของพาหนะที่กำลังปฏิบัติการอยู่ รหัสยานพาหนะที่นำส่งจะอยู่ภายใต้ข้อจำกัดต่อไปนี้

  • ต้องเป็นสตริง Unicode ที่ถูกต้อง
  • จำกัดให้มีความยาวไม่เกิน 64 อักขระ
  • ทำให้เป็นมาตรฐานตามแบบฟอร์มการปรับมาตรฐาน Unicode
  • ต้องไม่มีอักขระ ASCII ต่อไปนี้: '/', ':', '?', ',' หรือ '#'
planned_location

LocationInfo

เปลี่ยนแปลงไม่ได้ ตำแหน่งที่จะดำเนินงานเสร็จสมบูรณ์ ไม่บังคับสำหรับ UNAVAILABLE งาน แต่จำเป็นสำหรับงานอื่นๆ ทั้งหมด
task_duration

Duration

ต้องระบุ เปลี่ยนแปลงไม่ได้ เวลาที่ต้องใช้ในการเรียกใช้งานในตำแหน่งนี้
target_time_window

TimeWindow

กรอบเวลาที่งานควรเสร็จสิ้น
journey_sharing_info

JourneySharingInfo

เอาต์พุตเท่านั้น ช่องเฉพาะของการแชร์เส้นทาง จะไม่มีการป้อนข้อมูลเมื่อรัฐคือ CLOSED
task_tracking_view_config

TaskTrackingViewConfig

การกำหนดค่าสำหรับการติดตามงานที่ระบุว่าองค์ประกอบข้อมูลใดแสดงต่อผู้ใช้ปลายทางภายใต้สถานการณ์ใด
attributes[]

TaskAttribute

รายการแอตทริบิวต์งานที่กำหนดเอง แอตทริบิวต์แต่ละรายการต้องมีคีย์ที่ไม่ซ้ำกัน

JourneySharingInfo

ช่องที่เจาะจงเกี่ยวกับเส้นทางการแชร์

ช่อง
remaining_vehicle_journey_segments[]

VehicleJourneySegment

ข้อมูลการติดตามจุดแวะที่รถที่ได้รับมอบหมายจะสร้างขึ้นก่อนที่จะทำงานนี้เสร็จ โปรดทราบว่ารายการนี้อาจมีจุดแวะจากงานอื่นๆ

ส่วนแรก Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) หรือ Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST) มีข้อมูลเส้นทางจากตำแหน่งสุดท้ายที่ทราบของผู้ขับไปยัง VehicleStop ที่กำลังจะมาถึง ข้อมูลเส้นทางปัจจุบันมักมาจากแอปคนขับ ยกเว้นในบางกรณีที่ระบุไว้ในเอกสารประกอบของ DeliveryVehicle.current_route_segment กลุ่มอื่นๆ ใน Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) หรือ Task.journeySharingInfo.remainingVehicleJourneySegments (REST) สร้างขึ้นโดย Fleet Engine เส้นทางเหล่านี้ให้ข้อมูลเส้นทางระหว่าง VehicleStops ที่เหลือ
last_location

DeliveryVehicleLocation

ระบุตำแหน่งที่รายงานล่าสุดของรถคันที่ได้รับมอบหมาย
last_location_snappable

bool

ระบุว่า lastLocation ของรถสามารถสแนปกับ current_route_segment ได้หรือไม่ ค่านี้จะเป็น "เท็จ" หากไม่มี last_location หรือ current_route_segment ค่านี้จะคำนวณโดย Fleet Engine ระบบจะไม่สนใจการอัปเดตจากลูกค้า

รัฐ

สถานะของงาน ข้อมูลนี้แสดงความคืบหน้าของงาน

Enum
STATE_UNSPECIFIED ค่าเริ่มต้น ใช้สำหรับสถานะงานที่ไม่ระบุหรือไม่รู้จัก
OPEN อาจยังไม่มีการมอบหมายงานให้กับยานพาหนะนำส่ง หรือยานพาหนะสำหรับนำส่งยังไม่ผ่านจุดพักรถของ Task
CLOSED เมื่อรถผ่านจุดจอดสำหรับงานนี้

TaskOutcome

ผลลัพธ์ของการพยายามเรียกใช้งาน เมื่อปิด TaskState แล้ว TaskOutcome จะระบุว่าเสร็จสมบูรณ์หรือไม่

Enum
TASK_OUTCOME_UNSPECIFIED ผลลัพธ์ของงานก่อนที่จะตั้งค่า
SUCCEEDED งานเสร็จเรียบร้อยแล้ว
FAILED เพราะอาจทำงานไม่สำเร็จหรืองานถูกยกเลิก

TaskOutcomeLocationSource

ข้อมูลระบุตัวตนของแหล่งที่มาที่ป้อน task_outcome_location

Enum
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED ผลลัพธ์ของงานก่อนที่จะตั้งค่า
PROVIDER ผู้ให้บริการระบุ task_outcome_location
LAST_VEHICLE_LOCATION ผู้ให้บริการไม่ได้ระบุ task_outcome_location ดังนั้น Fleet Engine ใช้ตำแหน่งยานพาหนะที่ทราบล่าสุด

ประเภท

ประเภทของงาน

Enum
TYPE_UNSPECIFIED โดยค่าเริ่มต้น ระบบจะไม่รู้จักประเภทงาน
PICKUP งานรับสินค้าคือการดำเนินการสำหรับการรับสินค้าจากลูกค้า การมารับรถของ Depot หรือรถให้อาหารควรใช้ประเภท SCHEDULED_STOP
DELIVERY งานการนำส่งคือการดำเนินการสำหรับการนำส่งพัสดุไปยังลูกค้าปลายทาง การส่งคืนยานพาหนะของ Depot หรือฟีดเดอร์ควรใช้ประเภท SCHEDULED_STOP
SCHEDULED_STOP งานการหยุดที่กำหนดเวลาไว้จะใช้เพื่อการวางแผน เช่น อาจแสดงถึงการไปรับหรือนำไปส่งจากพาหนะหรือคลังเก็บอาหาร และไม่ควรใช้กับการจัดส่งที่ไปรับหรือมาส่งจากลูกค้าปลายทาง
UNAVAILABLE งานที่ระบุว่ารถไม่พร้อมให้บริการ เช่น กรณีนี้อาจเกิดขึ้นเมื่อคนขับหยุดพัก หรือเมื่อรถเติมน้ำมัน

TaskAttribute

อธิบายแอตทริบิวต์งานเป็นคู่คีย์-ค่า "คีย์:ค่า" สตริงต้องมีความยาวไม่เกิน 256 อักขระ

ช่อง
key

string

คีย์ของแอตทริบิวต์ คีย์ต้องไม่มีอักขระโคลอน (:)
ช่องการรวม task_attribute_value ค่าของแอตทริบิวต์อาจเป็นสตริง บูลีน หรือประเภท Double หากไม่ได้ตั้งค่าไว้ ระบบจะจัดเก็บ TaskAttribute string_value เป็นสตริงว่าง "" task_attribute_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
string_value

string

ค่าแอตทริบิวต์ที่พิมพ์โดยสตริง
bool_value

bool

ค่าแอตทริบิวต์ที่พิมพ์ด้วยบูลีน
number_value

double

ค่าแอตทริบิวต์ที่พิมพ์คู่

TaskTrackingInfo

ข้อความ TaskTrackingInfo ข้อความนี้มีข้อมูลการติดตามงานซึ่งจะนำมาใช้เพื่อแสดง หากรหัสติดตามเชื่อมโยงกับงานหลายงาน Fleet Engine จะใช้การเรียนรู้ในการตัดสินใจว่าจะเลือก TaskTrackingInfo ของงานใด

ช่อง
name

string

ต้องอยู่ในรูปแบบ providers/{provider}/taskTrackingInfo/{tracking} โดยที่ tracking คือรหัสติดตาม
tracking_id

string

เปลี่ยนแปลงไม่ได้ รหัสติดตามของงาน * ต้องเป็นสตริง Unicode ที่ถูกต้อง * จำกัดความยาวสูงสุด 64 อักขระ * ทำให้เป็นมาตรฐานตามรูปแบบ Unicode รูปแบบ C * ต้องไม่มีอักขระ ASCII ต่อไปนี้: '/', ':', '?', ',' หรือ '#'
vehicle_location

DeliveryVehicleLocation

ตำแหน่งสุดท้ายของรถ
route_polyline_points[]

LatLng

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

Int32Value

ระบุจำนวนการแวะพักของยานพาหนะที่เหลืออยู่จนกว่าจะถึงจุดหยุดงาน ซึ่งรวมถึงการหยุดงาน เช่น หากจุดแวะถัดไปของยานพาหนะคือการหยุดงาน ค่าจะเป็น 1
remaining_driving_distance_meters

Int32Value

ระยะทางรวมที่เหลืออยู่ในหน่วยเมตรเพื่อไปยัง VehicleStop ที่สนใจ
estimated_arrival_time

Timestamp

การประทับเวลาที่ระบุเวลาถึงโดยประมาณไปยังตำแหน่งป้าย
estimated_task_completion_time

Timestamp

การประทับเวลาที่ระบุเวลาเสร็จสิ้นโดยประมาณของงาน
state

State

สถานะการดำเนินการปัจจุบันของงาน
task_outcome

TaskOutcome

ผลลัพธ์ของการพยายามเรียกใช้งาน
task_outcome_time

Timestamp

การประทับเวลาที่ระบุว่าผู้ให้บริการตั้งค่าผลลัพธ์ของงานเมื่อใด
planned_location

LocationInfo

เปลี่ยนแปลงไม่ได้ ตำแหน่งที่จะดำเนินงานเสร็จสมบูรณ์
target_time_window

TimeWindow

กรอบเวลาที่งานควรเสร็จสิ้น
attributes[]

TaskAttribute

แอตทริบิวต์ที่กำหนดเองที่ตั้งค่าในงาน

TaskTrackingViewConfig

ข้อความการกําหนดค่าที่กําหนดว่าผู้ใช้ปลายทางควรเห็นองค์ประกอบข้อมูลของงานเมื่อใด

ช่อง
route_polyline_points_visibility

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

VisibilityOption

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

ช่อง
ช่องการรวม visibility_option ตัวเลือกการแชร์ที่เฉพาะเจาะจงที่เลือกไว้ visibility_option ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้
remaining_stop_count_threshold

int32

ผู้ใช้ปลายทางจะเห็นองค์ประกอบข้อมูลนี้หากจำนวนการแวะพักที่เหลืออยู่ <= ยังไม่ได้หยุด _count_threshold
duration_until_estimated_arrival_time_threshold

Duration

องค์ประกอบข้อมูลนี้จะปรากฏให้ผู้ใช้ปลายทางเห็นหากเวลาถึงโดยประมาณถึงป้ายหยุด <=duration_until_estimated_arrival_time_threshold
remaining_driving_distance_meters_threshold

int32

องค์ประกอบข้อมูลนี้จะปรากฏแก่ผู้ใช้ปลายทางหากระยะทางการขับรถที่เหลือเป็นเมตร <= left_driving_distance_meters_threshold
always

bool

หากตั้งค่าเป็น "จริง" ผู้ใช้ปลายทางจะเห็นองค์ประกอบข้อมูลนี้เสมอโดยไม่มีเกณฑ์ ตั้งค่าช่องนี้เป็น "เท็จ" ไม่ได้
never

bool

หากตั้งค่าเป็น "จริง" ระบบจะซ่อนองค์ประกอบข้อมูลนี้จากผู้ใช้ปลายทางเสมอโดยไม่มีเกณฑ์ ตั้งค่าช่องนี้เป็น "เท็จ" ไม่ได้

TimeWindow

ช่วงเวลา

ช่อง
start_time

Timestamp

ต้องระบุ เวลาเริ่มต้นของกรอบเวลา (รวมด้วย)
end_time

Timestamp

ต้องระบุ เวลาสิ้นสุดของกรอบเวลา (รวมด้วย)

UpdateDeliveryVehicleRequest

ข้อความคำขอ UpdateDeliveryVehicle

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
delivery_vehicle

DeliveryVehicle

ต้องระบุ อัปเดตเอนทิตี DeliveryVehicle ที่จะมีผล หมายเหตุ: คุณอัปเดตชื่อของ DeliveryVehicle ไม่ได้
update_mask

FieldMask

ต้องระบุ มาสก์ของช่องที่บ่งบอกว่าต้องอัปเดตช่อง DeliveryVehicle ใด โปรดทราบว่าupdate_mask ต้องมีช่องอย่างน้อย 1 ช่อง

ซึ่งเป็นรายการชื่อที่ตรงตามเกณฑ์ทั้งหมดของช่องที่คั่นด้วยคอมมา ตัวอย่าง: "remaining_vehicle_journey_segments"

UpdateTaskRequest

ข้อความคำขอ UpdateTask

ช่อง
header

DeliveryRequestHeader

ไม่บังคับ ส่วนหัวของคำขอ Delivery API แบบมาตรฐาน
task

Task

ต้องระบุ งานที่เกี่ยวข้องกับการอัปเดต ช่องต่อไปนี้มีการดูแลจัดการโดย Fleet Engine โปรดอย่าอัปเดตการตั้งค่าโดยใช้ Task.update

  • last_location
  • last_location_snappable
  • name
  • remaining_vehicle_journey_segments
  • task_outcome_location_source

หมายเหตุ: คุณจะเปลี่ยนค่า task_outcome ไม่ได้หลังจากตั้งค่าแล้ว

หากมีการมอบหมายงานให้กับยานพาหนะที่นำส่งแล้ว อย่าตั้งสถานะงานเป็น "ปิด" โดยใช้ Task.update แต่ให้นำ VehicleStop ที่มีงานออกจากยานพาหนะที่นำส่งแทน ซึ่งจะตั้งค่าสถานะงานเป็น "ปิด" โดยอัตโนมัติ
update_mask

FieldMask

ต้องระบุ มาสก์ฟิลด์ที่ระบุว่าต้องอัปเดตฟิลด์งานใด หมายเหตุ: update_mask ต้องมีอย่างน้อย 1 ช่อง

ซึ่งเป็นรายการชื่อที่ตรงตามเกณฑ์ทั้งหมดของช่องที่คั่นด้วยคอมมา ตัวอย่าง: "task_outcome,task_outcome_time,task_outcome_location"

VehicleJourneySegment

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

ช่อง
stop

VehicleStop

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

Int32Value

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

Duration

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

หากมีการกำหนดช่องนี้ในเส้นทาง Task.remaining_vehicle_journey_segments[0].driving_duration (gRPC) หรือ Task.remainingVehicleJourneySegments[0].drivingDuration (REST) ระบบอาจเติมค่าจาก DeliveryVehicle.remaining_duration (gRPC) หรือ DeliveryVehicle.remainingDuration (REST) ข้อมูลนี้จะแสดงระยะเวลาขับรถที่เหลืออยู่จากตําแหน่งล่าสุดที่ทราบของแอปคนขับ ไม่ใช่ระยะเวลาขับรถจากจุดแวะพักก่อนหน้า
path[]

LatLng

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

หากมีการกำหนดช่องนี้ในเส้นทาง Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) หรือ Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) ระบบอาจป้อนข้อมูลด้วย LatLng ที่ถอดรหัสจาก DeliveryVehicle.current_route_segment (gRPC) หรือ DeliveryVehicle.currentRouteSegment (REST) เส้นทางนี้จะบอกเส้นทางขับรถจากตำแหน่งที่ทราบล่าสุดของแอปคนขับ แทนที่จะเป็นเส้นทางจากป้ายจอดรถก่อนหน้า

VehicleStop

อธิบายจุดที่ยานพาหนะหยุดเพื่อทำการ Task อย่างน้อย 1 ครั้ง

ช่อง
planned_location

LocationInfo

ต้องระบุ ตำแหน่งของป้ายจอดรถ โปรดทราบว่าสถานที่ใน Task อาจไม่ตรงกับสถานที่นี้ทั้งหมด แต่จะอยู่ไม่ไกลจากสถานที่นี้ ระบบจะไม่ป้อนข้อมูลในช่องนี้เมื่อเรียก GetTask
tasks[]

TaskInfo

รายการ Task ที่จะดำเนินการในจุดแวะพักนี้ ระบบจะไม่ป้อนข้อมูลในช่องนี้เมื่อเรียก GetTask
state

State

สถานะของ VehicleStop ระบบจะไม่ป้อนข้อมูลในช่องนี้เมื่อเรียก GetTask

รัฐ

สถานะปัจจุบันของ VehicleStop

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

TaskInfo

ข้อมูลเพิ่มเติมเกี่ยวกับงานที่ดําเนินการเมื่อหยุดนี้

ช่อง
task_id

string

รหัสงาน ระบบจะไม่ป้อนข้อมูลในช่องนี้เมื่อเรียก GetTask รหัสงานอยู่ภายใต้ข้อจำกัดต่อไปนี้

  • ต้องเป็นสตริง Unicode ที่ถูกต้อง
  • จำกัดให้มีความยาวไม่เกิน 64 อักขระ
  • ทำให้เป็นมาตรฐานตามแบบฟอร์มการปรับมาตรฐาน Unicode
  • ต้องไม่มีอักขระ ASCII ต่อไปนี้: '/', ':', '?', ',' หรือ '#'
task_duration

Duration

เอาต์พุตเท่านั้น เวลาที่ต้องใช้ในการดำเนินการ
target_time_window

TimeWindow

เอาต์พุตเท่านั้น กรอบเวลาที่งานควรเสร็จสิ้น การดำเนินการนี้จะตั้งค่าในการตอบกลับ GetDeliveryVehicle เท่านั้น