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
rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse) 新しい Task オブジェクトのバッチを作成して返します。

CreateDeliveryVehicle
rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle) 新しい DeliveryVehicle を作成して返します。

CreateTask
rpc CreateTask(CreateTaskRequest) returns (Task) 新しい Task オブジェクトを作成して返します。

GetDeliveryVehicle
rpc GetDeliveryVehicle(GetDeliveryVehicleRequest) returns (DeliveryVehicle) 指定された DeliveryVehicle インスタンスを返します。

GetTask
rpc GetTask(GetTaskRequest) returns (Task) Task に関する情報を取得します。

GetTaskTrackingInfo
rpc GetTaskTrackingInfo(GetTaskTrackingInfoRequest) returns (TaskTrackingInfo) 指定された TaskTrackingInfo インスタンスを返します。

ListDeliveryVehicles
rpc ListDeliveryVehicles(ListDeliveryVehiclesRequest) returns (ListDeliveryVehiclesResponse) 指定されたフィルタ条件を満たすすべての DeliveryVehicle を取得します。

ListTasks
rpc ListTasks(ListTasksRequest) returns (ListTasksResponse) 指定されたフィルタ条件を満たすすべての Task を取得します。

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle) 更新された DeliveryVehicle データを Fleet Engine に書き込み、Tasks を DeliveryVehicle に割り当てます。DeliveryVehicle の名前は更新できません。remaining_vehicle_journey_segments は更新できますが、DeliveryVehicle で保持するすべての VehicleJourneySegment が含まれている必要があります。task_id は remaining_vehicle_journey_segments から取得されます。対応する Tasks がまだ割り当てられていない場合は、DeliveryVehicle に割り当てられます。

UpdateTask
rpc UpdateTask(UpdateTaskRequest) returns (Task) Task のデータを更新します。

BatchCreateTasksRequest

BatchCreateTask リクエスト メッセージ。

フィールド
header	DeliveryRequestHeader 省略可。標準の Delivery API リクエスト ヘッダー。注: このフィールドを設定する場合、CreateTaskRequest メッセージのヘッダー フィールドは空にするか、このフィールドと一致する必要があります。
parent	string 必須。すべてのタスクで共有される親リソース。この値は providers/{provider} の形式にする必要があります。provider は Google Cloud プロジェクト ID にする必要があります。例: sample-cloud-project。CreateTaskRequest メッセージの親フィールドは、空にするか、このフィールドと一致する必要があります。
requests[]	CreateTaskRequest 必須。作成するリソースを指定するリクエスト メッセージ。注: 1 つのバッチで作成できるタスクは最大 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 エンティティ。新しい配送車両を作成する際は、次のオプション フィールドを設定できます。 type 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 正規化フォーム C に従って正規化されます。 ASCII 文字「/」、「:」、「?」、「」、「#」を含めることはできません。
task	Task 必須。作成する Task エンティティ。タスクを作成する場合、次のフィールドが必要です。 type state（OPEN に設定する必要があります） tracking_id（UNAVAILABLE タスクまたは SCHEDULED_STOP タスクには設定できませんが、他のすべてのタスクタイプでは必須です） planned_location（UNAVAILABLE 件のタスクの場合は省略可） task_duration 注: タスクの name フィールドは無視されます。その他の Task フィールドは設定できません。それ以外の場合は、エラーが返されます。

DeliveryRequestHeader

RequestHeader には、すべての Delivery RPC リクエストに共通するフィールドが含まれます。

フィールド
language_code	string en-US、sr-Latn などの BCP-47 言語コード。詳しくは、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 API と 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 ナビゲーションが推奨する次のウェイポイントへのルートを指定するエンコードされたポリライン。停車地に到着したときや停車地を過ぎたとき、またはルートが変更されたときに、ドライバー アプリがこの値を更新します。これらの LatLng は、車両に割り当てられたすべてのアクティブなタスクに対して Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path（gRPC）または Task.journeySharingInfo.remainingVehicleJourneySegments[0].path（REST）で返されます。 次のような場合、このフィールドが Task.journey_sharing_info.remaining_vehicle_journey_segments[0].path（gRPC）または Task.journeySharingInfo.remainingVehicleJourneySegments[0].path（REST）の入力に使用されないことがあります。 current_route_segment のエンドポイントが DeliveryVehicle.remaining_vehicle_journey_segments[0].stop（gRPC）または DeliveryVehicle.remainingVehicleJourneySegments[0].stop（REST）と一致していない。 ドライバアプリが位置情報を最近更新していないため、このフィールドの最終更新値が古くなっている可能性があります。 ドライバー アプリが位置情報を最近更新しましたが、current_route_segment は古く、以前の車両停留所を指しています。 このような場合、Fleet Engine はこのフィールドに直近に通過した 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 ペアとして記述します。「key:value」256 文字以内で指定してください。

