本頁面由 Cloud Translation API 翻譯而成。

Package maps.fleetengine.delivery.v1

索引

DeliveryService (介面)
BatchCreateTasksRequest (訊息)
BatchCreateTasksResponse (訊息)
CreateDeliveryVehicleRequest (訊息)
CreateTaskRequest (訊息)
DeliveryRequestHeader (訊息)
DeliveryRequestHeader.Platform (列舉)
DeliveryRequestHeader.SdkType (列舉)
DeliveryVehicle (訊息)
DeliveryVehicle.DeliveryVehicleType (列舉)
DeliveryVehicleAttribute (訊息)
DeliveryVehicleLocation (訊息)
DeliveryVehicleLocationSensor (列舉)
DeliveryVehicleNavigationStatus (列舉)
GetDeliveryVehicleRequest (訊息)
GetTaskRequest (訊息)
GetTaskTrackingInfoRequest (訊息)
ListDeliveryVehiclesRequest (訊息)
ListDeliveryVehiclesResponse (訊息)
ListTasksRequest (訊息)
ListTasksResponse (訊息)
LocationInfo (訊息)
Task (訊息)
Task.JourneySharingInfo (訊息)
Task.State (列舉)
Task.TaskOutcome (列舉)
Task.TaskOutcomeLocationSource (列舉)
Task.Type (列舉)
TaskAttribute (訊息)
TaskTrackingInfo (訊息)
TaskTrackingViewConfig (訊息)
TaskTrackingViewConfig.VisibilityOption (訊息)
TimeWindow (訊息)
UpdateDeliveryVehicleRequest (訊息)
UpdateTaskRequest (訊息)
VehicleJourneySegment (訊息)
VehicleStop (訊息)
VehicleStop.State (列舉)
VehicleStop.TaskInfo (訊息)

DeliveryService

最後英里送貨服務

BatchCreateTasks

BatchCreateTasks
`rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)` 建立並傳回一批新的 `Task` 物件。

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

建立並傳回一批新的 Task 物件。

CreateDeliveryVehicle

CreateDeliveryVehicle
`rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)` 建立並傳回新的 `DeliveryVehicle`。

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

建立並傳回新的 DeliveryVehicle。

CreateTask

CreateTask
`rpc CreateTask(CreateTaskRequest) returns (Task)` 建立並傳回新的 `Task` 物件。

rpc CreateTask(CreateTaskRequest) returns (Task)

建立並傳回新的 Task 物件。

GetDeliveryVehicle

GetDeliveryVehicle
`rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)` 傳回指定的 `DeliveryVehicle` 例項。

rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle)

傳回指定的 DeliveryVehicle 例項。

GetTask

GetTask
`rpc GetTask(GetTaskRequest) returns (Task)` 取得 `Task` 的相關資訊。

rpc GetTask(GetTaskRequest) returns (Task)

取得 Task 的相關資訊。

GetTaskTrackingInfo

GetTaskTrackingInfo
`rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)` 傳回指定的 `TaskTrackingInfo` 例項。

rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo)

傳回指定的 TaskTrackingInfo 例項。

ListDeliveryVehicles

ListDeliveryVehicles
`rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)` 取得符合指定篩選條件的所有 `DeliveryVehicle`。

rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse)

取得符合指定篩選條件的所有 DeliveryVehicle。

ListTasks

ListTasks
`rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)` 取得符合指定篩選條件的所有 `Task`。

rpc ListTasks(ListTasksRequest) returns (ListTasksResponse)

取得符合指定篩選條件的所有 Task。

UpdateDeliveryVehicle

UpdateDeliveryVehicle
`rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)` 將更新後的`DeliveryVehicle`資料寫入 Fleet Engine，並將 `Tasks` 指派給 `DeliveryVehicle`。您無法更新「`DeliveryVehicle`」的名稱。您可以更新 `remaining_vehicle_journey_segments`，但其中必須包含所有要在 `DeliveryVehicle` 上保留的 `VehicleJourneySegment`。`task_id` 會從 `remaining_vehicle_journey_segments` 擷取，如果尚未指派，系統會將其對應的 `Tasks` 指派給 `DeliveryVehicle`。

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

