Package maps.fleetengine.delivery.v1

索引

DeliveryService

Last Mile Delivery 服務。

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,但必須包含目前 DeliveryVehicle 中的所有 VehicleJourneySegmenttask_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 專案 ID。例如 sample-cloud-projectCreateTaskRequest 訊息中的父項欄位必須是空白,或者必須與這個欄位相符。

requests[]

CreateTaskRequest

必要欄位。用來指定要建立資源的要求訊息。注意:一個批次中最多可以建立 500 個工作。

BatchCreateTasksResponse

BatchCreateTask 回應訊息。

欄位
tasks[]

Task

已建立的工作。

CreateDeliveryVehicleRequest

CreateDeliveryVehicle 要求訊息。

欄位
header

DeliveryRequestHeader

選用設定。標準 Delivery API 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}。提供者必須是 Google Cloud 專案 ID。例如 sample-cloud-project

delivery_vehicle_id

string

必要欄位。車輛運送 ID 不得重複,並且適用下列限制:

  • 必須是有效的 Unicode 字串。
  • 長度上限為 64 個半形字元。
  • 根據 Unicode 正規化表單 C 進行正規化處理。
  • 不得包含以下任何 ASCII 字元:「/」、「:」、「?」、「,」或「#」。
delivery_vehicle

DeliveryVehicle

必要欄位。要建立的 DeliveryVehicle 實體。建立新的外送車輛時,您可以設定下列選填欄位:

  • last_location
  • attributes

注意:系統會忽略 DeliveryVehicle 的 name 欄位。請勿設定所有其他 DeliveryVehicle 欄位,否則會傳回錯誤。

CreateTaskRequest

CreateTask 要求訊息。

欄位
header

DeliveryRequestHeader

選用設定。標準 Delivery API 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}provider 必須是 Google Cloud 專案 ID。例如:sample-cloud-project

task_id

string

必要欄位。工作 ID 不得重複,但不得為運送追蹤 ID。如要儲存運送追蹤 ID,請使用 tracking_id 欄位。請注意,多項工作可以具有相同的 tracking_id。工作 ID 受到下列限制:

  • 必須是有效的 Unicode 字串。
  • 長度上限為 64 個半形字元。
  • 根據 Unicode 正規化表單 C 進行正規化處理。
  • 不得包含以下任何 ASCII 字元:「/」、「:」、「?」、「,」或「#」。
task

Task

必要欄位。要建立的 Task 實體。建立任務時必須提供下列欄位:

  • type
  • state (必須設為 OPEN)
  • tracking_id (不得為 UNAVAILABLESCHEDULED_STOP 工作設定,但所有其他工作類型則為必要設定)
  • planned_location (UNAVAILABLE 工作選用)
  • task_duration

注意:系統會忽略工作的 name 欄位。不得設定所有其他「Task」欄位,否則會傳回錯誤。

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.112.1

device_model

string

執行呼叫 SDK 的裝置型號。欄位值範例:iPhone12,1SM-G920F

sdk_type

SdkType

傳送要求的 SDK 類型。

maps_sdk_version

string

呼叫 SDK 所依附的 MapSDK 版本 (如適用)。這個版本格式為「major.minor.patch」,例如:5.2.1

nav_sdk_version

string

呼叫 SDK 所依附的 NavSDK 版本 (如適用)。這個版本格式為「major.minor.patch」,例如:2.1.0

platform

Platform

呼叫 SDK 的平台。

manufacturer

string

Android 裝置透過呼叫 SDK 的製造商,僅適用於 Android SDK。欄位值範例:Samsung

android_api_level

int32

呼叫 SDK 的 Android API 級別,僅適用於 Android SDK。欄位值範例:23

trace_id

string

為識別要求而提供的選用 ID。

平台

呼叫 SDK 的平台。

列舉
PLATFORM_UNSPECIFIED 預設值。如果省略平台,則會使用這個值。
ANDROID 要求來自 Android。
IOS 要求來自 iOS。
WEB 要求來自網路。

SdkType

可能的 SDK 類型。

列舉
SDK_TYPE_UNSPECIFIED 預設值。如果省略 sdk_type,則會使用這個值。
CONSUMER 呼叫的 SDK 為「Consumer」。
DRIVER 呼叫的 SDK 為驅動程式。
JAVASCRIPT 呼叫的 SDK 為 JavaScript。

DeliveryVehicle

DeliveryVehicle 訊息。外送車輛會將貨物從庫房送至送貨地點,以及從上車地點到庫房。在某些情況下,運送車輛也會直接將貨物從上車地點運送至送貨地點。