フィールド
key	string 属性のキー。
value	string 属性の値。
共用体フィールド delivery_vehicle_attribute_value。属性の値。文字列、ブール値、ダブル型のいずれかになります。delivery_vehicle_attribute_value は次のいずれかになります。
string_value	string 文字列型の属性値。 注: これは、最終的にサポートが終了する value フィールドと同じです。create メソッドまたは update メソッドではどちらのフィールドも使用できますが、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	独立した情報源からの顧客指定のビジネス情報。通常、この値は Driver 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	ドライバー アプリのナビゲーションが FREE_NAV モードになっています。
ENROUTE_TO_DESTINATION	ターンバイターン方式のナビが利用可能になり、ドライバー アプリのナビゲーションが GUIDED_NAV モードになりました。
OFF_ROUTE	車両が提案されたルートを外れた。
ARRIVED_AT_DESTINATION	車両が目的地から約 50 m 以内にあること。

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 をご覧ください。値を指定しない場合、またはフィルタで空の文字列を指定した場合は、すべての配送車両が返されます。 ListDeliveryVehicles でサポートされているクエリは、車両属性（attributes.<key> = <value>、attributes.<key1> = <value1> AND attributes.<key2> = <value2> など）に関するものだけです。また、すべての属性は文字列として格納されるため、属性に対してサポートされている比較は文字列の比較のみです。数値やブール値と比較するには、値を文字列として扱うために明示的に引用符で囲む必要があります（例: attributes.<key> = "10"、attributes.<key> = "true"）。 1 つのフィルタクエリで許可される制限の最大数は 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 省略可。返されるタスクの最大数。サービスが返す値はこれよりも少ないことがあります。この値を指定しない場合、返される結果の数はサーバーが決定します。
page_token	string 省略可。前回の ListTasks 呼び出しから受け取ったページトークン。これを指定して、後続のページを取得できます。 ページ分割を行う場合、ListTasks に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。
filter	string 省略可。タスクを一覧表示するときに適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。値を指定しない場合、または空の文字列でフィルタする場合は、すべてのタスクが返されます。フィルタできるタスク プロパティについては、タスクの一覧表示をご覧ください。

ListTasksResponse

ListTasksRequest のフィルタ条件を満たすタスクのセットを含む ListTasks レスポンス。

フィールド
tasks[]	Task リクエストされたフィルタ条件を満たすタスクのセット。フィルタが指定されていない場合、リクエストはすべてのタスクを返します。成功のレスポンスは空にすることもできます。空のレスポンスは、リクエストされたフィルタ条件を満たすタスクが見つからなかったことを示します。
next_page_token	string 引き続き結果を一覧表示するには、このトークンを ListTasksRequest に渡します。すべての結果が返された場合、このフィールドは空の文字列か、レスポンスに表示されません。
total_size	int64 すべてのページでのリクエスト条件に一致するタスクの合計数。

LocationInfo

追加の識別子を含むビジネス。

フィールド
point	LatLng ビジネスの座標。

タスク

Delivery API のタスクは、追跡する 1 つのアクションを表します。一般的に、配送関連のタスクと中断タスクは区別されます。1 つの配送に複数のタスクを関連付けることができます。たとえば、タスクに対して「乗車」と「持ち込み」または「乗り換え」を 1 つずつ設定できます。また、配送ごとに異なるタスクを処理できる車両もあります。たとえば、ある車両が集荷を処理してハブへの荷物を運ぶ一方で、別の車両は同じ荷物をハブから持ち込み場所まで運ぶことができます。

注: gRPC API と REST API では、フィールド命名規則が異なります。たとえば、gRPC API の Task.journey_sharing_info フィールドと REST API の Task.journeySharingInfo フィールドは同じフィールドを参照します。

フィールド
name	string providers/{provider}/tasks/{task} の形式で指定してください。
type	Type 必須。変更不可。タスクのタイプを定義します。（例: 中断、発送）。
state	State 必須。タスクの現在の実行状態。
task_outcome	TaskOutcome タスクの結果。
task_outcome_time	Timestamp Task の結果がプロバイダによって設定された時点を示すタイムスタンプ。
task_outcome_location	LocationInfo Task の結果が設定されたロケーション。この値は UpdateTask の一部として更新されます。この値がプロバイダによって明示的に更新されない場合、Fleet Engine はデフォルトで最後に確認された車両の位置情報（未加工の位置情報）をデフォルトで入力します。
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 によって計算されます。クライアントからの更新は無視されます。

州

タスクの状態。タスクの進行状況を示します。

列挙型
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	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 正規化 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 このデータ要素は、残りの駅 / 停留所の停車回数が残り_stop_count_threshold の値以下の場合、エンドユーザーに表示されます。
duration_until_estimated_arrival_time_threshold	Duration このデータ要素は、停車地までの到着予定時刻が duration_until_estimated_arrival_time_threshold 以下の場合、エンドユーザーに表示されます。
remaining_driving_distance_meters_threshold	int32 このデータ要素は、残りの走行距離（メートル単位）が残り_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 には少なくとも 1 つのフィールドが必要です。 完全修飾フィールド名のカンマ区切りリスト。例: "remaining_vehicle_journey_segments"。

UpdateTaskRequest

UpdateTask リクエスト メッセージ。

フィールド
header	DeliveryRequestHeader 省略可。標準の Delivery API リクエスト ヘッダー。
task	Task 必須。更新に関連付けられているタスク。Fleet Engine によって管理されるフィールドは次のとおりです。Task.update を使用して更新しないでください。 last_location。 last_location_snappable name remaining_vehicle_journey_segments task_outcome_location_source。 注: task_outcome の値を一度設定すると、変更できません。 タスクが配達車両に割り当てられている場合は、Task.update を使用してタスクの状態を CLOSED に設定しないでください。代わりに、タスクを含む VehicleStop を配送車両から削除します。これにより、タスクの状態が自動的に CLOSED に設定されます。
update_mask	FieldMask 必須。更新する Task フィールドを示すフィールド マスク。注: update_mask には少なくとも 1 つのフィールドを含める必要があります。 完全修飾フィールド名のカンマ区切りリスト。例: "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

車両が 1 つ以上の Task を実行するために停止するポイントを記述します。

フィールド
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 へのレスポンスでのみ設定されます。