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

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

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

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

เวอร์ชันของ 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 ที่เรียกใช้ ซึ่งใช้ได้กับ SDK ของ Android เท่านั้น ตัวอย่างค่าในช่อง: 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 ที่เรียกใช้คือ Consumer
DRIVER SDK ที่เรียกใช้คือ Driver
JAVASCRIPT SDK ที่เรียกใช้คือ JavaScript

DeliveryVehicle

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

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

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 ค่าของแอตทริบิวต์อาจเป็นสตริง บูลีน หรือเลขทศนิยม delivery_vehicle_attribute_value ต้องเป็นค่าใดค่าหนึ่งต่อไปนี้เท่านั้น
string_value

string

ค่าแอตทริบิวต์ที่เป็นสตริง

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

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

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

ListTasksResponse

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

ช่อง
tasks[]

Task

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

next_page_token

string

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

total_size

int64

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

LocationInfo

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

ช่อง
point

LatLng

พิกัดของสถานที่ตั้ง

งาน

งานใน 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 สำหรับงานประเภท UNAVAILABLE และ SCHEDULED_STOP ได้ รหัสเหล่านี้อยู่ภายใต้ข้อจำกัดต่อไปนี้

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

string

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

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

LocationInfo

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

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

TaskAttribute

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

ช่อง
key

string

คีย์ของแอตทริบิวต์ คีย์ต้องไม่มีอักขระโคลอน (:)

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

string

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

bool_value

bool

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

number_value

double

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

TaskTrackingInfo

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

ช่อง
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

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

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

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

Duration

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

target_time_window

TimeWindow

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