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 を使用することを強くおすすめします。stringValue と value を両方とも設定する場合は、両方を同一にする必要があります。設定しない場合はエラーがスローされます。どちらのフィールドにもレスポンスが入力されます。
boolValue

boolean

ブール値型属性値。
numberValue

number

二重型の属性値。

DeliveryVehicleType

配送車両のタイプ。

列挙型
DELIVERY_VEHICLE_TYPE_UNSPECIFIED この値は使用されません。
AUTO 自動車。
TWO_WHEELER オートバイ、原動機付き自転車、その他の二輪車
BICYCLE 人力の輸送。
PEDESTRIAN 歩道を歩く、または走る、人の移動手段。

メソッド

create

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

get

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

list

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

patch

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