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

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 バッテリーが電源から外されている。

メソッド

create

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

get

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

list

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

update

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

updateAttributes

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