將更新後的DeliveryVehicle資料寫入 Fleet Engine，並將 Tasks 指派給 DeliveryVehicle。您無法更新「DeliveryVehicle」的名稱。您可以更新 remaining_vehicle_journey_segments，但其中必須包含所有要在 DeliveryVehicle 上保留的 VehicleJourneySegment。task_id 會從 remaining_vehicle_journey_segments 擷取，如果尚未指派，系統會將其對應的 Tasks 指派給 DeliveryVehicle。

UpdateTask

UpdateTask
`rpc UpdateTask(UpdateTaskRequest) returns (Task)` 更新 `Task` 資料。

rpc UpdateTask(UpdateTaskRequest) returns (Task)

更新 Task 資料。

BatchCreateTasksRequest

BatchCreateTask 要求訊息。

欄位

欄位
`header`	`DeliveryRequestHeader` 選用設定。標準 Delivery API 要求標頭。注意：如果設定這個欄位，`CreateTaskRequest` 訊息中的標頭欄位必須留空，或是與這個欄位相符。
`parent`	`string` 必要欄位。所有工作共用的父項資源。這個值必須採用 `providers/{provider}` 格式。`provider` 必須是 Google Cloud 專案 ID。例如 `sample-cloud-project`。`CreateTaskRequest` 訊息中的父項欄位必須留空，或是與這個欄位相符。
`requests[]`	`CreateTaskRequest` 必要欄位。用於指定要建立資源的要求訊息。注意：一批最多可以建立 500 項工作。

header

DeliveryRequestHeader

選用設定。標準 Delivery API 要求標頭。注意：如果設定這個欄位，CreateTaskRequest 訊息中的標頭欄位必須留空，或是與這個欄位相符。

parent

string

必要欄位。所有工作共用的父項資源。這個值必須採用 providers/{provider} 格式。provider 必須是 Google Cloud 專案 ID。例如 sample-cloud-project。CreateTaskRequest 訊息中的父項欄位必須留空，或是與這個欄位相符。

requests[]

CreateTaskRequest

必要欄位。用於指定要建立資源的要求訊息。注意：一批最多可以建立 500 項工作。

BatchCreateTasksResponse

BatchCreateTask 回應訊息。

欄位

欄位
`tasks[]`	`Task` 已建立的 Tasks。

tasks[]

Task

已建立的 Tasks。

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 屬性注意：系統會忽略送貨車的 `name` 欄位。不得設定所有其他運輸車輛欄位；否則會傳回錯誤。

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` (不得為 `UNAVAILABLE` 或 `SCHEDULED_STOP` 工作設定，但所有其他工作類型都必須設定) `planned_location` (`UNAVAILABLE` 項工作的選用步驟) `task_duration` 注意：系統會忽略 Task 的 `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` 呼叫 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` 透過呼叫 SDK 的 Android 裝置製造商，僅適用於 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 的路線，確保這個欄位的消費者在目前運輸車輛路徑上取得最準確的資訊。
`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_value` 和 `value` 皆已設定，兩者必須相同，否則系統會擲回錯誤。這兩個欄位都會填入回應。
`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` 僅限輸入。此位置首次傳送至伺服器後經過的時間 (以秒為單位)。如果是第一次更新，這個值會是零。如果時間不明 (例如應用程式重新啟動)，這個值會重設為零。
`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 或 WiFi 存取點。
`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` 在所有頁面中，符合要求條件的運送車輛總數。

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` 選用設定。要傳回的工作數量上限。服務傳回的產品數量可能會少於這個值。如果未指定這個值，伺服器會決定要傳回的結果數量。
`page_token`	`string` 選用設定。接收自前一個 `ListTasks` 呼叫的網頁權杖。您可以提供此項目來擷取後續網頁。進行分頁時，提供至 `ListTasks` 的所有其他參數須與提供網頁權杖的呼叫相符。
`filter`	`string` 選用設定。列出工作時要套用的篩選器查詢。如需篩選器語法範例，請參閱 http://aip.dev/160。如未指定值，或篩選空白字串，則會傳回所有 Tasks。如需可供篩選的工作屬性相關資訊，請參閱「列出工作」。

