REST Resource: providers.deliveryVehicles

リソース: DeliveryVehicle

DeliveryVehicle メッセージ。配達車両は、倉庫から配達場所へ、および集荷場所から倉庫へ荷物を輸送します。場合によっては、配達車両が荷物を集荷場所から配達場所に直接配送することもあります。

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

JSON 表現
{
  "name": string,
  "lastLocation": {
    object (DeliveryVehicleLocation)
  },
  "navigationStatus": enum (DeliveryVehicleNavigationStatus),
  "currentRouteSegment": string,
  "currentRouteSegmentEndPoint": {
    object (LatLng)
  },
  "remainingDistanceMeters": integer,
  "remainingDuration": string,
  "remainingVehicleJourneySegments": [
    {
      object (VehicleJourneySegment)
    }
  ],
  "attributes": [
    {
      object (DeliveryVehicleAttribute)
    }
  ],
  "type": enum (DeliveryVehicleType)
}
フィールド
name

string

この配達車両の一意の名前。形式は providers/{provider}/deliveryVehicles/{vehicle} です。

lastLocation

object (DeliveryVehicleLocation)

最後に報告された配達車両の場所。

navigationStatus

enum (DeliveryVehicleNavigationStatus)

配達車両のナビゲーション ステータス。

currentRouteSegment

string (bytes format)

ナビゲーションが次の地点に進むことを推奨するルートを指定する、エンコードされたポリライン。ドライバー アプリは、停車地に到着または通過したとき、ナビゲーションのルートが変更されたときに、この情報を更新します。これらの 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)へのデータ入力に使用されないことがあります。

  • currentRouteSegment のエンドポイントが DeliveryVehicle.remaining_vehicle_journey_segments[0].stop(gRPC)または DeliveryVehicle.remainingVehicleJourneySegments[0].stop(REST)と一致しません。

  • ドライバーアプリが位置情報を最近更新していないため、このフィールドの最終更新値が古くなっている可能性があります。

  • ドライバー アプリが最近位置情報を更新しましたが、currentRouteSegment が古く、前の車両の停車地を参照しています。

このような場合、Fleet Engine は、最後に渡された VehicleStop から次の VehicleStop へのルートをこのフィールドに入力し、このフィールドのコンシューマーが配達車両の現在の経路について利用可能な最良の情報を得られるようにします。

Base64 でエンコードされた文字列。

currentRouteSegmentEndPoint

object (LatLng)

currentRouteSegment を終了する場所。現在はドライバアプリによって入力されませんが、deliveryVehicles.patch 呼び出しで指定できます。これは、予定されている車両停留所からの LatLng、または currentRouteSegment の最後の LatLng です。Fleet Engine は最善を尽くして実際の VehicleStop に補間します。

currentRouteSegment フィールドが空の場合、このフィールドは deliveryVehicles.patch 呼び出しでは無視されます。

remainingDistanceMeters

integer

currentRouteSegment の残りの運転距離。通常、ドライバアプリはこのフィールドを提供しますが、状況によっては、Fleet Engine がアプリから送信された値をオーバーライドすることがあります。詳細については、DeliveryVehicle.current_route_segment をご覧ください。このフィールドは、配達車両に割り当てられているすべてのアクティブな Task について、Task.remaining_vehicle_journey_segments[0].driving_distance_meters(gRPC)または Task.remainingVehicleJourneySegments[0].drivingDistanceMeters(REST)で返されます。

currentRouteSegment フィールドが空の場合、Fleet Engine は UpdateDeliveryVehicleRequest のこのフィールドを無視します。

remainingDuration

string (Duration format)

currentRouteSegmentの残りの運転時間。通常、ドライバアプリはこのフィールドを提供しますが、状況によっては、Fleet Engine がアプリから送信された値をオーバーライドすることがあります。詳細については、DeliveryVehicle.current_route_segment をご覧ください。このフィールドは、配達車両に割り当てられているすべてのアクティブなタスクについて、Task.remaining_vehicle_journey_segments[0].driving_duration(gRPC)または Task.remainingVehicleJourneySegments[0].drivingDuration(REST)で返されます。

currentRouteSegment フィールドが空の場合、Fleet Engine は UpdateDeliveryVehicleRequest のこのフィールドを無視します。

s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

remainingVehicleJourneySegments[]

object (VehicleJourneySegment)

車両で最後に報告された場所から始まる、この配達車両に割り当てられた経路セグメント。このフィールドは、deliveryVehicles.list のレスポンスでは入力されません。

attributes[]

object (DeliveryVehicleAttribute)

カスタムの配達車両属性のリスト。配達車両には最大 100 個の属性を設定でき、各属性には一意のキーが必要です。

type

enum (DeliveryVehicleType)

この配達車両のタイプ。未設定のままにした場合は、デフォルトで AUTO に設定されます。

DeliveryVehicleNavigationStatus

車両のナビゲーション ステータス。

列挙型
UNKNOWN_NAVIGATION_STATUS 未指定のナビゲーション ステータス。
NO_GUIDANCE ドライバアプリのナビゲーションが FREE_NAV モードです。
ENROUTE_TO_DESTINATION ターンバイターン方式のナビが利用可能で、ドライバー向けアプリのナビゲーションが GUIDED_NAV モードになりました。
OFF_ROUTE 車両が推奨ルートから逸脱しました。
ARRIVED_AT_DESTINATION 車両が目的地から約 50 m 以内にある。

DeliveryVehicleAttribute

車両属性を Key-Value ペアとして記述します。「key:value」の文字列の長さは 256 文字以内にしてください。

JSON 表現
{
  "key": string,
  "value": string,

  // Union field delivery_vehicle_attribute_value can be only one of the
  // following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field
  // delivery_vehicle_attribute_value.
}
フィールド
key

string

属性のキー。

value

string

属性の値。

共用体フィールド delivery_vehicle_attribute_value。属性の値には、文字列、ブール値、倍精度型を指定できます。delivery_vehicle_attribute_value は次のいずれかになります。
stringValue

string

文字列型の属性値。

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

boolValue

boolean

ブール値型の属性値。

numberValue

number

二重型属性値です。

DeliveryVehicleType

配達車両の種類。

列挙型
DELIVERY_VEHICLE_TYPE_UNSPECIFIED この値は使用されません。
AUTO 自動車。
TWO_WHEELER オートバイ、原動機付自転車、その他の二輪車
BICYCLE 人が行う移動手段。
PEDESTRIAN 通常は歩いたり走ったりして、歩行者専用道路を歩く人間のトランスポーター。

Methods

create

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

get

指定された DeliveryVehicle インスタンスを返します。

list

指定されたフィルタ条件を満たすすべての DeliveryVehicle を取得します。

patch

更新された DeliveryVehicle データを Fleet Engine に書き込み、TasksDeliveryVehicle に割り当てます。