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 フィールドが空の場合、値は指定されません。

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

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 と一致する必要があります。

車両を更新する場合、同じリクエストで remainingTimeSeconds が etaToFirstWaypoint よりも優先されます。
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。属性の値には、文字列、ブール値、倍精度型を指定できます。vehicle_attribute_value は次のいずれかになります。
stringValue

string

文字列型の属性値。

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

顧客の乗車 1 区間における、全地域の交通量を示すポリライン レンダリング。

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 電池が電源に接続されていません。

Methods

create

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

get

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

list

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

searchFuzzed
(deprecated)

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

update

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

updateAttributes

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

updateLocation
(deprecated)

 非推奨: 代わりに UpdateVehicle メソッドを使用してください。