本頁面由 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

The Last Mile Delivery 服務。

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 Normalization Form C 進行正規化。不可包含下列 ASCII 字元：/、「:」、「?」、「,」或「#」。
`delivery_vehicle`	`DeliveryVehicle` 必要欄位。要建立的 `DeliveryVehicle` 實體。建立新的提交媒介時，您可以設定下列選用欄位：類型 last_location 屬性注意：系統會忽略 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 Normalization Form 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 為 Driver。
`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_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 或 Wi-Fi 存取點。
`PASSIVE`	行動通信基地台 ID 或 Wi-Fi 存取點。
`ROAD_SNAPPED_LOCATION_PROVIDER`	行動裝置判斷最有可能的路面位置。
`CUSTOMER_SUPPLIED_LOCATION`	客戶提供的獨立來源位置。一般而言，這個值用於來源不是執行驅動程式 SDK 的行動裝置。如果原始來源是由其他列舉值描述，請使用該值。標示為 CUSTOMER_SUPPLIED_LOCATION 的位置通常會透過 DeliveryVehicle 的 `last_location.supplemental_location_sensor` 提供。
`FLEET_ENGINE_LOCATION`	由 Fleet Engine 根據可用信號計算出的地點。僅供輸出。如果要求中收到這個值，系統會拒絕。
`FUSED_LOCATION_PROVIDER`	Android 的整合式位置預測提供工具。
`CORE_LOCATION`	Apple 作業系統上的地點資訊供應器。

DeliveryVehicleNavigationStatus

車輛的導航狀態。

列舉
`UNKNOWN_NAVIGATION_STATUS`	未指定的導覽狀態。
`NO_GUIDANCE`	Driver 應用程式的導航功能處於 `FREE_NAV` 模式。
`ENROUTE_TO_DESTINATION`	即時路線導航功能可供使用，且 Driver 應用程式導航功能已進入 `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` 選用設定。要傳回的 Task 數量上限。服務傳回的產品數量可能會少於這個值。如果未指定這個值，伺服器會決定要傳回的結果數量。
`page_token`	`string` 選用設定。從先前 `ListTasks` 呼叫收到的網頁權杖。您可以提供此項目來擷取後續網頁。進行分頁時，提供至 `ListTasks` 的所有其他參數須與提供網頁權杖的呼叫相符。
`filter`	`string` 選用設定。在列出工作時要套用的篩選器查詢。如需篩選器語法的範例，請參閱 http://aip.dev/160。如果您未指定值，或篩選空白字串，系統會傳回所有 Task。如需可供篩選的工作屬性相關資訊，請參閱「列出工作」。

ListTasksResponse

ListTasks 回應，其中包含符合 ListTasksRequest 中篩選條件的任務組合。

欄位

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

tasks[]

Task

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

next_page_token

string

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

total_size

int64

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

地點資訊

含有任何其他 ID 的位置。

欄位

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

point

LatLng

位置座標。

工作

Delivery API 中的工作代表要追蹤的單一動作。一般來說，出貨相關工作和休息時間工作有所區別。一個出貨單可以與多個工作相關聯。舉例來說，您可以為上車地點建立一個 Task，為下車地點或轉乘地點建立另一個 Task。此外，特定運送任務可由不同的車輛處理。舉例來說，一輛車輛可以負責接送，將貨物開到集散地，而另一輛車輛則將同樣的貨物從集散地開到送達地點。

注意：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 Normalization Form 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 計算。系統會忽略來自用戶端的更新。

州

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

列舉
`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 使用最後已知車輛位置。

類型

工作類型。

列舉
`TYPE_UNSPECIFIED`	預設的 Task 類型為不明。
`PICKUP`	取貨工作是指從客戶取貨時採取的行動。Depot 或 Feeder 車輛上車時應使用 `SCHEDULED_STOP` 類型。
`DELIVERY`	運送工作是指將貨物送交給最終消費者的動作。Depot 或 Feeder 車輛下車地點應使用 `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 Normalization Form 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` 如果抵達停靠站的預計到達時間 <= time_until_estimated_arrival_time_threshold，使用者可以看見這個資料元素。
`remaining_driving_distance_meters_threshold`	`int32` 如果剩餘行駛距離 (以公尺為單位) 小於 remaining_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 將工作狀態設為「已關閉」。請改為從提交媒介中移除包含工作項的 VehicleStop，系統會自動將工作項狀態設為「已關閉」。

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 的其他資訊。

欄位

欄位
`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 時設定。