ListTasksResponse

ListTasks 回應，包含一組符合 ListTasksRequest 中篩選條件的 Tasks。

欄位

欄位
`tasks[]`	`Task` 符合所要求篩選條件的 Tasks 組合。如未指定篩選器，要求會傳回所有工作。成功的回應也可以空白。如果回應空白，表示找不到符合要求的篩選條件的 Tasks。
`next_page_token`	`string` 在 `ListTasksRequest` 中傳遞這個權杖，即可繼續列出結果。如果傳回所有結果，則這個欄位會是空白字串，否則不會出現在回應中。
`total_size`	`int64` 在所有網頁中，符合要求條件的工作總數。

tasks[]

Task

符合所要求篩選條件的 Tasks 組合。如未指定篩選器，要求會傳回所有工作。成功的回應也可以空白。如果回應空白，表示找不到符合要求的篩選條件的 Tasks。

next_page_token

string

在 ListTasksRequest 中傳遞這個權杖，即可繼續列出結果。如果傳回所有結果，則這個欄位會是空白字串，否則不會出現在回應中。

total_size

int64

在所有網頁中，符合要求條件的工作總數。

地點資訊

含有其他 ID 的地點。

欄位

欄位
`point`	`LatLng` 位置的座標。

point

LatLng

位置的座標。

工作

Delivery API 中的工作代表要追蹤的單一動作。一般而言，運送相關工作和中斷工作之間存在差異。同一則運送資訊可以有多個相關聯的工作。例如，一個上車和下車/轉乘的任務，此外，特定配送服務適用的不同工作也可以由不同車輛處理。舉例來說，某輛車可能處理上車問題、將貨物運送至中樞裝置，另一輛車從集線推動到下車地點。

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

欄位
`name`	`string` 格式須為 `providers/{provider}/tasks/{task}`。
`type`	`Type` 必要欄位。不可變動。定義 Task 的類型。例如休息或出貨等。
`state`	`State` 必要欄位。工作目前的執行狀態。
`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，避免使用複雜的對應。您無法為 `UNAVAILABLE` 和 `SCHEDULED_STOP` 類型的工作設定「`tracking_id`」。這類 ID 有下列限制：必須是有效的萬國碼 (Unicode) 字串。長度上限為 64 個半形字元。根據 Unicode 正規化表單 C 進行正規化。不可包含下列 ASCII 字元：/、「:」、「?」、「,」或「#」。
`delivery_vehicle_id`	`string` 僅供輸出。執行此工作的車輛 ID。貨車 ID 受到下列限制：必須是有效的萬國碼 (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` 指出能否將車輛的 lastLocation 對齊 `current_route_segment`。如果 `last_location` 或 `current_route_segment` 不存在，這個值會是 False。這個值由 Fleet Engine 計算。系統會忽略來自用戶端的更新。

remaining_vehicle_journey_segments[]

VehicleJourneySegment

針對受分配車輛完成這項任務前的停靠站，追蹤相關資訊。請注意，這份清單可能含有其他工作的停靠站。

第一個路段 Task.journey_sharing_info.remaining_vehicle_journey_segments[0] (gRPC) 或 Task.journeySharingInfo.remainingVehicleJourneySegments[0] (REST) 包含從駕駛員最後已知位置到下一個 VehicleStop 的路線資訊。目前的路線資訊通常來自駕駛應用程式，但 DeliveryVehicle.current_route_segment 說明文件中註明的部分情況除外。Task.journey_sharing_info.remaining_vehicle_journey_segments (gRPC) 或 Task.journeySharingInfo.remainingVehicleJourneySegments (REST) 中的其他區隔會由 Fleet Engine 填入。它們會提供其餘 VehicleStops 之間的路線資訊。

