索引
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
(メッセージ)SearchTasksRequest
(メッセージ)(非推奨)SearchTasksResponse
(メッセージ)(非推奨)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 |
---|
新しい |
CreateDeliveryVehicle |
---|
新しい |
CreateTask |
---|
新しい |
GetDeliveryVehicle |
---|
指定された |
GetTask |
---|
|
GetTaskTrackingInfo |
---|
指定された |
ListDeliveryVehicles |
---|
指定したフィルタ条件を満たすすべての |
ListTasks |
---|
指定したフィルタ条件を満たすすべての |
SearchTasks |
---|
非推奨: 代わりに |
UpdateDeliveryVehicle |
---|
更新された |
UpdateTask |
---|
|
BatchCreateTasksRequest
BatchCreateTask
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。注: このフィールドを設定する場合、 |
parent |
必須。すべてのタスクで共有される親リソース。この値は |
requests[] |
必須。作成するリソースを指定するリクエスト メッセージ。注: 1 つのバッチに作成できるタスクは 500 個までです。 |
BatchCreateTasksResponse
BatchCreateTask
レスポンス メッセージ。
フィールド | |
---|---|
tasks[] |
作成されたタスク。 |
CreateDeliveryVehicleRequest
CreateDeliveryVehicle
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
parent |
必須。 |
delivery_vehicle_id |
必須。配達車両 ID は一意でなければならず、次の制限が適用されます。
|
delivery_vehicle |
必須。作成する
注: DeliveryVehicle の |
CreateTaskRequest
CreateTask
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
parent |
必須。 |
task_id |
必須。タスク ID は一意である必要がありますが、配送追跡 ID は使用できません。配送追跡 ID を保存するには、
|
task |
必須。作成する Task エンティティ。タスクを作成する場合、次のフィールドが必要です。
注: タスクの |
DeliveryRequestHeader
RequestHeader には、すべての Delivery RPC リクエストに共通するフィールドが含まれます。
フィールド | |
---|---|
language_code |
en-US や sr-Latn などの BCP-47 言語コード。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier を参照してください。指定しない場合、レスポンスは任意の言語で作成できます。そのような名前が存在する場合は、英語が優先されます。フィールド値の例: |
region_code |
必須。リクエスト送信元のリージョンの CLDR リージョン コード。フィールド値の例: |
sdk_version |
呼び出し元の SDK のバージョン(該当する場合)。バージョンの形式は「major.minor.patch」です(例: |
os_version |
呼び出し元の SDK が実行されているオペレーティング システムのバージョン。フィールド値の例: |
device_model |
呼び出し元の SDK が実行されているデバイスのモデル。フィールド値の例: |
sdk_type |
リクエストを送信する SDK のタイプ。 |
maps_sdk_version |
呼び出し元の SDK が依存している MapSDK のバージョン(該当する場合)。バージョンの形式は「major.minor.patch」です(例: |
nav_sdk_version |
呼び出し元 SDK が依存する NavSDK のバージョン(該当する場合)。バージョンの形式は「major.minor.patch」です(例: |
platform |
呼び出し元 SDK のプラットフォーム。 |
manufacturer |
呼び出し元 SDK の Android デバイスのメーカー。Android SDK にのみ適用されます。フィールド値の例: |
android_api_level |
呼び出し元 SDK の Android API レベル。Android SDK にのみ適用されます。フィールド値の例: |
trace_id |
オプションの 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 API と REST API では、異なるフィールド命名規則を使用します。たとえば、gRPC API の DeliveryVehicle.current_route_segment
フィールドと REST API の DeliveryVehicle.currentRouteSegment
フィールドは、同じフィールドを指します。
フィールド | |
---|---|
name |
この配達車両の一意の名前。形式は |
last_location |
最後に報告された配達車両の場所。 |
navigation_status |
配達用車両のナビゲーション ステータス。 |
current_route_segment |
ナビゲーションが次の地点に進むことを推奨するルートを指定する、エンコードされたポリライン。停車地に到着または通過したとき、およびナビゲーションのルートが変更されたときに、ドライバー アプリがこの情報を更新します。これらの 場合によっては、このフィールドが
このような場合、Fleet Engine は、最後に渡された VehicleStop から次の VehicleStop までのルートをこのフィールドに入力し、このフィールドの利用者に配達車両の現在の経路について利用可能な最善の情報を提供します。 |
current_route_segment_end_point |
|
remaining_distance_meters |
|
remaining_duration |
|
remaining_vehicle_journey_segments[] |
車両の直近に報告された場所から始まる、この配達車両に割り当てられた行程セグメント。このフィールドは、 |
attributes[] |
カスタムの配達車両属性のリスト。配達用車両には最大 100 個の属性を登録でき、各属性には一意のキーが必要です。 |
type |
この配送車両のタイプ。設定しない場合、デフォルトは |
DeliveryVehicleType
配送車両のタイプ。
列挙型 | |
---|---|
DELIVERY_VEHICLE_TYPE_UNSPECIFIED |
この値は使用されていません。 |
AUTO |
自動車。 |
TWO_WHEELER |
オートバイ、原動機付自転車、その他の二輪車 |
BICYCLE |
人間による輸送。 |
PEDESTRIAN |
通常は歩いたり走ったりする、歩行者専用の通路を歩く人間のトランスポーター。 |
DeliveryVehicleAttribute
車両属性を Key-Value ペアとして記述します。「key:value」文字列の長さは 256 文字以内にしてください。
フィールド | |
---|---|
key |
属性のキー。 |
value |
属性の値。 |
共用体フィールド delivery_vehicle_attribute_value 。属性の値には、string、bool、double 型を指定できます。delivery_vehicle_attribute_value は次のいずれかになります。 |
|
string_value |
文字列型の属性値。 注: これは、最終的にサポートが終了する |
bool_value |
ブール値型の属性値。 |
number_value |
二重型属性値。 |
DeliveryVehicleLocation
ある時点における車両の位置、速度、方角。
フィールド | |
---|---|
location |
車両の位置。Fleet Engine に送信された場合、車両の位置は GPS 位置情報となります。レスポンスで受信された車両の位置は、GPS 位置、補足位置、その他の推定位置のいずれかになります。ソースは |
horizontal_accuracy |
非推奨: 代わりに |
latlng_accuracy |
|
heading |
車両の移動方向(度単位)。0 は北を表します。有効な範囲は [0,360] です。 |
bearing_accuracy |
非推奨: 代わりに |
heading_accuracy |
|
altitude |
WGS84 からの高度(メートル単位)。 |
vertical_accuracy |
非推奨: 代わりに |
altitude_accuracy |
|
speed_kmph |
車両の速度(km/時)。非推奨: 代わりに |
speed |
車両の速度(メートル/秒) |
speed_accuracy |
|
update_time |
センサーのクロックに基づき、センサーが |
server_time |
出力専用。サーバーが位置情報を受信した時刻。 |
location_sensor |
位置情報のプロバイダ( |
is_road_snapped |
|
is_gps_sensor_enabled |
入力のみ。モバイル デバイスで GPS センサーが有効になっているかどうかを示します。 |
time_since_update |
入力のみ。この場所が最初にサーバーに送信されてからの時間(秒)。最初の更新ではゼロになります。時刻が不明な場合(アプリが再起動された場合など)、この値はゼロにリセットされます。 |
num_stale_updates |
入力のみ。非推奨: 位置情報が古くなっているかどうかを判断するために、他のシグナルが使用されるようになりました。 |
raw_location |
未加工の車両の位置情報(ロード スナッパーで処理されていない)。 |
raw_location_time |
元の場所に関連付けられたタイムスタンプ。 |
raw_location_sensor |
未加工の場所のソース。デフォルトは |
raw_location_accuracy |
半径で表した |
supplemental_location |
統合するアプリによって提供される補助的な位置情報。 |
supplemental_location_time |
補助的な場所に関連付けられたタイムスタンプ。 |
supplemental_location_sensor |
補助的な場所のソース。デフォルトは |
supplemental_location_accuracy |
半径で表した |
road_snapped |
非推奨: 代わりに |
DeliveryVehicleLocationSensor
位置の特定に使用されるセンサーまたは方法。
列挙型 | |
---|---|
UNKNOWN_SENSOR |
センサーが指定されていないか不明です。 |
GPS |
GPS または Assisted GPS です。 |
NETWORK |
アシスト GPS、基地局 ID、または Wi-Fi アクセス ポイント。 |
PASSIVE |
基地局 ID または Wi-Fi アクセス ポイント。 |
ROAD_SNAPPED_LOCATION_PROVIDER |
道路の位置としてモバイル デバイスにより最も可能性が高いと判断される場所です。 |
CUSTOMER_SUPPLIED_LOCATION |
独立したソースから顧客指定のビジネス情報。通常、この値は Driver SDK を実行しているモバイル デバイス以外のソースから提供される場所に使用されます。元のソースが他の列挙型の値のいずれかで記述されている場合は、その値を使用します。CUSTOMER_SUPPLIED_LOCATION とマークされた場所は、通常 DeliveryVehicle の last_location.supplemental_location_sensor によって指定されます。 |
FLEET_ENGINE_LOCATION |
利用可能なシグナルに基づいて Fleet Engine が計算したロケーション。出力専用。この値はリクエストで受信されると拒否されます。 |
FUSED_LOCATION_PROVIDER |
Android の Fused Location Provider |
CORE_LOCATION |
Apple オペレーティング システム上の位置情報プロバイダ。 |
GetDeliveryVehicleRequest
GetDeliveryVehicle
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
name |
必須。 |
GetTaskRequest
GetTask
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
name |
必須。 |
GetTaskTrackingInfoRequest
GetTaskTrackingInfoRequest
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
name |
必須。 |
ListDeliveryVehiclesRequest
ListDeliveryVehicles
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
parent |
必須。 |
page_size |
省略可。返却する車両の最大数。サービスは、この数よりも少ない数を返すことがあります。この数を指定しない場合、返される結果の数はサーバーが決定します。 |
page_token |
省略可。前回の ページ分割を行う場合、 |
filter |
省略可。配達車両を一覧表示するときに適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。値を指定しない場合、またはフィルタに空の文字列を指定した場合は、すべての配達車両が返されます。 なお、 フィルタクエリで許容される制限の最大数は 50 です。制限は、 |
viewport |
省略可。返される車両を、最後に確認された場所がビューポートによって定義された長方形の領域内にあった車両に限定するフィルタ。 |
ListDeliveryVehiclesResponse
ListDeliveryVehicles
レスポンス メッセージ。
フィールド | |
---|---|
delivery_vehicles[] |
リクエストされたフィルタ条件を満たす配送車両のセット。フィルタが指定されていない場合、リクエストはすべての配達車両を返します。正常なレスポンスは空にすることもできます。空のレスポンスは、リクエストされたフィルタ条件を満たす配送車両が見つからなかったことを示します。 |
next_page_token |
このトークンを |
total_size |
すべてのページにおける、リクエストの条件に一致する配達車両の合計数。 |
ListTasksRequest
ListTasks
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
parent |
必須。 |
page_size |
省略可。返されるタスクの最大数。サービスはこの値より少ない値を返すことがあります。この値を指定しない場合、返される結果の数はサーバーが決定します。 |
page_token |
省略可。前回の ページ分割を行う場合、 |
filter |
省略可。タスクを一覧表示するときに適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。値を指定しない場合、または空の文字列でフィルタした場合は、すべてのタスクが返されます。フィルタできるタスク プロパティの詳細については、タスクの一覧表示をご覧ください。 |
ListTasksResponse
ListTasksRequest
のフィルタ条件を満たすタスクのセットを含む ListTasks
レスポンス。
フィールド | |
---|---|
tasks[] |
リクエストされたフィルタ条件を満たすタスクのセット。フィルタが指定されていない場合、リクエストはすべてのタスクを返します。正常なレスポンスは空にすることもできます。空のレスポンスは、リクエストされたフィルタ条件に一致するタスクが見つからなかったことを示します。 |
next_page_token |
結果の一覧表示を続行するには、このトークンを |
total_size |
すべてのページにおける、リクエスト条件に一致するタスクの合計数。 |
LocationInfo
追加の識別子を含むビジネス。
フィールド | |
---|---|
point |
場所の座標。 |
SearchTasksRequest
非推奨: 代わりに GetTaskTrackingInfo
に GetTaskTrackingInfoRequest
を発行しました。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
parent |
必須。 |
tracking_id |
必須。リクエストされている一連の関連タスクの識別子。トラッキング ID には次の制限があります。
|
page_size |
省略可。返されるタスクの最大数。サービスはこの値より少ない値を返すことがあります。この値を指定しない場合、返される結果の数はサーバーが決定します。 |
page_token |
省略可。前回の ページ分割を行う場合、 |
SearchTasksResponse
SearchTasks
レスポンス。SearchTasksRequest
内の検索条件に一致するタスクのセットが含まれます。
フィールド | |
---|---|
tasks[] |
リクエストされた |
next_page_token |
結果の一覧表示を続行するには、このトークンを |
タスク
Delivery API のタスクは、追跡する単一のアクションを表します。一般に、配送関連のタスクと分割タスクは区別されます。配送には複数のタスクを関連付けることができます。たとえば、集荷に関する Task と、降車または乗り換えに関する Task を 1 つずつ設定することができます。また、特定の配送の異なるタスクは、異なる車両で処理できます。たとえば、ある車両で集荷を処理してハブまで荷物を運び、別の車両で同じハブから降車場所まで荷物を運ぶことができます。
注: gRPC API と REST API では、異なるフィールド命名規則を使用します。たとえば、gRPC API の Task.journey_sharing_info
フィールドと REST API の Task.journeySharingInfo
フィールドは、同じフィールドを指します。
フィールド | |
---|---|
name |
|
type |
必須。変更不可。Task のタイプを定義します。(破損、発送など)。 |
state |
必須。タスクの現在の実行状態。 |
task_outcome |
タスクの結果。 |
task_outcome_time |
|
task_outcome_location |
|
task_outcome_location_source |
|
tracking_id |
変更不可。このフィールドを使用すると ID を簡単に保存できるため、複雑なマッピングを使用する必要がなくなります。
|
delivery_vehicle_id |
出力専用。このタスクを実行する車両の ID。配送車両 ID には次の制限があります。
|
planned_location |
変更不可。タスクを完了する場所。 |
task_duration |
必須。変更不可。この場所でタスクを実行するのに必要な時間。 |
target_time_window |
タスクが完了するまでの時間枠。 |
journey_sharing_info |
出力専用。移動経路の共有固有のフィールド。状態が |
task_tracking_view_config |
どのような状況でエンドユーザーに表示されるデータ要素を指定するタスク追跡の構成。 |
attributes[] |
カスタムタスク属性のリスト。各属性には一意のキーが必要です。 |
JourneySharingInfo
特定のフィールドを共有するジャーニー。
フィールド | |
---|---|
remaining_vehicle_journey_segments[] |
割り当てられた車両がこのタスクを完了する前に行った停車地の追跡情報。このリストには、他のタスクの停車地を含めることができます。 最初のセグメントである |
last_location |
割り当てられた車両について車両が最後に報告された場所を示します。 |
last_location_snappable |
車両の lastLocation を |
状態
タスクの状態。タスクの進行状況を示します。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
デフォルト。未指定または認識されないタスク状態に使用されます。 |
OPEN |
タスクがまだ配達車両に割り当てられていないか、配達車両が Task に割り当てられた車両停車地をまだ通過していません。 |
CLOSED |
このタスクの車両が停車地を通過したとき。 |
TaskOutcome
タスクの実行を試みた結果。TaskState
が閉じられた場合、TaskOutcome
は正常に完了したかどうかを示します。
列挙型 | |
---|---|
TASK_OUTCOME_UNSPECIFIED |
タスクの結果(値を設定する前の結果)。 |
SUCCEEDED |
タスクは正常に完了しました。 |
FAILED |
タスクを完了できなかったか、タスクがキャンセルされました。 |
TaskOutcomeLocationSource
task_outcome_location
にデータを入力したソースの ID。
列挙型 | |
---|---|
TASK_OUTCOME_LOCATION_SOURCE_UNSPECIFIED |
設定前のタスクの結果。 |
PROVIDER |
プロバイダが task_outcome_location を指定しています。 |
LAST_VEHICLE_LOCATION |
プロバイダが task_outcome_location を指定しなかったため、Fleet Engine は直近の車両位置情報を使用しました。 |
タイプ
タスクのタイプ。
列挙型 | |
---|---|
TYPE_UNSPECIFIED |
デフォルトでは、タスクの種類は不明です。 |
PICKUP |
集荷タスクとは、お客様から荷物を受け取るために行われるアクションです。車庫またはフィーダーの車両ピックアップには、SCHEDULED_STOP タイプを使用する必要があります。 |
DELIVERY |
配達タスクとは、最終顧客に荷物を配達するために行われるアクションです。車両販売店またはフィーダー車両の持ち込みには、SCHEDULED_STOP タイプを使用する必要があります。 |
SCHEDULED_STOP |
スケジュールされた停止タスクは、計画の目的で使用されます。たとえば、フィーダー車両や倉庫での荷物の集荷または持ち込みなどが考えられます。エンドユーザーに集荷または持ち込む配送には使用しないでください。 |
UNAVAILABLE |
車両が運行されていないことを意味するタスク。たとえば、ドライバーが休憩をとったときや、車両に給油しているときに発生することがあります。 |
TaskAttribute
タスク属性を Key-Value ペアとして記述します。「key:value」文字列の長さは 256 文字以内にしてください。
フィールド | |
---|---|
key |
属性のキー。キーにコロン(:)を含めることはできません。 |
共用体フィールド task_attribute_value 。属性の値には、string、bool、double 型を指定できます。設定されていない場合、TaskAttribute の string_value は空の文字列 "" として保存されます。task_attribute_value には次のいずれか 1 つのみを指定できます。 |
|
string_value |
文字列型の属性値。 |
bool_value |
ブール値型の属性値。 |
number_value |
二重型属性値。 |
TaskTrackingInfo
TaskTrackingInfo
メッセージ。このメッセージには、表示に使用されるタスク追跡情報が含まれています。トラッキング ID が複数のタスクに関連付けられている場合、Fleet Engine はヒューリスティックを使用して、選択するタスクの TaskTrackingInfo を決定します。
フィールド | |
---|---|
name |
|
tracking_id |
変更不可。タスクのトラッキング ID。* 有効な Unicode 文字列を指定する必要があります。* 最大長は 64 文字です。* Unicode 正規化フォーム C に従って正規化されています。* ASCII 文字「/」、「:」、「?」、「,」、「#」を含めることはできません。 |
vehicle_location |
車両の最終場所。 |
route_polyline_points[] |
接続時に、このタスクの地点までの車両の予想ルートのポリラインを形成するポイントのリスト。 |
remaining_stop_count |
タスクストップ(タスクストップを含む)に到達するまでに車両が残っている停車地の数を示します。たとえば、車両の次の停車場所がタスクストップの場合、値は 1 になります。 |
remaining_driving_distance_meters |
対象の |
estimated_arrival_time |
停車場所への到着予定時刻を示すタイムスタンプ。 |
estimated_task_completion_time |
タスクの推定完了時間を示すタイムスタンプ。 |
state |
タスクの現在の実行状態。 |
task_outcome |
タスクの実行を試みた結果。 |
task_outcome_time |
タスクの結果がプロバイダによって設定された時刻を示すタイムスタンプ。 |
planned_location |
変更不可。タスクを完了する場所。 |
target_time_window |
タスクが完了するまでの時間枠。 |
attributes[] |
タスクに設定されたカスタム属性。 |
TaskTrackingViewConfig
タスクのデータ要素をエンドユーザーにいつ表示すべきかを定義する構成メッセージ。
フィールド | |
---|---|
route_polyline_points_visibility |
ルートのポリライン ポイントを表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
estimated_arrival_time_visibility |
到着予定時刻を表示できるタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
estimated_task_completion_time_visibility |
タスクの推定完了時間を表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
remaining_driving_distance_visibility |
残りの運転距離を表示できるタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
remaining_stop_count_visibility |
残りの経由地数を表示するタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
vehicle_location_visibility |
車両の位置情報を表示できるタイミングを指定するフィールド。このフィールドが指定されていない場合、このデータに対するプロジェクト レベルのデフォルトの公開設定が使用されます。 |
VisibilityOption
データ要素をいつエンドユーザーに表示するかを定義するオプション メッセージ。
フィールド | |
---|---|
共用体フィールド visibility_option 。選択した特定の公開設定オプション。visibility_option は次のいずれかになります。 |
|
remaining_stop_count_threshold |
このデータ要素は、残りの駅 / 停留所の数が残りの駅 / 停留所のカウントの基準値以下である場合に、エンドユーザーに表示されます。 |
duration_until_estimated_arrival_time_threshold |
このデータ要素は、停車地の到着予定時刻が duration_until_estimated_arrival_time_threshold 以下の場合にエンドユーザーに表示されます。 |
remaining_driving_distance_meters_threshold |
このデータ要素は、残りの運転距離がメートル単位 <= percentage_driving_distance_meters_threshold 以下の場合、エンドユーザーに表示されます。 |
always |
true に設定すると、このデータ要素は常にしきい値なしでエンドユーザーに表示されます。このフィールドを false に設定することはできません。 |
never |
true に設定すると、しきい値のないエンドユーザーに対して、このデータ要素が常に非表示になります。このフィールドを false に設定することはできません。 |
TimeWindow
期間。
フィールド | |
---|---|
start_time |
必須。時間枠の開始時間(その時間を含む)。 |
end_time |
必須。時間枠の終了時間(その時間を含む)。 |
UpdateDeliveryVehicleRequest
UpdateDeliveryVehicle
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
delivery_vehicle |
必須。適用する |
update_mask |
必須。更新する これは、フィールドの完全修飾名のカンマ区切りリストです。例: |
UpdateTaskRequest
UpdateTask
リクエスト メッセージ。
フィールド | |
---|---|
header |
省略可。標準の Delivery API リクエスト ヘッダー。 |
task |
必須。更新に関連付けられたタスク。Fleet Engine によって維持されるフィールドは次のとおりです。
注: タスクが配送車両に割り当てられている場合は、 |
update_mask |
必須。更新するタスク フィールドを示すフィールド マスク。注: これは、フィールドの完全修飾名のカンマ区切りリストです。例: |
VehicleJourneySegment
車両の移動セグメント(前の停車地から現在の停車地までの区間)を表します。最初の停車地の場合は、車両の現在地からこの停車地までです。
フィールド | |
---|---|
stop |
停車地の位置と、その停車地に関連付けられている |
driving_distance_meters |
出力専用。前の停車地からこの停車地までの移動距離。現在の駅 / 停留所が行程セグメントのリストの最初の駅 / 停留所の場合、始点は、この駅 / 停留所がリストに追加された時点で記録された車両の位置になります。このジャーニー セグメントが |
driving_duration |
出力専用。前の停車地からこの停車地までの移動時間。現在の駅 / 停留所が乗車区間のリストで最初の駅 / 停留所である場合、始点は、この駅 / 停留所がリストに追加された時点で記録された車両の位置になります。 このフィールドがパス |
path[] |
出力専用。前の停車地からこの停車地までの経路。現在の駅 / 停留所が乗車区間のリストで最初の駅 / 停留所の場合は、車両の現在地からその駅 / 停留所がリストに追加された時点でのこの駅 / 停留所までの経路になります。このジャーニー セグメントが このフィールドがパス |
VehicleStop
車両が 1 つ以上の Task
を実行するために停止するポイントを記述します。
フィールド | |
---|---|
planned_location |
必須。停車地の場所。 |
tasks[] |
この駅 / 停留所で実行される |
state |
|
状態
VehicleStop
の現在の状態。
列挙型 | |
---|---|
STATE_UNSPECIFIED |
不明 |
NEW |
作成されましたが、実際にルーティングされていません。 |
ENROUTE |
割り当てられ、アクティブにルーティングされています。 |
ARRIVED |
駅 / 停留所に到着しました。車両が次の停車地に向かう途中で、前の停車地がすべて完了していると想定します。 |
TaskInfo
この停車地で実行されたタスクに関する追加情報。
フィールド | |
---|---|
task_id |
タスク ID。このフィールドは、
|
task_duration |
出力専用。タスクの実行に必要な時間。 |
target_time_window |
出力専用。タスクが完了するまでの時間枠。これは |