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 リクエストで渡すことで、変更されていないルートを返さないようにできます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
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 よりも優先されます。

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
remainingTimeSeconds

integer

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

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

object (TripWaypoint)

この車両に割り当てられている残りのルートポイント。
waypointsVersion

string (Timestamp format)

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

RFC 3339 を使用します。生成された出力は常に Z 正規化され、小数点以下は 0、3、6、または 9 桁になります。「Z」以外のオフセットも使用できます。例: "2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z"、"2014-10-02T15:01:23+05:30"。
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。属性の値は、文字列、ブール値、または double 型にすることができます。vehicle_attribute_value は次のいずれかになります。
stringValue

string

文字列型の属性値。

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

boolean

ブール型の属性値。
numberValue

number

倍精度型の属性値。

VehicleType

車両の種類。

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

enum (Category)

車種のカテゴリ

カテゴリ

車種のカテゴリ

列挙型
UNKNOWN デフォルト。指定されていない車両カテゴリまたは認識できない車両カテゴリに使用されます。
AUTO 自動車。
TAXI タクシーとして機能する車両（通常はライセンスまたは規制対象）。
TRUCK 通常、大容量のストレージを備えた車両。
TWO_WHEELER オートバイ、原付き、その他の 2 輪車
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

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

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 Undefined 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

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