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 ทั้งหมดที่ตรงกับเกณฑ์การกรองที่ระบุ
SearchTasks

rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse)

เลิกใช้งานแล้ว: ใช้ GetTaskTrackingInfo แทน
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

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

  • ต้องเป็นสตริง Unicode ที่ถูกต้อง
  • มีจำนวนอักขระได้สูงสุด 64 ตัว
  • ได้รับการปรับให้เป็นมาตรฐานตามรูปแบบการทำให้เป็นมาตรฐาน Unicode C
  • ต้องไม่มีอักขระ 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 C
  • ต้องไม่มีอักขระ ASCII ต่อไปนี้: "/", ":", "?", "," หรือ "#"
task

Task

ต้องระบุ เอนทิตีงานที่จะสร้าง เมื่อสร้างงาน คุณต้องระบุฟิลด์ต่อไปนี้

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

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

DeliveryRequestHeader

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

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

ช่อง
key

string

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

string

ค่าแอตทริบิวต์
ฟิลด์สหภาพ delivery_vehicle_attribute_value ค่าแอตทริบิวต์อาจเป็นสตริง bool หรือประเภท 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 หรือ Assist
NETWORK GPS ที่ได้รับการสนับสนุน, ID เสาสัญญาณมือถือ หรือจุดเข้าใช้งาน WiFi
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 ของ 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 หากคุณไม่ระบุค่าหรือกรองในสตริงว่าง ระบบจะแสดงงานทั้งหมด สำหรับข้อมูลเกี่ยวกับคุณสมบัติของงานที่คุณกรองได้ โปรดดูที่แสดงรายการงาน

ListTasksResponse

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

ช่อง
tasks[]

Task

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

string

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

int64

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

LocationInfo

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

ช่อง
point

LatLng

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

SearchTasksRequest

เลิกใช้งาน: ฉบับที่ GetTaskTrackingInfoRequest เป็น GetTaskTrackingInfo แทน

ช่อง
header

DeliveryRequestHeader

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

string

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

string

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

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

int32

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

string

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

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

SearchTasksResponse

การตอบกลับ SearchTasks ซึ่งมีชุดงานที่ตรงกับเกณฑ์การค้นหาใน SearchTasksRequest

ช่อง
tasks[]

Task

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

string

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

งาน

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

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

string

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

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

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

รัฐ

สถานะของงาน ข้อมูลนี้จะระบุความคืบหน้าของ Tasks

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

TaskAttribute

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

ช่อง
key

string

คีย์ของแอตทริบิวต์ คีย์ต้องไม่มีอักขระโคลอน (:)
ฟิลด์สหภาพ task_attribute_value ค่าแอตทริบิวต์อาจเป็นสตริง bool หรือประเภท 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

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

Duration

องค์ประกอบข้อมูลนี้จะปรากฏแก่ผู้ใช้ปลายทางหากเวลาถึงโดยประมาณถึงหยุด <= period_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 ต้องมีอย่างน้อยหนึ่งช่อง

ซึ่งเป็นรายการชื่อฟิลด์ที่สมบูรณ์ในตัวเองซึ่งคั่นด้วยคอมมา ตัวอย่าง: "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 หรือ SearchTasks
tasks[]

TaskInfo

รายการของ Task ที่จะดำเนินการที่ป้ายจอดรถนี้ ระบบจะไม่ป้อนข้อมูลในช่องนี้ไว้ตอบการเรียก GetTask หรือ SearchTasks
state

State

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

รัฐ

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

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

TaskInfo

ข้อมูลเพิ่มเติมเกี่ยวกับงานที่จุดแวะพักนี้

ช่อง
task_id

string

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

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

Duration

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

TimeWindow

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