Package maps.fleetengine.delivery.v1

インデックス

DeliveryService

ラスト ワンマイル配送サービス。

BatchCreateTasks

rpc BatchCreateTasks(BatchCreateTasksRequest) returns (BatchCreateTasksResponse)

新しい Task オブジェクトのバッチを作成して返します。
CreateDeliveryVehicle

rpc CreateDeliveryVehicle(CreateDeliveryVehicleRequest) returns (DeliveryVehicle)

新しい DeliveryVehicle を作成して返します。
CreateTask

rpc CreateTask(CreateTaskRequest) returns (Task)

新しい Task オブジェクトを作成して返します。
DeleteDeliveryVehicle

rpc DeleteDeliveryVehicle(DeleteDeliveryVehicleRequest) returns (Empty)

Fleet Engine から DeliveryVehicle を削除します。

DeliveryVehicle に OPEN タスクが割り当てられている場合は、FAILED_PRECONDITION を返します。
DeleteTask

rpc DeleteTask(DeleteTaskRequest) returns (Empty)

1 つの Task を削除します。

Task が OPEN で、DeliveryVehicle に割り当てられている場合は、FAILED_PRECONDITION を返します。
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 に書き込み、DeliveryVehicle に Tasks を割り当てます。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

必須。作成するリソースを指定するリクエスト メッセージ。注: バッチで作成できるタスクは最大 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

次のフィールドは必要に応じて設定できます。

  • target_time_window
  • task_tracking_view_config
  • attributes

注: タスクの name フィールドは無視されます。他のすべての Task フィールドは設定しないでください。設定すると、エラーが返されます。

DeleteDeliveryVehicleRequest

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

フィールド
header

DeliveryRequestHeader

省略可。標準の Delivery API リクエスト ヘッダー。
name

string

必須。providers/{provider}/deliveryVehicles/{delivery_vehicle} の形式で指定してください。provider は Google Cloud プロジェクト ID である必要があります。例: sample-cloud-project

DeleteTaskRequest

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

フィールド
header

DeliveryRequestHeader

省略可。標準の Delivery API リクエスト ヘッダー。
name

string

必須。providers/{provider}/tasks/{task} の形式で指定してください。provider は Google Cloud プロジェクト ID である必要があります。例: sample-cloud-project

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

配達車両の最後に報告された位置情報。
past_locations[]

DeliveryVehicleLocation

入力のみのこの配送車両が過去にいた場所のうち、まだ Fleet Engine に報告されていない場所。これは UpdateDeliveryVehicleRequest で、以前サーバーに送信できなかった位置情報を記録するために使用されます。通常、この問題は配達車両がインターネットに接続されていない場合に発生します。
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 の残りの走行距離。通常、このフィールドは Driver アプリによって提供されますが、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 の残りの運転時間。通常、このフィールドは Driver アプリによって提供されますが、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 フィールドと同じです。このフィールドは最終的に非推奨になります。作成または更新メソッドでは、どちらのフィールドも使用できますが、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

入力のみのこの位置情報が最初にサーバーに送信されてからの時間（秒単位）。最初の更新では 0 になります。時間が不明な場合（アプリの再起動時など）、この値は 0 にリセットされます。
num_stale_updates
(deprecated)

Int32Value

入力のみの非推奨: 位置情報が古いかどうかを判断するために、他のシグナルが使用されるようになりました。
raw_location

LatLng

車両の生の位置情報（道路スナッパーで処理されていない）。
raw_location_time

Timestamp

未加工の位置情報に関連付けられたタイムスタンプ。
raw_location_sensor

DeliveryVehicleLocationSensor

未加工の位置情報のソース。デフォルトは GPS です。
raw_location_accuracy

DoubleValue

半径としての raw_location の精度（メートル単位）。
flp_location

LatLng

Android の Fused Location Provider からの位置情報。
flp_update_time

Timestamp