注意:gRPC 和 REST API 使用不同的欄位命名慣例。例如,gRPC API 中的 DeliveryVehicle.current_route_segment 欄位和 REST API 中的 DeliveryVehicle.currentRouteSegment 欄位指的是同一個欄位。

欄位
name

string

這輛貨車的專屬名稱。格式為 providers/{provider}/deliveryVehicles/{vehicle}

last_location

DeliveryVehicleLocation

上次回報的貨車地點。

navigation_status

DeliveryVehicleNavigationStatus

配送車輛的導航狀態。

current_route_segment

bytes

編碼折線,可指定導航建議前往下一個路線控點的路徑。駕駛/途中及導航重新規劃路線時,駕駛應用程式會更新這項設定。系統會針對指派給車輛的所有執行中工作,在 Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path (gRPC) 或 Task.journeySharingInfo.remainingVehicleJourneySegments[0].path (REST) 中傳回這些 LatLng

在少數情況下,這個欄位可能無法用來填入 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,或是 current_route_segment 的最後一個 LatLng。Fleet Engine 會盡可能插入實際的 VehicleStop

如果 current_route_segment 欄位空白,UpdateDeliveryVehicle 呼叫會略過此欄位。

remaining_distance_meters

Int32Value

current_route_segment 的剩餘行車距離。驅動程式應用程式通常會提供這個欄位,但在某些情況下,Fleet Engine 會覆寫應用程式傳送的值。詳情請參閱 DeliveryVehicle.current_route_segment。針對指派給配送車輛的所有有效 Task,系統會在 Task.remaining_vehicle_journey_segments[0].driving_distance_meters (gRPC) 或 Task.remainingVehicleJourneySegments[0].drivingDistanceMeters (REST) 中傳回這個欄位。

如果 current_route_segment 欄位空白,Fleet Engine 會忽略 UpdateDeliveryVehicleRequest 中的這個欄位。

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) 中傳回這個欄位。

如果 current_route_segment 欄位空白,Fleet Engine 會忽略 UpdateDeliveryVehicleRequest 中的這個欄位。

remaining_vehicle_journey_segments[]

VehicleJourneySegment

指派給這輛貨車的歷程區隔,從車輛最近回報的地點開始。系統不會在 ListDeliveryVehicles 的回應中填入這個欄位。

attributes[]

DeliveryVehicleAttribute

自訂外送車輛屬性的清單。汽車外送車輛最多有 100 個屬性,且每個屬性都必須有專屬索引鍵。

type

DeliveryVehicleType

這輛貨車的類型。如未設定,系統會預設為 AUTO

DeliveryVehicleType

交車的類型。

列舉
DELIVERY_VEHICLE_TYPE_UNSPECIFIED 這個值未使用。
AUTO 汽車。
TWO_WHEELER 摩托車、電動自行車或其他雙輪車輛
BICYCLE 人電運輸。
PEDESTRIAN 人類運輸工具,通常是步行或跑步,沿著人行道行駛。

DeliveryVehicleAttribute

將車輛屬性描述為鍵/值組合。「key:value」字串長度不得超過 256 個字元。

欄位
key

string

屬性的鍵。

value

string

屬性值。

聯集欄位 delivery_vehicle_attribute_value。屬性的值可以是字串、布林值或雙精度浮點數。delivery_vehicle_attribute_value 只能是下列其中一項:
string_value

string

字串類型的屬性值。

注意:這與最終將會淘汰的 value 欄位相同。建立或更新方法時,可使用任一欄位,但強烈建議使用 string_value。如果同時設定 string_valuevalue,兩者必須相同,否則系統會擲回錯誤。系統會在回應中填入這兩個欄位。

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。如果時間不明 (例如應用程式重新啟動),這個值會重設為零。

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

用於判斷位置的感應器或方法。

列舉
UNKNOWN_SENSOR 未指定或不明感應器。
GPS GPS 或輔助 GPS。
NETWORK GPS、行動通信基地台 ID 或 Wi-Fi 存取點。
PASSIVE 基地台 ID 或 Wi-Fi 存取點。
ROAD_SNAPPED_LOCATION_PROVIDER 根據行動裝置判斷,位置可能是最有可能的道路位置。
CUSTOMER_SUPPLIED_LOCATION 客戶透過獨立來源提供的地點。通常,這個值用於執行驅動程式 SDK 的行動裝置以外的來源所提供的位置。如果其他列舉值描述原始來源,請使用該值。標示為 CUSTOMER_SUPPLIED_LOCATION 的地點通常由貨運車的 last_location.supplemental_location_sensor 提供。
FLEET_ENGINE_LOCATION 由 Fleet Engine 根據可用的信號計算出的位置。僅供輸出。如果在要求中收到這個值,系統就會拒絕。
FUSED_LOCATION_PROVIDER Android 的整合式位置預測提供工具。
CORE_LOCATION Apple 作業系統上的位置提供者。

