REST Resource: providers.vehicles

リソース: Vehicle

車両のメタデータ。

JSON 表現
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}
フィールド
name

string

出力専用。この車両の一意の名前。形式は providers/{provider}/vehicles/{vehicle} です。

vehicleState

enum (VehicleState)

車両の状態。

supportedTripTypes[]

enum (TripType)

この車両でサポートされているルートのタイプ。

currentTrips[]

string

出力専用。この車両に現在割り当てられているルートの tripId のリスト。

lastLocation

object (VehicleLocation)

最後に報告された車両の位置。

maximumCapacity

integer

この車両の乗車人数の合計。この値ではドライバは考慮されません。1 以上の値を指定してください。

attributes[]

object (VehicleAttribute)

車両属性のリスト。車両に指定できる属性は最大 100 個で、各属性には一意のキーが必要です。

vehicleType

object (VehicleType)

必須。この車両のタイプ。vehicles.search の結果で車両をフィルタするために使用できます。到着予定時刻やルートの計算にも影響します。

licensePlate

object (LicensePlate)

車両のナンバー プレート情報。

route[]
(deprecated)

object (TerminalLocation)

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

currentRouteSegment

string

ドライバー アプリが次のウェイポイントまで進むルートを指定するポリライン。このリストは、車両に割り当てられているすべての有効なルートについて、Trip.current_route_segment でも返されます。

注: このフィールドは、Driver SDK による使用のみを目的としています。デコードはまだサポートされていません。

currentRouteSegmentTraffic

object (TrafficPolylineData)

入力のみ。Fleet Engine はこの情報を使用して、ジャーニーの共有を改善します。注: このフィールドは、Driver SDK による使用のみを目的としています。

currentRouteSegmentVersion

string (Timestamp format)

出力専用。currentRouteSegment が設定された時刻。変更されていないルートを返さないように、クライアントで保存して将来の vehicles.get リクエストに渡すこともできます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

currentRouteSegmentEndPoint

object (TripWaypoint)

currentRouteSegment が終了する地点。運転手は vehicles.update 呼び出しで、完全なルートの地点、地点の LatLng、または currentRouteSegment の最後の LatLng として指定できます。Fleet Engine は、完全に指定されていない場合、実際の地点に補間しようと最善を尽くします。currentRouteSegment も指定されていない限り、このフィールドは vehicles.update の呼び出しでは無視されます。

remainingDistanceMeters

integer

currentRouteSegment の残りの運転距離。この値は、車両に割り当てられているすべての有効なルートの Trip.remaining_distance_meters でも返されます。currentRouteSegment フィールドが空の場合、値は指定されません。

etaToFirstWaypoint

string (Timestamp format)

waypoints フィールドの最初のエントリの到着予定時刻。waypoints フィールドが空の場合、または Vehicle.current_route_segment フィールドが空の場合、値は指定されません。

車両を更新する場合、同じリクエスト内で remainingTimeSecondsetaToFirstWaypoint よりも優先されます。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

remainingTimeSeconds

integer

入力のみ。currentRouteSegmentの残りの運転時間。waypoints フィールドが空の場合、または Vehicle.current_route_segment フィールドが空の場合、値は指定されません。すべての関係者が同じ時計を使用している場合、この値は etaToFirstWaypoint - current_time と一致する必要があります。

車両を更新する場合、同じリクエスト内で remainingTimeSecondsetaToFirstWaypoint よりも優先されます。

waypoints[]

object (TripWaypoint)

この車両に割り当てられている残りのウェイポイント。

waypointsVersion

string (Timestamp format)

出力専用。waypoints フィールドが最後に更新された時刻。waypoints フィールドが更新された場合にのみ返されるように、クライアントはこの値をキャッシュに保存して GetVehicleRequest に渡す必要があります。

RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: "2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

backToBackEnabled

boolean

連続したルートを運転手が受け入れているかどうかを示します。true の場合、vehicles.search に車両が現在ルートに割り当てられている場合でも、車両が含まれる可能性があります。デフォルト値は false です。

navigationStatus

enum (NavigationStatus)

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

deviceSettings

object (DeviceSettings)

入力のみ。ドライバが使用しているモバイル デバイスの設定に関する情報。

VehicleState

Vehicle の状態。

列挙型
UNKNOWN_VEHICLE_STATE デフォルト。未指定または認識できない車両状態に使用されます。
OFFLINE 車両が新しいルートを受け入れていません。注: 車両は、割り当てられたルートが完了中もこの状態で運転を続ける場合があります。
ONLINE 車両が新しいルートを受け入れています。

VehicleAttribute

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

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

  // Union field 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 vehicle_attribute_value.
}
フィールド
key

string

属性のキー。キーにコロン(:)を含めることはできません。

value

string

属性の値。

共用体フィールド vehicle_attribute_value。属性の値には、string、bool、double 型を指定できます。vehicle_attribute_value は次のいずれかになります。
stringValue

string

文字列型の属性値。

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

boolValue

boolean

ブール値型の属性値。

numberValue

number

二重型属性値。

VehicleType

車両のタイプ。

JSON 表現
{
  "category": enum (Category)
}
フィールド
category

enum (Category)

車種カテゴリ

カテゴリ

車両タイプのカテゴリ

列挙型
UNKNOWN デフォルト。未指定または認識できない車両カテゴリに使用されます。
AUTO 自動車。
TAXI タクシーとして動作する車両(通常は認可済みまたは規制対象の車両)。
TRUCK 一般に、収納容量が大きい車両。
TWO_WHEELER オートバイ、原動機付自転車、その他の二輪車
BICYCLE 人間による輸送。
PEDESTRIAN 通常は歩いたり走ったりする、歩行者専用の通路を歩く人間のトランスポーター。

