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。属性の値は、文字列、ブール値、または double 型にできます。delivery_vehicle_attribute_value は次のいずれかになります。
stringValue

string

文字列型の属性値。

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

boolValue

boolean

ブール型の属性値。

numberValue

number

倍精度型の属性値。

DeliveryVehicleType

配送車両の種類。

列挙型
DELIVERY_VEHICLE_TYPE_UNSPECIFIED この値は使用されません。
AUTO 自動車。
TWO_WHEELER オートバイ、原付き、その他の 2 輪車
BICYCLE 人力の輸送。
PEDESTRIAN 歩道を歩いたり走ったりして移動する人員。

メソッド

create

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

get

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

list

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

patch

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