DeliveryVehicleNavigationStatus

車輛的導航狀態。

列舉
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 專案 ID。例如:sample-cloud-project

GetTaskRequest

GetTask 要求訊息。

欄位
header

DeliveryRequestHeader

選用設定。標準 Delivery API 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/tasks/{task}provider 必須是 Google Cloud 專案 ID。例如:sample-cloud-project

GetTaskTrackingInfoRequest

GetTaskTrackingInfoRequest 要求訊息。

欄位
header

DeliveryRequestHeader

選用設定。標準 Delivery API 要求標頭。

name

string

必要欄位。格式必須為 providers/{provider}/taskTrackingInfo/{tracking_id}provider 必須是 Google Cloud 專案 ID,而 tracking_id 必須是與工作相關聯的追蹤 ID。範例名稱可以是 providers/sample-cloud-project/taskTrackingInfo/sample-tracking-id

ListDeliveryVehiclesRequest

ListDeliveryVehicles 要求訊息。

欄位
header

DeliveryRequestHeader

選用設定。標準 Delivery API 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}provider 必須是 Google Cloud 專案 ID。例如:sample-cloud-project

page_size

int32

選用設定。要傳回的車輛數量上限。服務傳回的產品數量可能會少於這個數字。如未指定此數字,伺服器就會決定要傳回的結果數量。

page_token

string

選用設定。屬於接收自前一個 ListDeliveryVehicles 呼叫的網頁權杖。您必須提供這項資訊,才能擷取後續網頁。

進行分頁時,提供至 ListDeliveryVehicles 的所有其他參數須與提供網頁權杖的呼叫相符。

filter

string

選用設定。列出外送車輛時要套用的篩選器查詢。如需篩選器語法範例,請參閱 http://aip.dev/160。如未指定值,或為篩選器指定空白字串,系統就會傳回所有外送車輛。