last_location

DeliveryVehicleLocation

用於指出車輛上車上次回報的位置。

last_location_snappable

bool

指出能否將車輛的 lastLocation 對齊 current_route_segment。如果 last_location 或 current_route_segment 不存在，這個值會是 False。這個值由 Fleet Engine 計算。系統會忽略來自用戶端的更新。

州

工作的狀態。這表示 Tasks 的進度。

列舉
`STATE_UNSPECIFIED`	預設。用於未指定或無法辨識的工作狀態。
`OPEN`	工作可能尚未指派給送貨車輛，或是車輛尚未經過 `Task` 指派的車輛停靠站。
`CLOSED`	車輛通過車輛停靠站執行這項任務時。

TaskOutcome

嘗試執行工作的結果。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`	預設值是未知的任務類型。
`PICKUP`	取貨工作是指從客戶取貨時採取的行動。Depot 或 Feeder 車輛上車時應使用 `SCHEDULED_STOP` 類型。
`DELIVERY`	「運送工作」是指出貨給消費者時採取的行動。Depot 或饋送器下車地點應使用 `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 與多個 Tasks 相關聯，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_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` 如果剩餘停靠站計數 <= left_stop_count_threshold，使用者可以看見這個資料元素。
`duration_until_estimated_arrival_time_threshold`	`Duration` 如果抵達停靠站的預計到達時間 <= time_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` 必要欄位。時間範圍的結束時間 (含)。

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 將工作狀態設為「已關閉」。而是應從運送車輛中移除包含 Task 的 VehicleStop，以便自動將工作狀態設為「CLOSED」。

update_mask

FieldMask

必要欄位。欄位遮罩，指出要更新的工作欄位。注意：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` 中的位置可能與這個位置不一定完全一致，但會與該地點的一小段距離內。這個欄位不會填入 `GetTask` 呼叫的回應。
`tasks[]`	`TaskInfo` 要在這個停靠站執行的 `Task` 清單。這個欄位不會填入 `GetTask` 呼叫的回應。
`state`	`State` `VehicleStop` 的狀態。這個欄位不會填入 `GetTask` 呼叫的回應。

planned_location

LocationInfo

必要欄位。停靠站的位置。請注意，Task 中的位置可能與這個位置不一定完全一致，但會與該地點的一小段距離內。這個欄位不會填入 GetTask 呼叫的回應。

tasks[]

TaskInfo

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

state

State

VehicleStop 的狀態。這個欄位不會填入 GetTask 呼叫的回應。

州

VehicleStop 的目前狀態。

列舉
`STATE_UNSPECIFIED`	未知。
`NEW`	已建立，但未主動轉送。
`ENROUTE`	指派並主動轉送。
`ARRIVED`	已抵達停靠點。假設車輛正在前往下一個停靠站時，所有先前的停靠站都已完成。

TaskInfo

在這個停靠點執行的工作的其他相關資訊。

欄位

欄位
`task_id`	`string` 工作 ID。這個欄位不會填入 `GetTask` 呼叫的回應。工作 ID 有下列限制：必須是有效的萬國碼 (Unicode) 字串。長度上限為 64 個半形字元。根據 Unicode 正規化表單 C 進行正規化。不可包含下列 ASCII 字元：/、「:」、「?」、「,」或「#」。
`task_duration`	`Duration` 僅供輸出。執行工作所需的時間。
`target_time_window`	`TimeWindow` 僅供輸出。完成工作的時間範圍。這只會在對 `GetDeliveryVehicle` 的回應中設定。

task_id

string

工作 ID。這個欄位不會填入 GetTask 呼叫的回應。工作 ID 有下列限制：

必須是有效的萬國碼 (Unicode) 字串。
長度上限為 64 個半形字元。
根據 Unicode 正規化表單 C 進行正規化。
不可包含下列 ASCII 字元：/、「:」、「?」、「,」或「#」。

task_duration

Duration

僅供輸出。執行工作所需的時間。

target_time_window

TimeWindow

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