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 ใหม่
DeleteDeliveryVehicle

rpc DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest) returns (Empty)

ลบ DeliveryVehicle ออกจาก Fleet Engine

แสดงผล FAILED_PRECONDITION หากมีการกำหนดงานที่สถานะเป็น OPEN ให้กับ DeliveryVehicle
DeleteTask

rpc DeleteTask(DeleteTaskRequest) returns (Empty)

ลบงานเดียว

แสดงผล FAILED_PRECONDITION หากงานมีสถานะเป็น OPEN และมอบหมายให้กับ DeliveryVehicle
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

งานที่สร้างขึ้น

CreateDeliveryVehicleRequest

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

ช่อง
header

DeliveryRequestHeader

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

string

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

string

ต้องระบุ รหัสยานพาหนะนำส่งต้องไม่ซ้ำกันและเป็นไปตามข้อจำกัดต่อไปนี้
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 เดียวกันได้ รหัสงานมีข้อจำกัดดังนี้
task

Task

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

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

คุณจะตั้งค่าช่องต่อไปนี้หรือไม่ก็ได้

  • target_time_window
  • task_tracking_view_config
  • attributes

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

DeleteDeliveryVehicleRequest

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

ช่อง
header

DeliveryRequestHeader

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

string

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

DeleteTaskRequest

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

ช่อง
header

DeliveryRequestHeader

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

string

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

DeliveryRequestHeader

RequestHeader มีฟิลด์ที่ใช้ร่วมกันในคำขอ 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

เวอร์ชันของ Calling 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 การโทรคือ Consumer
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

ตำแหน่งล่าสุดของยานพาหนะนำส่ง
past_locations[]

DeliveryVehicleLocation

อินพุตเท่านั้น ตำแหน่งที่ยานพาหนะนำส่งนี้เคยอยู่ก่อนหน้านี้ซึ่งยังไม่ได้รายงานไปยัง Fleet Engine โดยจะใช้ใน UpdateDeliveryVehicleRequest เพื่อบันทึกตำแหน่งที่ก่อนหน้านี้ส่งไปยังเซิร์ฟเวอร์ไม่ได้ โดยปกติแล้วปัญหานี้จะเกิดขึ้นเมื่อยานพาหนะนำส่งไม่มีการเชื่อมต่ออินเทอร์เน็ต
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 จะป้อนข้อมูลในช่องนี้ด้วยเส้นทางจาก VehicleStop ที่ผ่านล่าสุดไปยัง VehicleStop ที่กำลังจะมาถึง เพื่อให้มั่นใจว่าผู้ใช้ช่องนี้จะมีข้อมูลที่ดีที่สุดเกี่ยวกับเส้นทางปัจจุบันของยานพาหนะนำส่ง
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

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

string

ค่าแอตทริบิวต์ประเภทสตริง

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

bool

ค่าแอตทริบิวต์ประเภทบูลีน
number_value

double

ค่าแอตทริบิวต์ประเภท 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

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

Timestamp

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

DeliveryVehicleLocationSensor

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

DoubleValue

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

LatLng

ตำแหน่งจาก Fused Location Provider ของ Android
flp_update_time

Timestamp

การประทับเวลาของการอัปเดตของ flp_location
flp_latlng_accuracy_meters

DoubleValue

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

Int32Value

ทิศทางที่ยานพาหนะเคลื่อนที่ในหน่วยองศาตามที่กำหนดโดย Fused Location Provider 0 หมายถึงทิศเหนือ ช่วงที่ใช้ได้คือ [0,360)
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 หรือ Assisted 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

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

ListTasksResponse

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

ช่อง
tasks[]

Task

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

string

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

int64

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

LocationInfo

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

ช่อง
point

LatLng

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

string

ชื่อทรัพยากรของสถานที่ที่แสดงถึงตำแหน่งนี้ รูปแบบคือ places/{place_id} ต้องระบุ point หรือ place เป็นอินพุต หากระบุทั้ง 2 อย่าง ระบบจะใช้ point สำหรับการกำหนดเส้นทาง และใช้ place สำหรับข้อมูลเมตา place จะรวมอยู่ในเอาต์พุตก็ต่อเมื่อรวมอยู่ในอินพุต ซึ่งหมายความว่าจะไม่มีการค้นหา place จาก LatLng

นี่เป็นฟีเจอร์ทดลองใช้
point_location_source

PointSource