請注意,只有車輛屬性 (例如 attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2>) 支援 ListDeliveryVehicles 查詢。此外,所有屬性都會儲存為字串,因此唯一支援的與屬性比較是字串比較。為了與數字或布林值進行比較,這些值必須明確加上引號,才能視為字串 (例如 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 專案 ID。例如:sample-cloud-project

page_size

int32

選用設定。要傳回的 Tasks 數量上限。服務傳回的產品數量可能會少於這個值。如未指定此值,伺服器會決定要傳回的結果數量。

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

含有任何其他 ID 的位置。

欄位
point

LatLng

位置的座標。

SearchTasksRequest

已淘汰:改為向 GetTaskTrackingInfo 發出 GetTaskTrackingInfoRequest

欄位
header

DeliveryRequestHeader

選用設定。標準 Delivery API 要求標頭。

parent

string

必要欄位。格式必須為 providers/{provider}。提供者必須是 Google Cloud 專案 ID。例如 sample-cloud-project

tracking_id

string

必要欄位。要求相關 Tasks 的組合 ID。追蹤 ID 必須遵守下列限制:

  • 必須是有效的 Unicode 字串。
  • 長度上限為 64 個半形字元。
  • 根據 Unicode 正規化表單 C 進行正規化處理。
  • 不得包含以下任何 ASCII 字元:「/」、「:」、「?」、「,」或「#」。
page_size

int32

選用設定。要傳回的 Tasks 數量上限。服務傳回的產品數量可能會少於這個值。如未指定此值,伺服器會決定要傳回的結果數量。

page_token

string

選用設定。屬於接收自前一個 SearchTasks 呼叫的網頁權杖。您必須提供這個值才能擷取後續網頁。

進行分頁時,提供至 SearchTasks 的所有其他參數須與提供網頁權杖的呼叫相符。

SearchTasksResponse

SearchTasks 回應。其中包含一組符合 SearchTasksRequest 中的搜尋條件的工作。

欄位
tasks[]

Task

所要求 tracking_id 的工作組合。成功的回應也可以留空。空白的回應表示沒有任何工作與提供的 tracking_id 相關聯。

next_page_token

string

SearchTasksRequest 中傳遞這個權杖,即可繼續列出結果。如果傳回所有結果,這個欄位就會是空白字串,或者不會出現在回應中。

任務

Delivery API 中的「工作」代表要追蹤的單一動作。一般而言,與出貨相關的「工作」和「中斷工作」之間會有區別。一項貨件可以有多個相關聯的 Tasks。舉例來說,您可以設定一個用於上車的任務,以及下車或轉車。此外,單一運送作業的不同工作也可由不同車輛處理。舉例來說,某輛車可以處理上車作業、將貨運載往中樞,另一輛車則負責將車子從中心到下車地點。

注意:gRPC 和 REST API 使用不同的欄位命名慣例。例如,gRPC API 中的 Task.journey_sharing_info 欄位和 REST API 中的 Task.journeySharingInfo 欄位指的是同一個欄位。

欄位
name

string

格式必須為 providers/{provider}/tasks/{task}

type

Type

必要欄位。不可變動。定義任務的類型。例如中斷或運送。

state

State

必要欄位。Task 目前的執行狀態。

task_outcome

TaskOutcome

工作的結果。

task_outcome_time

Timestamp

指出提供者設定 Task 結果的時間戳記。

task_outcome_location

LocationInfo

設定 Task 結果的位置。這個值會在 UpdateTask 中更新。如果供應商未明確更新這個值,根據預設,Fleet Engine 會將其填入最後已知的車輛位置 (原始位置)。

task_outcome_location_source

TaskOutcomeLocationSource

指出 task_outcome_location 的值的來源。

tracking_id

string

不可變動。這個欄位可以儲存 ID,避免使用複雜的對應。您無法為 UNAVAILABLESCHEDULED_STOP 類型的工作設定 tracking_id。這些 ID 適用下列限制:

  • 必須是有效的 Unicode 字串。
  • 長度上限為 64 個半形字元。
  • 根據 Unicode 正規化表單 C 進行正規化處理。
  • 不得包含以下任何 ASCII 字元:「/」、「:」、「?」、「,」或「#」。
delivery_vehicle_id

string

僅供輸出。執行這項工作的車輛 ID。運送車輛 ID 受到下列限制:

  • 必須是有效的 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。如果 last_locationcurrent_route_segment 不存在,這個值為 False。這個值是由 Fleet Engine 計算,系統會忽略來自用戶端的更新。

狀態

Task 的狀態。這代表 Tasks 的進度。

列舉
STATE_UNSPECIFIED 預設。用於不明或無法辨識的工作狀態。
OPEN 工作尚未指派給外送車輛,或是運送車輛尚未通過 Task 指定的車輛停靠站。
CLOSED 車輛通過此任務的車輛停靠時間。

TaskOutcome

嘗試執行 Task 的結果。當 TaskState 關閉時,TaskOutcome 會指出是否已順利完成。

列舉
TASK_OUTCOME_UNSPECIFIED 先將工作結果設為其值。
SUCCEEDED 工作順利完成。
FAILED 工作無法完成或已取消。

TaskOutcomeLocationSource

填入 task_outcome_location 的來源識別資訊。

列舉
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED 工作在設定之前的結果。
PROVIDER 供應商指定的 task_outcome_location
LAST_VEHICLE_LOCATION 供應商未指定 task_outcome_location,因此 Fleet Engine 是使用最後已知的車輛位置。

類型

Task 的類型。

列舉
TYPE_UNSPECIFIED 預設 Task 類型不明。
PICKUP 取貨工作是指客戶取貨時採取的行動。庫房或餵食器上車應使用 SCHEDULED_STOP 類型。
DELIVERY 貨品交付任務是指將貨運給最終客戶採取的行動。庫房或餵食器車輛下車應使用 SCHEDULED_STOP 類型。
SCHEDULED_STOP 排定的停止工作用於規劃用途。舉例來說,它可能代表從餵食器或倉庫到貨的到貨。如為由消費者上下取貨,則請勿使用這個折扣。
UNAVAILABLE 「工作」表示無法提供車輛服務。舉例來說,如果駕駛人休息一下或車輛停車,就可能會發生這種情況。

TaskAttribute

將工作屬性描述為鍵/值組合。「key:value」字串長度不得超過 256 個字元。

欄位
key

string

屬性的鍵。鍵不得包含冒號字元 (:)。

聯集欄位 task_attribute_value。屬性的值可以是字串、布林值或雙精度浮點數。如果未設定,TaskAttribute string_value 會儲存為空白字串「"」。task_attribute_value 只能採用下列其中一種做法:
string_value

string

字串類型的屬性值。

bool_value

bool

布林值類型的屬性值。

number_value

double

雙重類型的屬性值。

TaskTrackingInfo

TaskTrackingInfo 訊息。訊息包含工作追蹤資訊,可用於顯示。如果追蹤 ID 與多項工作相關聯,Fleet Engine 會使用經驗法則來決定要選取哪一個任務的 TaskTrackingInfo。

欄位
name

string

格式必須為 providers/{provider}/taskTrackingInfo/{tracking},其中 tracking 代表追蹤 ID。

tracking_id

string

不可變動。工作的追蹤 ID。* 必須是有效的 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 目前的執行狀態。

task_outcome

TaskOutcome

嘗試執行 Task 的結果。

task_outcome_time

Timestamp

指出提供者何時設定 Task 結果的時間戳記。

planned_location

LocationInfo

不可變動。完成任務的位置。

target_time_window

TimeWindow

完成工作的時間範圍。

attributes[]

TaskAttribute

針對工作設定的自訂屬性。

TaskTrackingViewConfig

定義使用者何時應看到 Task 資料元素的設定訊息。

欄位
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

如果剩餘的停靠站計數 <= Rest_stop_count_threshold ,使用者都能看到這個資料元素。

duration_until_estimated_arrival_time_threshold

Duration

如果抵達停靠站的預計到達時間 <= duration_until_estimated_arrival_time_threshold ,使用者都能看到這個資料元素。

remaining_driving_distance_meters_threshold

int32

如果剩餘的行車距離 (公尺 <= left_driving_distance_meters_threshold) 會向使用者顯示這個資料元素。

always

bool

如果設為 True,使用者一律會看到沒有閾值的資料元素。這個欄位不得設為 false。

never

bool

如果設為 True,系統就不會對使用者隱藏這個資料元素,且未設定門檻。這個欄位不得設為 false。

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

必要欄位。與更新相關聯的 Task。下列欄位是由 Fleet Engine 維護。請勿使用 Task.update 更新。

  • last_location.
  • last_location_snappable.
  • name.
  • remaining_vehicle_journey_segments.
  • task_outcome_location_source.

注意:task_outcome 的值一經設定即無法變更。

如果任務已指派給外送車輛,請勿使用 Task.update 將「工作」狀態設為「已關閉」。請改為從外送車輛中移除含有任務的 VehicleStop,這樣就能將工作狀態自動設為「CLOSED」。

update_mask

FieldMask

必要欄位。欄位遮罩來指出要更新哪些「Task」欄位。注意:update_mask 必須包含至少一個欄位。

此為以半形逗號分隔的完整欄位名稱清單,範例:"task_outcome,task_outcome_time,task_outcome_location"

VehicleJourneySegment

代表車輛的行駛路段,從先前停靠站到目前停靠站。如果這是第一個有效的停靠站,表示這是從車輛目前位置到這個停靠站。

欄位
stop

VehicleStop

指定停靠站位置,以及與停靠站相關聯的 Task。如果這個旅程區隔屬於 JourneySharingInfo,系統可能不會顯示 VehicleStop 的部分欄位。

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) 中定義,則可以使用從 DeliveryVehicle.current_route_segment (gRPC) 或 DeliveryVehicle.currentRouteSegment (REST) 解碼的 LatLng 填入。這樣能提供來自駕駛應用程式最新已知位置的行車路徑,而非上一個停靠站的路徑。