flp_location のタイムスタンプを更新
flp_latlng_accuracy_meters

DoubleValue

半径としての flp_location の精度（メートル単位）。
flp_heading_degrees

Int32Value

Fused Location Provider によって決定された、車両の移動方向（度単位）。0 は北を表します。有効な範囲は [0,360) です。
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 または A-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 オペレーティング システムの位置情報プロバイダ。

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"）。

フィルタ クエリで許可される制限の最大数は 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

場所の座標。point または place のいずれかを入力として指定する必要があります。両方が指定されている場合、ルーティングには point が使用され、メタデータには place が使用されます。入力として place のみが指定されている場合、point は place から計算され、出力に含まれます。
place

string

このビジネスを表す場所のリソース名。形式は places/{place_id} です。point または place のいずれかを入力として指定する必要があります。両方が指定されている場合、ルーティングには point が使用され、メタデータには place が使用されます。place は入力に含まれている場合にのみ出力に含まれます。つまり、LatLng から place のルックアップは実行されません。

この機能は試験運用中です。
point_location_source

PointSource

出力専用。latlng point フィールドのソース。これは試験運用版の機能の一部です。

PointSource

LatLng のソースを示します。

列挙型
POINT_SOURCE_UNSPECIFIED ポイントソースが指定されていません。
POINT_SOURCE_DEVELOPER_PROVIDED LatLng はデベロッパーによって明示的に提供されました。
POINT_SOURCE_CALCULATED_FROM_PLACE LatLng は、指定された場所から計算されました。

タスク

Delivery API の Task は、追跡する単一のアクションを表します。一般に、配送関連のタスクと休憩タスクには違いがあります。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

カスタムの Task 属性のリスト。各属性には一意のキーが必要です。

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

Task の実行を試みた結果。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 には、次のいずれか 1 つのみを指定できます。
string_value

string

文字列型の属性値。
bool_value

bool

ブール型の属性値。
number_value

double

倍精度型の属性値。

TaskTrackingInfo

TaskTrackingInfo メッセージ。このメッセージには、表示に使用されるタスク トラッキング情報が含まれています。トラッキング ID が複数のタスクに関連付けられている場合、Fleet Engine はヒューリスティックを使用して、どのタスクの TaskTrackingInfo を選択するかを決定します。

フィールド
name

string

providers/{provider}/taskTrackingInfo/{tracking} の形式で指定する必要があります。ここで、tracking はトラッキング ID を表します。
tracking_id

string

変更不可。タスクのトラッキング ID。* 有効な Unicode 文字列である必要があります。* 最大長は 64 文字です。* Unicode 正規化形式 C に従って正規化されます。* 次の ASCII 文字（/、:、?、,、#）を含めることはできません。
vehicle_location

DeliveryVehicleLocation

車両の最終位置。
route_polyline_points[]

LatLng

このタスクの場所までの車両の予想ルートのポリラインを形成するポイントのリスト。
remaining_stop_count

Int32Value

タスクの停車地までの残りの停車回数（タスクの停車地を含む）を示します。たとえば、車両の次の停車場所がタスクの停車場所の場合、値は 1 になります。
remaining_driving_distance_meters

Int32Value

目的の VehicleStop までの残りの合計距離（メートル単位）。
estimated_arrival_time

Timestamp

停留所への到着予定時刻を示すタイムスタンプ。
estimated_task_completion_time

Timestamp

タスクの推定完了日時を示すタイムスタンプ。
state

State

タスクの現在の実行状態。
task_outcome

TaskOutcome

Task の実行を試みた結果。
task_outcome_time

Timestamp

プロバイダが Task の結果を設定した日時を示すタイムスタンプ。
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

このデータ要素は、停留所までの到着予定時刻が duration_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

必須。時間枠の終了時刻（この時刻を含む）。

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

必須。更新するタスク フィールドを示すフィールド マスク。注: 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 へのレスポンスでのみ設定されます。