LicensePlate

車両のナンバー プレート情報。個人を特定できる情報が保存されないように、ナンバー プレートに関する最小限の情報のみがエンティティの一部として保存されます。

JSON 表現
{
  "countryCode": string,
  "lastCharacter": string
}
フィールド
countryCode

string

必須。CLDR 国/地域コード。たとえば、米国の場合は US、インドの場合は IN です。

lastCharacter

string

ナンバー プレートの最後の桁、またはナンバー プレートに数値が含まれていない場合は「-1」。

  • 「ABC 1234」->「4」
  • 「AB 123 CD」->「3」
  • 「ABCDEF」->「-1」

TrafficPolylineData

想定している車両ルートの交通状況。

JSON 表現
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
フィールド
trafficRendering

object (VisualTrafficReportPolylineRendering)

顧客の乗車区間におけるすべての地域の交通速度を示すポリライン レンダリング。

VisualTrafficReportPolylineRendering

クライアントがルートに沿ったポリラインの一部に色を付ける方法について説明します。

JSON 表現
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
フィールド
roadStretch[]

object (RoadStretch)

省略可。ポリラインに沿ってレンダリングされる道路の範囲。ストレッチは重複しないことが保証されており、必ずしもルート全体にわたるとは限りません。

道路のストレッチによるスタイル設定がない場合は、クライアントはルートにデフォルトを適用する必要があります。

RoadStretch

レンダリングする 1 つの道路区間。

JSON 表現
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
フィールド
style

enum (Style)

必須。適用するスタイル。

offsetMeters

integer

必須。スタイルは [offsetMeters, offsetMeters + lengthMeters) の間に適用する必要があります。

lengthMeters

integer

必須。スタイルを適用するパスの長さ。

スタイル

交通状況を示すスタイル。

列挙型
STYLE_UNSPECIFIED スタイルが選択されていません。
SLOWER_TRAFFIC トラフィックが減少している。
TRAFFIC_JAM 渋滞が発生しています。

DeviceSettings

モバイル デバイスのさまざまな設定に関する情報。

JSON 表現
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
フィールド
locationPowerSaveMode

enum (LocationPowerSaveMode)

バッテリー セーバーがオンのときにデバイスの位置情報機能がどのように動作するかを設定します。

isPowerSaveMode

boolean

デバイスが現在省電力モードかどうか。

isInteractive

boolean

デバイスが操作可能な状態かどうか。

batteryInfo

object (BatteryInfo)

バッテリーの状態に関する情報。

LocationPowerSaveMode

デバイスの「バッテリー セーバー」機能がオンになっている場合に、モバイル デバイスで位置情報機能がどのように動作するかを設定します。(https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

列挙型
UNKNOWN_LOCATION_POWER_SAVE_MODE 未定義の LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE 位置情報プロバイダがバッテリー セーバーの影響を受けないか、バッテリー セーバーがオフになっています。
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF バッテリー セーバーがオンになっていてデバイスがインタラクティブでない場合は、GPS ベースの位置情報プロバイダを無効にする必要があります。
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF バッテリー セーバーがオンになっていて、デバイスが非対話モードの場合は、位置情報プロバイダをすべて無効にする必要があります。
LOCATION_MODE_FOREGROUND_ONLY すべての位置情報プロバイダは引き続き利用できますが、位置情報の修正はフォアグラウンド アプリに対してのみ提供する必要があります。
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF 位置情報はオフになりませんが、デバイスがインタラクティブでない場合、LocationManager はプロバイダへのすべてのリクエストを調整します。

BatteryInfo

デバイスのバッテリーに関する情報。

JSON 表現
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
フィールド
batteryStatus

enum (BatteryStatus)

バッテリーの状態(フル、充電など)

powerSource

enum (PowerSource)

バッテリー電源のステータス。

batteryPercentage

number

現在のバッテリー残量(0 ~ 100)。

BatteryStatus

バッテリーの状態(フル、充電など)

列挙型
UNKNOWN_BATTERY_STATUS バッテリーの状態は不明です。
BATTERY_STATUS_CHARGING バッテリーを充電しています。
BATTERY_STATUS_DISCHARGING バッテリーが放電している。
BATTERY_STATUS_FULL バッテリー残量がフルです。
BATTERY_STATUS_NOT_CHARGING バッテリーが充電されていません。
BATTERY_STATUS_POWER_LOW バッテリー残量が少なくなっています。

PowerSource

バッテリーの充電に使用している充電器の種類。

列挙型
UNKNOWN_POWER_SOURCE 電源が不明です。
POWER_SOURCE_AC 電源が AC 充電器である。
POWER_SOURCE_USB 電源は USB ポートです。
POWER_SOURCE_WIRELESS 電源はワイヤレスです。
POWER_SOURCE_UNPLUGGED バッテリーが電源に接続されていません。

方法

create

オンデマンドの配車サービス プロバイダまたは配達プロバイダに関連付けられた新しい車両をインスタンス化します。

get

Fleet Engine から車両を返します。

list

リクエスト オプションに一致するプロバイダに関連付けられている車両のページ分けされたリストを返します。
リクエストのオプションに一致する車両のリストを返します。

searchFuzzed
(deprecated)

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

update

更新された車両データを Fleet Engine に書き込みます。

updateAttributes

車両の属性を部分的に更新します。