VehicleStop

說明車輛停下來執行一或多個 Task 的點。

欄位
planned_location

LocationInfo

必要欄位。停靠站的位置。請注意,Task 中的地點不一定會與這個位置完全相符,但相距不遠。這個欄位不會在 GetTaskSearchTasks 呼叫的回應中填入資料。

tasks[]

TaskInfo

要在這個停靠站執行的 Task 清單。這個欄位不會在 GetTaskSearchTasks 呼叫的回應中填入資料。

state

State

VehicleStop 的狀態。這個欄位不會在 GetTaskSearchTasks 呼叫的回應中填入資料。

狀態

VehicleStop 的目前狀態。

列舉
STATE_UNSPECIFIED 不明。
NEW 已建立,但尚未主動轉送。
ENROUTE 已指派和主動轉送。
ARRIVED 已抵達停靠站。假設車輛轉送到下一個停靠站,先前的所有停靠站都已完成。

TaskInfo

針對在這個停靠站執行的工作提供額外資訊。

欄位
task_id

string

工作 ID。這個欄位不會在 GetTaskSearchTasks 呼叫的回應中填入資料。工作 ID 受到下列限制:

  • 必須是有效的 Unicode 字串。
  • 長度上限為 64 個半形字元。
  • 根據 Unicode 正規化表單 C 進行正規化處理。
  • 不得包含以下任何 ASCII 字元:「/」、「:」、「?」、「,」或「#」。
task_duration

Duration

僅供輸出。執行任務所需的時間。

target_time_window

TimeWindow

僅供輸出。完成工作的時間範圍。這個值只會在對 GetDeliveryVehicle 的回應中設定。