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 オブジェクトを作成して返します。

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 を取得します。

SearchTasks

rpc SearchTasks(SearchTasksRequest) returns (SearchTasksResponse)

非推奨: 代わりに GetTaskTrackingInfo を使用してください。

UpdateDeliveryVehicle

rpc UpdateDeliveryVehicle(UpdateDeliveryVehicleRequest) returns (DeliveryVehicle)

更新された DeliveryVehicle データを Fleet Engine に書き込み、TasksDeliveryVehicle に割り当てます。DeliveryVehicle の名前は更新できません。ただし、remaining_vehicle_journey_segments は更新できますが、現在 DeliveryVehicle にあるすべての VehicleJourneySegment が含まれている必要があります。task_idremaining_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-projectCreateTaskRequest メッセージの親フィールドは空にするか、このフィールドと一致させる必要があります。

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 エンティティ。新しい配達車両を作成する際は、次のオプション フィールドを設定できます。

  • 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
  • stateOPEN に設定する必要があります)
  • tracking_idUNAVAILABLE タスクまたは SCHEDULED_STOP タスクでは設定できませんが、他のすべてのタスクタイプでは必須)
  • planned_locationUNAVAILABLE タスクの場合は省略可)
  • 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.112.1

device_model

string

呼び出し元の SDK が実行されているデバイスのモデル。フィールド値の例: iPhone12,1SM-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。属性の値には、string、bool、double 型を指定できます。delivery_vehicle_attribute_value は次のいずれかになります。
string_value

string

文字列型の属性値。

注: これは、最終的にサポートが終了する value フィールドと同じです。create メソッドまたは update メソッドでは、どちらのフィールドも使用できますが、string_value を使用することを強くおすすめします。string_valuevalue の両方が設定されている場合、これらは同一である必要があります。そうでない場合はエラーがスローされます。レスポンスにはどちらのフィールドも入力されます。

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

車両の速度(km/時)。非推奨: 代わりに 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 または 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 オペレーティング システム上の位置情報プロバイダ。

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

場所の座標。

SearchTasksRequest

非推奨: 代わりに GetTaskTrackingInfoGetTaskTrackingInfoRequest を発行しました。

フィールド
header

DeliveryRequestHeader

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

parent

string

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

tracking_id

string

必須。リクエストされている一連の関連タスクの識別子。トラッキング ID には次の制限があります。

  • 有効な Unicode 文字列を指定してください。
  • 最大文字数は 64 文字です。
  • Unicode 正規化フォーム C に従って正規化されています。
  • ASCII 文字「/」、「:」、「?」、「,」、「#」を含めることはできません。
page_size

int32

(省略可)返されるタスクの最大数。サービスはこの値より少ない値を返すことがあります。この値を指定しない場合、返される結果の数はサーバーが決定します。

page_token

string

(省略可)前回の SearchTasks 呼び出しから受け取ったページトークン。次のページを取得するには、この値を指定する必要があります。

ページ分割を行う場合、SearchTasks に指定する他のすべてのパラメータは、ページトークンを提供した呼び出しと一致する必要があります。

SearchTasksResponse

SearchTasks レスポンス。SearchTasksRequest 内の検索条件に一致するタスクのセットが含まれます。

フィールド
tasks[]

Task

リクエストされた tracking_id のタスクのセット。正常なレスポンスは空にすることもできます。空のレスポンスは、指定された tracking_id に関連付けられているタスクがないことを示します。

next_page_token

string

結果の一覧表示を続行するには、このトークンを SearchTasksRequest に渡します。すべての結果が返された場合、このフィールドは空の文字列になるか、レスポンスに表示されません。

タスク

Delivery API のタスクは、追跡する単一のアクションを表します。一般に、配送関連のタスクと分割タスクは区別されます。配送には複数のタスクを関連付けることができます。たとえば、集荷に関する Task と、降車または乗り換えに関する Task を 1 つずつ設定することができます。また、特定の配送の異なるタスクは、異なる車両で処理できます。たとえば、ある車両で集荷を処理してハブまで荷物を運び、別の車両で同じハブから降車場所まで荷物を運ぶことができます。

注: gRPC API と 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 タイプの ToDo リストには 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。属性の値には、string、bool、double 型を指定できます。設定されていない場合、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_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

このデータ要素は、残りの駅 / 停留所の数が残りの駅 / 停留所のカウントの基準値以下である場合に、エンドユーザーに表示されます。

duration_until_estimated_arrival_time_threshold

Duration

このデータ要素は、停車地の到着予定時刻が duration_until_estimated_arrival_time_threshold 以下の場合にエンドユーザーに表示されます。

remaining_driving_distance_meters_threshold

int32

このデータ要素は、残りの運転距離がメートル単位 <= percentage_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 呼び出しや SearchTasks 呼び出しのレスポンスでは入力されません。

tasks[]

TaskInfo

この駅 / 停留所で実行される Task のリスト。このフィールドは、GetTask 呼び出しまたは SearchTasks 呼び出しのレスポンスでは入力されません。

state

State

VehicleStop の状態。このフィールドは、GetTask 呼び出しや SearchTasks 呼び出しのレスポンスでは入力されません。

状態

VehicleStop の現在の状態。

列挙型
STATE_UNSPECIFIED 不明
NEW 作成されましたが、実際にルーティングされていません。
ENROUTE 割り当てられ、アクティブにルーティングされています。
ARRIVED 駅 / 停留所に到着しました。車両が次の停車地に向かう途中で、前の停車地がすべて完了していると想定します。

TaskInfo

この停車地で実行されたタスクに関する追加情報。

フィールド
task_id

string

タスク ID。このフィールドは、GetTask 呼び出しや SearchTasks 呼び出しのレスポンスでは入力されません。タスク ID には次の制限があります。

  • 有効な Unicode 文字列を指定してください。
  • 最大文字数は 64 文字です。
  • Unicode 正規化フォーム C に従って正規化されています。
  • ASCII 文字「/」、「:」、「?」、「,」、「#」を含めることはできません。
task_duration

Duration

出力のみ。タスクの実行に必要な時間。

target_time_window

TimeWindow

出力のみ。タスクが完了するまでの時間枠。これは GetDeliveryVehicle に対するレスポンスでのみ設定されます。