เอาต์พุตเท่านั้น แหล่งที่มาของฟิลด์ latlng point นี่เป็นส่วนหนึ่งของฟีเจอร์ทดลอง

PointSource

ระบุแหล่งที่มาของ LatLng

Enum
POINT_SOURCE_UNSPECIFIED ไม่ได้ระบุแหล่งที่มาของจุด
POINT_SOURCE_DEVELOPER_PROVIDED นักพัฒนาแอปเป็นผู้ระบุ LatLng อย่างชัดเจน
POINT_SOURCE_CALCULATED_FROM_PLACE ระบบคำนวณ LatLng จากสถานที่ที่ระบุ

งาน

งานใน Delivery API แสดงถึงการดำเนินการเดียวที่จะติดตาม โดยทั่วไปแล้ว งานที่เกี่ยวข้องกับการจัดส่งและงานพักจะมีความแตกต่างกัน การจัดส่ง 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 รหัสเหล่านี้มีข้อจำกัดดังต่อไปนี้
delivery_vehicle_id

string

เอาต์พุตเท่านั้น รหัสของยานพาหนะที่ดำเนินการในงานนี้ รหัสยานพาหนะนำส่งมีข้อจำกัดต่อไปนี้
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 ได้หรือไม่ ค่านี้จะเป็น False หากไม่มี 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 งานรับสินค้าคือการดำเนินการเพื่อรับสินค้าที่จัดส่งจากลูกค้า การรับยานพาหนะที่คลังหรือยานพาหนะป้อนควรใช้ประเภท SCHEDULED_STOP
DELIVERY งานนำส่งคือการดำเนินการเพื่อนำส่งการจัดส่งไปยังลูกค้าปลายทาง การส่งยานพาหนะที่คลังหรือยานพาหนะป้อนควรใช้ประเภท SCHEDULED_STOP
SCHEDULED_STOP ระบบจะใช้ Task การหยุดที่กำหนดเวลาไว้เพื่อวัตถุประสงค์ในการวางแผน เช่น อาจหมายถึงการรับหรือนำส่งพัสดุจากยานพาหนะหรือคลังสินค้า ไม่ควรใช้สำหรับการจัดส่งที่รับหรือนำส่งจากลูกค้าปลายทาง
UNAVAILABLE งานที่หมายความว่ายานพาหนะไม่พร้อมให้บริการ เช่น กรณีที่คนขับพักผ่อนหรือเมื่อรถยนต์กำลังเติมน้ำมัน

TaskAttribute

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

ช่อง
key

string

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

string

ค่าแอตทริบิวต์ประเภทสตริง
bool_value

bool

ค่าแอตทริบิวต์ประเภทบูลีน
number_value

double

ค่าแอตทริบิวต์ประเภท Double

TaskTrackingInfo

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

ช่อง
name

string

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

string

เปลี่ยนแปลงไม่ได้ รหัสติดตามของงาน * ต้องเป็นสตริง Unicode ที่ถูกต้อง * มีความยาวสูงสุดได้ 64 อักขระ * ปรับให้เป็นมาตรฐานตามรูปแบบการทำให้เป็นมาตรฐาน C ของ Unicode * ต้องไม่มีอักขระ 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

ฟิลด์ที่ระบุเวลาที่จุด Polyline ของเส้นทางจะมองเห็นได้ หากไม่ได้ระบุช่องนี้ ระบบจะใช้การกำหนดค่าระดับโปรเจ็กต์เริ่มต้นสำหรับการมองเห็นข้อมูลนี้
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

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

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

int32

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

Duration

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

int32

ผู้ใช้ปลายทางจะเห็นองค์ประกอบข้อมูลนี้หากระยะทางขับรถที่เหลือเป็นเมตร <= remaining_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 ได้เมื่อตั้งค่าแล้ว

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

FieldMask

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

ซึ่งเป็นรายการชื่อฟิลด์แบบสมบูรณ์ในตัวเองที่คั่นด้วยคอมมา ตัวอย่าง: "task_outcome,task_outcome_time,task_outcome_location"

VehicleJourneySegment

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

ช่อง
stop

VehicleStop

ระบุสถานที่จอดรถพร้อมกับTaskที่เชื่อมโยงกับป้ายจอดรถ ฟิลด์บางรายการของ VehicleStop อาจไม่มีอยู่หากส่วนการเดินทางนี้เป็นส่วนหนึ่งของ 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 รหัสงานมีข้อจำกัดดังนี้
task_duration

Duration

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

TimeWindow

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