Package maps.fleetengine.v1

インデックス

TripService

旅行管理サービス。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Fleet Engine でルートを作成し、新しいルートを返します。

GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

1 回のルートに関する情報を取得します。

ReportBillableTrip

rpc ReportBillableTrip(ReportBillableTripRequest) returns (Empty)

請求対象のルートの使用状況を報告する。

SearchTrips

rpc SearchTrips(SearchTripsRequest) returns (SearchTripsResponse)

特定の車両のすべてのルートを取得します。

UpdateTrip

rpc UpdateTrip(UpdateTripRequest) returns (Trip)

ルートデータを更新します。

VehicleService

車両管理サービス。

CreateVehicle

rpc CreateVehicle(CreateVehicleRequest) returns (Vehicle)

オンデマンド配車または配送プロバイダに関連付けられた新しい車両をインスタンス化します。各 Vehicle には一意の車両 ID が必要です。

Vehicle を作成する場合は、次の Vehicle フィールドが必要です。

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

Vehicle の作成時に、次の Vehicle フィールドは無視されます。

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

他のフィールドはすべて省略可能です。指定された場合は使用されます。

GetVehicle

rpc GetVehicle(GetVehicleRequest) returns (Vehicle)

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

ListVehicles

rpc ListVehicles(ListVehiclesRequest) returns (ListVehiclesResponse)

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

SearchVehicles

rpc SearchVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

リクエスト オプションに一致する車両のリストを返します。

UpdateVehicle

rpc UpdateVehicle(UpdateVehicleRequest) returns (Vehicle)

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

Vehicle を更新する場合、次のフィールドはサーバーによって管理されているため、更新できません。

  • currentTrips
  • availableCapacity
  • current_route_segment_version
  • waypoints_version

車両 name も更新できません。

attributes フィールドが更新されると、車両の属性がすべてリクエストで指定された属性に置き換えられます。一部の属性のみを更新する場合は、UpdateVehicleAttributes メソッドをご覧ください。同様に、waypoints フィールドは更新できますが、現在車両にあるすべてのウェイポイントを含める必要があります。他のウェイポイントを含めることはできません。

UpdateVehicleAttributes

rpc UpdateVehicleAttributes(UpdateVehicleAttributesRequest) returns (UpdateVehicleAttributesResponse)

車両の属性を部分的に更新します。リクエストで指定された属性のみが更新され、他の属性は変更されません。注: これは UpdateVehicle とは異なります。UpdateVehicle では、attributes フィールド全体が UpdateVehicleRequest のフィールドに置き換えられ、リクエストにない属性は削除されます。

BatteryInfo

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

フィールド
battery_status

BatteryStatus

バッテリーのステータス(フル充電か充電中かなど)

power_source

PowerSource

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

battery_percentage

float

現在のバッテリー残量 [0 ~ 100]。

BatteryStatus

バッテリーのステータス(フル充電か充電中かなど)

列挙型
UNKNOWN_BATTERY_STATUS バッテリーのステータスが不明です。
BATTERY_STATUS_CHARGING バッテリーが充電中です。
BATTERY_STATUS_DISCHARGING バッテリーが放電している。
BATTERY_STATUS_FULL バッテリー残量: フル
BATTERY_STATUS_NOT_CHARGING バッテリーが充電されない。
BATTERY_STATUS_POWER_LOW バッテリー残量が少なくなっています。

BillingPlatformIdentifier

リクエストが発行されたプラットフォームを示す値のセット。

列挙型
BILLING_PLATFORM_IDENTIFIER_UNSPECIFIED デフォルト。指定されていないプラットフォームに使用します。
SERVER プラットフォームはクライアント サーバーです。
WEB プラットフォームはウェブブラウザです。
ANDROID プラットフォームが Android モバイル デバイスである。
IOS プラットフォームが iOS モバイル デバイスである。
OTHERS この列挙に記載されていない他のプラットフォーム。

ConsumableTrafficPolyline

車両のルート上の交通量。

フィールド
speed_reading_interval[]

SpeedReadingInterval

前のウェイポイントから現在のウェイポイントまでの経路の交通速度。

encoded_path_to_waypoint

string

ドライバーが前のウェイポイントから現在のウェイポイントに向かって進んでいる経路。このパスにはランドマークが含まれているため、クライアントはパス沿いに交通マーカーを表示できます(speed_reading_interval を参照)。デコードはまだサポートされていません。

CreateTripRequest

CreateTrip リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

parent

string

必須。providers/{provider} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

trip_id

string

必須。一意のルート ID。次の制限が適用されます。

  • 有効な Unicode 文字列である必要があります。
  • 最大長は 64 文字です。
  • Unicode 正規化形式 C に従って正規化されます。
  • 次の ASCII 文字を含めることはできません: '/'、':'、'?'、','、'#'。
trip

Trip

必須。作成するルート エンティティ。

ルートを作成する際は、次のフィールドが必要です。

  • trip_type
  • pickup_point

次のフィールドは、指定した場合に使用されます。

  • number_of_passengers
  • vehicle_id
  • dropoff_point
  • intermediate_destinations
  • vehicle_waypoints

その他のルートのフィールドはすべて無視されます。たとえば、作成リクエストで trip_statusCANCELED として渡しても、すべてのルートの trip_statusNEW で始まります。

intermediate_destinations をサポートするのは EXCLUSIVE ルートのみです。

共有ルートに vehicle_id が設定されている場合は、Trip.vehicle_waypoints のリストを指定して、車両の残りのウェイポイントの順序を指定する必要があります。指定しない場合、ウェイポイントの順序は未定義になります。

Trip.vehicle_waypoints を指定する場合は、リストに車両のルートの残りのすべてのウェイポイントを含める必要があります。余分なウェイポイントは含めないでください。これらのウェイポイントは、特定のルートにおいて、乗車地が中間目的地の前に配置され、すべての中間目的地が降車地の前に配置されるように順序付ける必要があります。EXCLUSIVE ルートのウェイポイントは、他のルートのウェイポイントと重複してはいけません。

trip_idwaypoint_typelocation フィールドが使用され、vehicle_waypoints の他のすべての TripWaypoint フィールドは無視されます。

CreateVehicleRequest

CreateVehicle リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

parent

string

必須。providers/{provider} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

vehicle_id

string

必須。一意の車両 ID。次の制限が適用されます。

  • 有効な Unicode 文字列である必要があります。
  • 最大長は 64 文字です。
  • Unicode 正規化形式 C に従って正規化されます。
  • 次の ASCII 文字を含めることはできません: '/'、':'、'?'、','、'#'。
vehicle

Vehicle

必須。作成する Vehicle エンティティ。車両を作成する際は、次のフィールドが必要です。

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

車両を作成する際、次のフィールドは無視されます。

  • name
  • currentTrips
  • availableCapacity
  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_version
  • current_route_segment_traffic
  • route
  • waypoints
  • waypoints_version
  • remaining_distance_meters
  • remaining_time_seconds
  • eta_to_next_waypoint
  • navigation_status

他のフィールドはすべて省略可能です。指定された場合は使用されます。

DeviceSettings

モバイル デバイスの各種設定に関する情報。

フィールド
location_power_save_mode

LocationPowerSaveMode

バッテリー セーバーがオンになっているときに、デバイスで位置情報機能がどのように動作するように設定されているか。

is_power_save_mode

bool

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

is_interactive

bool

デバイスがインタラクティブな状態かどうか。

battery_info

BatteryInfo

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

GetTripRequest

GetTrip リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

name

string

必須。providers/{provider}/trips/{trip} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

view

TripView

返される必要があるルート フィールドのサブセットとその解釈。

current_route_segment_version

Timestamp

Trip.route データまたは Trip.current_route_segment データが取得される最小タイムスタンプ(除く)を示します。このタイムスタンプ以降にルートデータが変更されていない場合、レスポンスでルート フィールドは設定されません。最小値が指定されていない場合、ルートデータは常に取得されます。

remaining_waypoints_version

Timestamp

Trip.remaining_waypoints が取得される最小タイムスタンプ(除外)を示します。このタイムスタンプ以降に変更されていない場合、remaining_waypoints はレスポンスに設定されません。このフィールドが指定されていない場合、常に remaining_waypoints が取得されます。

route_format_type

PolylineFormatType

返される現在のルートの形式(LAT_LNG_LIST_TYPETrip.route 内)または ENCODED_POLYLINE_TYPETrip.current_route_segment 内))。デフォルトは LAT_LNG_LIST_TYPE です。

current_route_segment_traffic_version

Timestamp

Trip.current_route_segment_traffic が取得される最小タイムスタンプ(除外)を示します。このタイムスタンプ以降にトラフィック データが変更されていない場合、レスポンスには current_route_segment_traffic フィールドが設定されません。最小値が指定されていない場合、トラフィック データは常に取得されます。トラフィックを利用できるのは、オンデマンド配車と配達ソリューションのお客様に限られます。

remaining_waypoints_route_version

Timestamp

Trip.remaining_waypoints.traffic_to_waypoint データと Trip.remaining_waypoints.path_to_waypoint データが取得される最小タイムスタンプ(除く)を示します。このタイムスタンプ以降にデータが変更されていない場合、上記のフィールドはレスポンスで設定されません。remaining_waypoints_route_version が指定されていない場合、トラフィックとパスは常に取得されます。

GetVehicleRequest

GetVehicle リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

name

string

必須。providers/{provider}/vehicles/{vehicle} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

current_route_segment_version

Timestamp

Vehicle.current_route_segment が取得される最小タイムスタンプ(除外)を示します。このタイムスタンプ以降にルートが変わっていない場合、レスポンスの current_route_segment フィールドは設定されません。最小値が指定されていない場合、current_route_segment は常に取得されます。

waypoints_version

Timestamp

Vehicle.waypoints データが取得される最小タイムスタンプ(除く)を示します。このタイムスタンプ以降にウェイポイントが変更されていない場合、レスポンスには vehicle.waypoints データが設定されません。このフィールドが指定されていない場合、常に vehicle.waypoints が取得されます。

LicensePlate

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

フィールド
country_code

string

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

last_character

string

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

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

ListVehiclesRequest

ListVehicles リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

parent

string

必須。providers/{provider} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

page_size

int32

返される車両の最大数。デフォルト値: 100。

page_token

string

ListVehicles の前の呼び出しで提供された next_page_token の値。これにより、車両のグループをページネーションできます。リクエストのフィルタ条件が、ListVehicles の前の呼び出しのフィルタ条件と異なる場合、値は未定義です。

minimum_capacity

Int32Value

車両に必要な最小容量を指定します。返されるすべての車両の maximum_capacity は、この値以上になります。設定する場合は、0 以上の値を指定する必要があります。

trip_types[]

TripType

指定されたルートタイプの少なくとも 1 つをサポートする車両にレスポンスを制限します。

maximum_staleness

Duration

指定された期間内に位置情報の更新を Fleet Engine に送信した車両にのみレスポンスを制限します。位置情報を送信し続けている駐車中の車両は、古い位置情報とは見なされません。指定する場合は、有効な正の期間にする必要があります。

vehicle_type_categories[]

Category

必須。指定したタイプのカテゴリのいずれかに該当する車両にレスポンスを制限します。UNKNOWN は許可されていません。

required_attributes[]

string

呼び出し元は、required_attributes フィールド、required_one_of_attributes フィールド、required_one_of_attribute_sets フィールドの任意の組み合わせを使用して、複雑な論理演算を形成できます。

required_attributes はリストです。required_one_of_attributes は、リストのリストを許可するメッセージを使用します。これらの 2 つのフィールドを組み合わせることで、次の式を作成できます。

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

指定した属性を持つ車両にレスポンスを制限します。このフィールドは連結演算(AND 演算)です。required_attributes は最大 50 個まで指定できます。これは、車両で許可される属性の最大数と一致します。繰り返し使用する文字列は、すべて「key:value」形式にする必要があります。

required_one_of_attributes[]

string

VehicleAttributeList で指定された属性の少なくとも 1 つを持つ車両にレスポンスを制限します。各リスト内の車両は、少なくとも 1 つの属性と一致する必要があります。このフィールドは、各 VehicleAttributeList の包含排除論理和/OR 演算と、VehicleAttributeList のコレクション全体の連結/AND 演算です。繰り返し文字列は、それぞれ「key1:value1|key2:value2|key3:value3」の形式にする必要があります。

required_one_of_attribute_sets[]

string

required_one_of_attribute_sets は追加機能を提供します。

required_one_of_attributes と同様に、required_one_of_attribute_sets はリストのリストを許可するメッセージを使用します。これにより、次のような式を使用できます。

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

VehicleAttributeList のすべての属性に一致する車両にレスポンスを制限します。各リスト内の車両は、すべての属性と一致している必要があります。このフィールドは、各 VehicleAttributeList の連結演算子(AND)と、VehicleAttributeList のコレクション全体の包含排除演算子(OR)です。繰り返し文字列は、それぞれ「key1:value1|key2:value2|key3:value3」の形式にする必要があります。

vehicle_state

VehicleState

この車両の状態を持つ車両にレスポンスを制限します。

on_trip_only

bool

現在のルートがある車両のみを返します。

filter

string

省略可。車両のリスティング時に適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。

このフィールドは、required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets フィールドに代わるものです。ここで空でない値を指定する場合、required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets の各フィールドは空にする必要があります。

このフィルタは、vehicle_stateon_trip_only などの他の制約とともに AND 句として機能します。

サポートされているクエリは、車両属性(attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2> など)に関するクエリのみです。フィルタクエリで許可される制限の最大数は 50 です。

また、すべての属性は文字列として保存されるため、属性に対してサポートされている比較は文字列比較のみです。数値またはブール値と比較するには、値を明示的に引用符で囲んで文字列として扱う必要があります(例: attributes.<key> = "10"attributes.<key> = "true")。

viewport

Viewport

省略可。ビューポートで定義された長方形の領域内に直近の位置情報がある車両のみを返すフィルタ。

ListVehiclesResponse

ListVehicles レスポンス メッセージ。

フィールド
vehicles[]

Vehicle

リクエストの条件に一致する車両。返される車両の最大数は、リクエストの page_size フィールドによって決まります。

next_page_token

string

車両の次のページを取得するためのトークン。リクエスト条件を満たす車両が他にない場合は空です。

total_size

int64

必須。すべてのページにわたってリクエスト条件に一致する車両の総数。

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 はプロバイダへのすべてのリクエストをスロットリングします。

LocationSensor

位置情報の特定に使用されたセンサーまたは方法。

列挙型
UNKNOWN_SENSOR センサーが指定されていないか不明です。
GPS GPS または A-GPS。
NETWORK アシスト GPS、基地局 ID、Wi-Fi アクセス ポイント。
PASSIVE 基地局 ID または Wi-Fi アクセス ポイント。
ROAD_SNAPPED_LOCATION_PROVIDER モバイル デバイスによって道路上の位置として最も可能性が高いと判断された位置。
CUSTOMER_SUPPLIED_LOCATION お客様が提供した、独立したソースの住所。通常、この値は、Driver SDK を実行しているモバイル デバイス以外のソースから提供される位置情報に使用されます。元の情報源が他の列挙値のいずれかで記述されている場合は、その値を使用します。CUSTOMER_SUPPLIED_LOCATION とマークされたロケーションは、通常、車両の last_location.supplemental_location_sensor を介して提供されます。
FLEET_ENGINE_LOCATION 利用可能なシグナルに基づいて Fleet Engine によって計算された位置情報。出力専用。この値は、リクエストで受信された場合、拒否されます。
FUSED_LOCATION_PROVIDER Android の Fused Location Provider。
CORE_LOCATION Apple オペレーティング システム上の位置情報プロバイダ。

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

列挙型
UNKNOWN_NAVIGATION_STATUS ナビゲーション ステータスが未指定。
NO_GUIDANCE ドライバー アプリのナビゲーションが FREE_NAV モードになっている。
ENROUTE_TO_DESTINATION ターンバイターン方式ナビが利用可能で、ドライバー アプリのナビゲーションが GUIDED_NAV モードになっている。
OFF_ROUTE 車両がおすすめの経路から外れた。
ARRIVED_AT_DESTINATION 車両が目的地から約 50 m 以内にある。

PolylineFormatType

ポリライン形式のタイプ。

列挙型
UNKNOWN_FORMAT_TYPE 形式が指定されていないか不明です。
LAT_LNG_LIST_TYPE google.type.LatLng のリスト。
ENCODED_POLYLINE_TYPE ポリライン圧縮アルゴリズムでエンコードされたポリライン。デコードはまだサポートされていません。

PowerSource

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

列挙型
UNKNOWN_POWER_SOURCE 電源は不明です。
POWER_SOURCE_AC 電源は AC 充電器です。
POWER_SOURCE_USB 電源は USB ポートです。
POWER_SOURCE_WIRELESS 電源がワイヤレスである。
POWER_SOURCE_UNPLUGGED 電池が外れている。

ReportBillableTripRequest

ReportBillableTrip リクエスト メッセージ。

フィールド
name

string

必須。providers/{provider}/billableTrips/{billable_trip} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

country_code

string

必須。旅行が行われる国の 2 文字の国コード。価格は国コードに応じて定義されます。

platform

BillingPlatformIdentifier

リクエストが発行されたプラットフォーム。

related_ids[]

string

報告されたルートに直接関連する識別子。通常、これらは、ルート ID が利用可能になる前に行われた事前予約オペレーションの ID(セッション ID など)です。related_ids の数は 50 個に制限されています。

solution_type

SolutionType

報告されたルートに使用された GMP プロダクト ソリューションのタイプ(ON_DEMAND_RIDESHARING_AND_DELIVERIES など)。

ソリューション タイプ

報告されたルートのさまざまなソリューション タイプを選択するセレクタ。

列挙型
SOLUTION_TYPE_UNSPECIFIED デフォルト値。下位互換性を確保するため、API はデフォルトで ON_DEMAND_RIDESHARING_AND_DELIVERIES を使用します。これは、最初にサポートされたソリューション タイプです。
ON_DEMAND_RIDESHARING_AND_DELIVERIES 解決策は、オンデマンドの配車と配達のルートです。

RequestHeader

RequestHeader には、すべての Fleet Engine RPC リクエストに共通のフィールドが含まれています。

フィールド
language_code

string

BCP-47 言語コード(en-US や sr-Latn など)。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier を参照してください。指定しない場合、レスポンスは任意の言語で返されます。名前が存在する場合は、英語が優先されます。フィールド値の例: en-US

region_code

string

必須。リクエストの発信元の地域の CLDR 地域コード。フィールド値の例: US

sdk_version

string

呼び出し元の SDK のバージョン(該当する場合)。バージョン形式は「major.minor.patch」です(例: 1.1.2)。

os_version

string

呼び出し元の SDK が実行されているオペレーティング システムのバージョン。フィールド値の例: 4.4.112.1

device_model

string

呼び出し元の SDK が実行されているデバイスのモデル。フィールド値の例: iPhone12,1SM-G920F

sdk_type

SdkType

リクエストを送信する SDK のタイプ。

maps_sdk_version

string

呼び出し元の SDK が依存する MapSDK のバージョン(該当する場合)。バージョン形式は「major.minor.patch」です(例: 5.2.1)。

nav_sdk_version

string

呼び出し元の SDK が依存する NavSDK のバージョン(該当する場合)。バージョン形式は「major.minor.patch」です(例: 2.1.0)。

platform

Platform

呼び出し元の SDK のプラットフォーム。

manufacturer

string

呼び出し元の SDK の Android デバイスのメーカー。Android SDK にのみ適用されます。フィールド値の例: Samsung

android_api_level

int32

呼び出し元の SDK の Android API レベル。Android SDK にのみ適用されます。フィールド値の例: 23

trace_id

string

リクエストを識別するためにロギング目的で指定できる ID(省略可)。

プラットフォーム

呼び出し元の SDK のプラットフォーム。

列挙型
PLATFORM_UNSPECIFIED デフォルト値。この値は、プラットフォームを省略した場合に使用されます。
ANDROID リクエストの送信元が Android である。
IOS リクエストの送信元が iOS である。
WEB リクエストはウェブから送信されます。

SdkType

使用できる SDK のタイプ。

列挙型
SDK_TYPE_UNSPECIFIED デフォルト値。この値は、sdk_type が省略されている場合に使用されます。
CONSUMER 呼び出し元の SDK は Consumer です。
DRIVER 呼び出し元の SDK は Driver です。
JAVASCRIPT 呼び出し元の SDK が JavaScript である。

SearchTripsRequest

SearchTrips リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

parent

string

必須。providers/{provider} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

vehicle_id

string

リクエスト内のルートに関連付けられている車両。指定しない場合、返されるルートには次のものが含まれません。

  • current_route_segment
  • remaining_waypoints
  • remaining_distance_meters
  • eta_to_first_waypoint
active_trips_only

bool

true に設定すると、ドライバーのルートに影響するルートを含むレスポンスが返されます。

page_size

int32

設定しない場合、サーバーは返される結果の数を決定します。

page_token

string

前の検索結果から続行するには、この値を SearchTripsResponse で以前に返された値に設定します。

minimum_staleness

Duration

指定した場合、時間 (current - minimum_staleness) 以降に更新されていないルートを返します。

SearchTripsResponse

SearchTrips レスポンス メッセージ。

フィールド
trips[]

Trip

リクエストされた車両のルートのリスト。

next_page_token

string

このトークンを SearchTripsRequest で渡して、リスト結果をページングします。API は呼び出しごとにルートリストが返され、結果が残っていない場合はルートリストが空になります。

SearchVehiclesRequest

SearchVehicles リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

parent

string

必須。providers/{provider} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

pickup_point

TerminalLocation

必須。近くの集荷所。

dropoff_point

TerminalLocation

お客様が指定した集荷場所。trip_typesTripType.SHARED が含まれている場合は、このフィールドは必須です。

pickup_radius_meters

int32

必須。集合場所の周囲の車両検索範囲を定義します。検索範囲内の車両のみが返されます。値は 400 ~ 10,000 メートルの範囲で指定する必要があります。

count

int32

必須。返される車両の最大数を指定します。値は 1 ~ 50 の範囲で指定してください。

minimum_capacity

int32

必須。ルートで考慮される乗客数を指定します。1 以上の値を指定してください。ドライバは容量値に含まれません。

trip_types[]

TripType

必須。提案されたルートのタイプを表します。タイプは 1 つだけ含める必要があります。UNKNOWN_TRIP_TYPE は使用できません。そのルートタイプに対応できる車両のみを検索対象にします。

maximum_staleness

Duration

指定した期間内に位置情報の更新を Fleet Engine に送信した車両のみを検索対象にします。位置情報を送信し続けている駐車中の車両は、古い位置情報とは見なされません。このフィールドが設定されていない場合、サーバーはデフォルト値として 5 分を指定します。

vehicle_types[]

VehicleType

必須。指定したタイプのいずれかの車両に検索を限定します。少なくとも 1 つの車両タイプを指定する必要があります。カテゴリが UNKNOWN の VehicleTypes は使用できません。

required_attributes[]

VehicleAttribute

呼び出し元は、required_attributes フィールド、required_one_of_attributes フィールド、required_one_of_attribute_sets フィールドを任意に組み合わせて、複雑な論理演算を形成できます。

required_attributes はリストです。required_one_of_attributes は、リストのリストを許可するメッセージを使用します。これらの 2 つのフィールドを組み合わせることで、次の式を作成できます。

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(required_one_of_attributes[0][0] OR required_one_of_attributes[0][1] OR
...)
AND
(required_one_of_attributes[1][0] OR required_one_of_attributes[1][1] OR
...)

指定した属性を持つ車両のみを検索対象に制限します。このフィールドは連結演算(AND 演算)です。required_attributes は最大 50 個まで指定できます。これは、車両で許可される属性の最大数と一致します。

required_one_of_attributes[]

VehicleAttributeList

VehicleAttributeList で指定された属性の少なくとも 1 つを持つ車両のみを検索対象に制限します。各リスト内の車両は、少なくとも 1 つの属性と一致する必要があります。このフィールドは、各 VehicleAttributeList の包含排除論理和/OR 演算と、VehicleAttributeList のコレクション全体の連結/AND 演算です。

required_one_of_attribute_sets[]

VehicleAttributeList

required_one_of_attribute_sets は追加機能を提供します。

required_one_of_attributes と同様に、required_one_of_attribute_sets はリストのリストを許可するメッセージを使用します。これにより、次のような式を使用できます。

(required_attributes[0] AND required_attributes[1] AND ...)
AND
(
  (required_one_of_attribute_sets[0][0] AND
  required_one_of_attribute_sets[0][1] AND
  ...)
  OR
  (required_one_of_attribute_sets[1][0] AND
  required_one_of_attribute_sets[1][1] AND
  ...)
)

VehicleAttributeList 内のすべての属性を持つ車両のみを検索対象に制限します。各リスト内の車両は、すべての属性と一致している必要があります。このフィールドは、各 VehicleAttributeList の連結演算子(AND)と、VehicleAttributeList のコレクション全体の包含排除演算子(OR)です。

order_by

VehicleMatchOrder

必須。結果の並べ替え条件を指定します。

include_back_to_back

bool

アクティブなルート 1 本の車両がこの検索の対象となるかどうかを示します。このフィールドは、current_trips_present が指定されていない場合にのみ使用されます。current_trips_present が指定されておらず、このフィールドが false の場合、ルート割り当て済みの車両は検索結果から除外されます。current_trips_present が指定されておらず、このフィールドが true の場合、検索結果には、ステータスが ENROUTE_TO_DROPOFF のアクティブなルートを 1 つ持つ車両が含まれることがあります。current_trips_present が指定されている場合、このフィールドを true に設定することはできません。

デフォルト値は false です。

trip_id

string

この SearchVehicleRequest に関連付けられているルートを示します。

current_trips_present

CurrentTripsPresent

アクティブなルートがある車両がこの検索の対象となるかどうかを示します。trip_typeSHARED が含まれている場合は、CURRENT_TRIPS_PRESENT_UNSPECIFIED 以外に設定する必要があります。

filter

string

省略可。車両の検索時に適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。

このフィールドは、required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets フィールドに代わるものです。ここで空でない値を指定する場合、required_attributesrequired_one_of_attributesrequired_one_of_attributes_sets の各フィールドは空にする必要があります。

このフィルタは、minimum_capacityvehicle_types などの他の制約とともに AND 句として機能します。

サポートされているクエリは、車両属性(attributes.<key> = <value>attributes.<key1> = <value1> AND attributes.<key2> = <value2> など)に対するクエリのみです。フィルタクエリで許可される制限の最大数は 50 です。

また、すべての属性は文字列として保存されるため、属性に対してサポートされている比較は文字列比較のみです。数値またはブール値と比較するには、値を明示的に引用符で囲んで文字列として扱う必要があります(例: attributes.<key> = "10"attributes.<key> = "true")。

CurrentTripsPresent

車両の現在のルートに対する制限の種類を指定します。

列挙型
CURRENT_TRIPS_PRESENT_UNSPECIFIED ルートがある車両の空き状況は、include_back_to_back フィールドによって管理されます。
NONE ルートのない車両が検索結果に表示されることがあります。この値を使用する場合、include_back_to_backtrue にできません。
ANY 検索結果には、現在のルートの数が 5 回以下で、経由地点が 10 個以下の車両が含まれます。この値を使用する場合、include_back_to_backtrue にできません。

VehicleMatchOrder

レスポンスでの車両の一致順序を指定します。

列挙型
UNKNOWN_VEHICLE_MATCH_ORDER デフォルト。指定されていない車両または認識できない車両の一致オーダーに使用されます。
PICKUP_POINT_ETA 集荷場所までの車での所要時間の昇順。
PICKUP_POINT_DISTANCE 集荷場所までの車両の走行距離が短い順に表示されます。
DROPOFF_POINT_ETA 配送先までの車での所要時間の昇順。この順序は、配送先がリクエストで指定されている場合にのみ使用できます。
PICKUP_POINT_STRAIGHT_DISTANCE 車両の最終報告地点から乗車地点までの直線距離が短い順に表示されます。
COST 設定されたマッチ費用の昇順。マッチ費用は、直線距離と到着予定時刻の加重計算として定義されます。重み付けはデフォルト値で設定され、お客様ごとに変更できます。プロジェクトでこれらの重みを変更する必要がある場合は、Google サポートにお問い合わせください。

SearchVehiclesResponse

SearchVehicles レスポンス メッセージ。

フィールド
matches[]

VehicleMatch

SearchVehiclesRequest 条件に一致する車両のリスト(SearchVehiclesRequest.order_by フィールドの順序で並べ替え)。

SpeedReadingInterval

経路の連続するセグメントの交通密度インジケーター。ポイント P_0、P_1、...、P_N(ゼロベースのインデックス)を含むパスに対して、SpeedReadingInterval は区間を定義し、次のカテゴリを使用してトラフィックを記述します。

フィールド
start_polyline_point_index

int32

パス内のこの区間の開始インデックス。JSON では、インデックスが 0 の場合、フィールドは未入力と見なされます。

end_polyline_point_index

int32

パス内のこの区間の終了インデックス。JSON では、インデックスが 0 の場合、フィールドは未入力と見なされます。

speed

Speed

この区間の交通速度。

速度

交通データに基づくポリライン速度の分類。

列挙型
SPEED_UNSPECIFIED デフォルト値。この値は使用されません。
NORMAL 通常の速度で、速度低下は検知されません。
SLOW 速度低下は検出されたが、渋滞は発生していない。
TRAFFIC_JAM 渋滞を検出しました。

StopLocation

停車(乗車/降車)が行われた実際の場所。

フィールド
point

LatLng

必須。実際の場所を表します。

timestamp

Timestamp

停止が発生した日時を示します。

stop_time
(deprecated)

Timestamp

入力のみの非推奨です。タイムスタンプ フィールドを使用します。

TerminalLocation

ウェイポイントの位置を記述します。

フィールド
point

LatLng

必須。ルートのウェイポイントの位置を示します。

terminal_point_id
(deprecated)

TerminalPointId

非推奨: 代わりに point フィールドを指定してください。

access_point_id
(deprecated)

string

非推奨: 代わりに point フィールドを指定してください。

trip_id
(deprecated)

string

サポート終了。

terminal_location_type
(deprecated)

WaypointType

非推奨: Vehicle.waypoint にこのデータが含まれます。

TerminalPointId

非推奨: TerminalPoints は Fleet Engine でサポートされなくなりました。TerminalLocation.point を代わりに使用してください。

フィールド
value
(deprecated)

string

サポート終了。

共用体フィールド Id。非推奨です。Id は次のいずれかになります。
place_id
(deprecated)

string

サポート終了。

generated_id
(deprecated)

string

サポート終了。

TrafficPolylineData

車両の予想ルートの交通状況。

フィールド
traffic_rendering

VisualTrafficReportPolylineRendering

お客様の乗車ルートの区間全体のすべての地域の交通状況をポリラインでレンダリングしたものです。

ルート

ルートのメタデータ。

フィールド
name

string

出力専用。形式は「providers/{provider}/trips/{trip}」です。

vehicle_id

string

このルートを運行する車両の ID。

trip_status

TripStatus

ルートの現在のステータス。

trip_type

TripType

ルートのタイプ。

pickup_point

TerminalLocation

お客様が集荷場所として指定した場所。

actual_pickup_point

StopLocation

入力のみのお客様が実際にピックアップされた場所と時間。このフィールドは、実際の集荷情報に関するフィードバックをプロバイダが提供するものです。

actual_pickup_arrival_point

StopLocation

入力のみのドライバーが集合場所に到着した実際の時刻と場所。このフィールドは、集荷場所での実際の到着情報について、運送業者がフィードバックを提供するものです。

pickup_time

Timestamp

出力専用。乗客の乗車予定時刻または乗車した実際の時刻。

intermediate_destinations[]

TerminalLocation

乗車地と降車地のほかに、乗車リクエストの途中停留所。当初は、共有ルートではサポートされません。

intermediate_destinations_version

Timestamp

intermediate_destinations が最後に変更された日時を示します。サーバーは、この値をキャッシュに保存し、intermediate_destination_index の更新時に UpdateTripRequest に渡して、intermediate_destinations が変更されないようにする必要があります。

intermediate_destination_index

int32

TripStatusENROUTE_TO_INTERMEDIATE_DESTINATION の場合、車両が次に通過する中間目的地を示す [0..N-1] の数値。TripStatusARRIVED_AT_INTERMEDIATE_DESTINATION の場合、車両が現在位置している中間目的地を示す [0..N-1] の数値。この値はプロバイダが設定します。intermediate_destinations がない場合、このフィールドは無視されます。

actual_intermediate_destination_arrival_points[]

StopLocation

入力のみのドライバーが中間地点に到着した実際の時刻と場所。このフィールドは、プロバイダが中間地点の実際の到着情報に関するフィードバックを提供するものです。

actual_intermediate_destinations[]

StopLocation

入力のみのお客様が中間地点から乗車した実際の時間と場所。このフィールドは、中間地点での実際の集荷情報について、運送業者がフィードバックを提供するものです。

dropoff_point

TerminalLocation

お客様が指定した配達先の場所。

actual_dropoff_point

StopLocation

入力のみのお客様を降ろした実際の時間と場所。このフィールドは、プロバイダが実際の降車情報に関するフィードバックを提供するものです。

dropoff_time

Timestamp

出力専用。乗客が最終目的地に降車する予定時刻または実際の降車時刻。

remaining_waypoints[]

TripWaypoint

出力専用。現在地から降車地点までのフルパス。この経路には、他のルートのウェイポイントが含まれている場合があります。

vehicle_waypoints[]

TripWaypoint

このフィールドでは、ルートの経由地を手動で並べ替えることができます。割り当てられた車両の残りのすべてのウェイポイントと、このルートの乗車と降車のウェイポイントが含まれます。ルート車両が割り当てられていない場合、このフィールドは無視されます。プライバシー上の理由から、このフィールドは GetTrip 呼び出しではなく、UpdateTrip 呼び出しと CreateTrip 呼び出しでのみサーバーが入力します。

route[]

LatLng

出力専用。remaining_waypoints の最初のエントリまでのこのルートの予想ルート。最初のウェイポイントは別のルートに属している場合があります。

current_route_segment

string

出力専用。次のウェイポイントへのエンコードされたパス。

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

current_route_segment_version

Timestamp

出力専用。ルートが最後に変更された日時を示します。

注: このフィールドは、Driver SDK と Consumer SDK でのみ使用することを目的としています。

current_route_segment_traffic

ConsumableTrafficPolyline

出力専用。current_route_segment 沿いの交通状況(利用可能な場合)を示します。

注: このフィールドは、Driver SDK と Consumer SDK でのみ使用することを目的としています。

current_route_segment_traffic_version

Timestamp

出力専用。current_route_segment_traffic が最後に変更された日時を示します。

注: このフィールドは、Driver SDK と Consumer SDK でのみ使用することを目的としています。

current_route_segment_end_point

TripWaypoint

出力専用。current_route_segment が終了するウェイポイント。

remaining_distance_meters

Int32Value

出力専用。残りの走行距離は current_route_segment フィールドに格納されます。ルート プランが車両に割り当てられていない場合、またはルート プランが完了またはキャンセルされている場合、値は指定されません。

eta_to_first_waypoint

Timestamp

出力専用。次のウェイポイントまでの所要時間(remaining_waypoints フィールドの最初のエントリ)。ルートが無効(完了またはキャンセル済み)の場合、またはルートが無効(完了またはキャンセル済み)の場合、値は指定されません。

remaining_time_to_first_waypoint

Duration

出力専用。ルートデータが返されたときから Trip.eta_to_first_waypoint の時間までの経過時間。ルートが無効(完了またはキャンセル済み)の場合、またはルートが無効(完了またはキャンセル済み)の場合、値は指定されません。

remaining_waypoints_version

Timestamp

出力専用。remaining_waypoints が最後に変更された日時(ウェイポイントが追加、削除、変更された日時)を示します。

remaining_waypoints_route_version

Timestamp

出力専用。remaining_waypoints.path_to_waypointremaining_waypoints.traffic_to_waypoint が最後に変更された日時を示します。クライアント アプリは、この値をキャッシュに保存し、GetTripRequest で渡して、remaining_waypoints のパスとトラフィックが更新された場合にのみ返されるようにする必要があります。

number_of_passengers

int32

変更不可。このルートの乗客数を示します。ドライバーは含まれません。SearchVehicles レスポンスで返される車両には、空き容量が必要です。

last_location

VehicleLocation

出力専用。ルート上の車両の最終報告位置を示します。

last_location_snappable

bool

出力専用。車両の last_location を current_route_segment にスナップできるかどうかを示します。last_location または current_route_segment が存在しない場合、false。これは Fleet Engine によって計算されます。クライアントからの更新は無視されます。

view

TripView

入力されるルート フィールドのサブセットと、その解釈方法。

TripStatus

ルートの進行状況を示すステータス。

列挙型
UNKNOWN_TRIP_STATUS デフォルト。指定されていないまたは認識できないルートのステータスに使用されます。
NEW 新しく作成されたルート。
ENROUTE_TO_PICKUP ドライバーが集合場所に向かっています。
ARRIVED_AT_PICKUP ドライバーが乗車地に到着しました。
ARRIVED_AT_INTERMEDIATE_DESTINATION ドライバーが中間地点に到着し、乗客を待機しています。
ENROUTE_TO_INTERMEDIATE_DESTINATION ドライバーが中間地点(降車地点ではない)に向かっている場合。
ENROUTE_TO_DROPOFF ドライバーが乗客を乗せて、次の目的地に向かっています。
COMPLETE 乗客を降ろして、乗車が完了しました。
CANCELED ドライバー、乗客、またはライドシェア プロバイダが乗車前にルートをキャンセルした。

TripType

ルートのタイプ。

列挙型
UNKNOWN_TRIP_TYPE デフォルト。指定されていないルートタイプまたは認識されないルートタイプに使用されます。
SHARED 他のルートと同じ車両を利用する場合があります。
EXCLUSIVE ルートには 1 台の車両のみが割り当てられます。

TripView

GetTrip レスポンスのさまざまなルート フィールドのセレクタ。コンテキストについては、AIP-157 をご覧ください。今後、追加のビューが追加される可能性があります。

列挙型
TRIP_VIEW_UNSPECIFIED デフォルト値。下位互換性を確保するため、API はデフォルトで SDK ビューになります。安定性とサポートを確保するため、SDK 以外の TripView を選択することをおすすめします。
SDK 一般公開されているライブラリでは解釈できない、またはサポートできないフィールドが含まれます。
JOURNEY_SHARING_V1S ルート フィールドは、ルート共有のユースケース用に入力されます。このビューは、サーバー間通信を対象としています。

TripWaypoint

車両のルートの停車地点または車両のルートの終点を表します。

フィールド
location

TerminalLocation

このウェイポイントの位置。

trip_id

string

このウェイポイントに関連付けられているルート。

waypoint_type

WaypointType

このルート内でのこのウェイポイントの役割(乗車地や降車地など)。

path_to_waypoint[]

LatLng

前のウェイポイントから現在のウェイポイントまでのパス。リスト内の最初のウェイポイントでは未定義です。このフィールドは、リクエストされた場合にのみ入力されます。

encoded_path_to_waypoint

string

前のウェイポイントから現在のウェイポイントまでのエンコードされたパス。

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

traffic_to_waypoint

ConsumableTrafficPolyline

このウェイポイントまでの経路の交通状況。トラフィックは、Google Maps Platform の乗車と配達ソリューションのお客様のみが利用できます。

distance_meters

Int32Value

前のウェイポイントから現在のウェイポイントまでのパスの距離。リスト内の最初のウェイポイントでは未定義です。

eta

Timestamp

このウェイポイントの予定到着時刻。リスト内の最初のウェイポイントでは未定義です。

duration

Duration

前のウェイポイントからこのポイントまでの所要時間。リスト内の最初のウェイポイントでは未定義です。

UpdateTripRequest

更新されたルートのリクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

name

string

必須。providers/{provider}/trips/{trip} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-consumer-project など)にする必要があります。

trip

Trip

必須。更新に関連付けられたルート。

次のフィールドは Fleet Engine によって維持されます。Trip.update を使用して更新しないでください。

  • current_route_segment
  • current_route_segment_end_point
  • current_route_segment_traffic
  • current_route_segment_traffic_version
  • current_route_segment_version
  • dropoff_time
  • eta_to_next_waypoint
  • intermediate_destinations_version
  • last_location
  • name
  • number_of_passengers
  • pickup_time
  • remaining_distance_meters
  • remaining_time_to_first_waypoint
  • remaining_waypoints
  • remaining_waypoints_version
  • route

共有ルートの Trip.vehicle_id を更新する場合は、残りのウェイポイントの順序を指定するために Trip.vehicle_waypoints のリストを指定する必要があります。指定しない場合、順序は未定義になります。

Trip.vehicle_waypoints を指定する場合は、リストに車両のルートの残りのすべてのウェイポイントを含める必要があります。余分なウェイポイントは含めないでください。これらのウェイポイントは、特定のルートについて、乗車地が中間目的地の前に、すべての中間目的地が降車地の前に来るように順序付ける必要があります。EXCLUSIVE ルートのウェイポイントは、他のルートのウェイポイントと重複してはいけません。trip_idwaypoint_typelocation フィールドが使用され、vehicle_waypoints の他のすべての TripWaypoint フィールドは無視されます。

複数の目的地があるルートで競合状態を回避するには、ルートのステータスを ENROUTE_TO_INTERMEDIATE_DESTINATION に更新するときに Trip.intermediate_destinations_version を指定する必要があります。渡される Trip.intermediate_destinations_version は、Fleet Engine のバージョンと一致している必要があります。一致しない場合、リクエストは失敗します。

update_mask

FieldMask

必須。更新するルートのフィールドを示すフィールド マスク。update_mask には、少なくとも 1 つのフィールドを含める必要があります。

UpdateVehicleAttributesRequest

UpdateVehicleAttributes リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

name

string

必須。providers/{provider}/vehicles/{vehicle} の形式で指定してください。プロバイダは、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

attributes[]

VehicleAttribute

必須。更新する車両属性。言及されていない属性は変更または削除されません。

UpdateVehicleAttributesResponse

UpdateVehicleAttributes レスポンス メッセージ。

フィールド
attributes[]

VehicleAttribute

必須。車両属性の最新の完全なリスト(新規、変更済み、変更なしの属性を含む)。

UpdateVehicleRequest

UpdateVehicle リクエスト メッセージ。

フィールド
header

RequestHeader

標準の Fleet Engine リクエスト ヘッダー。

name

string

必須。providers/{provider}/vehicles/{vehicle} の形式で指定してください。{provider} は、この呼び出しを行うサービス アカウントがメンバーである Google Cloud プロジェクトのプロジェクト ID(sample-cloud-project など)にする必要があります。

vehicle

Vehicle

必須。適用する Vehicle エンティティ値。Vehicle を更新するときに、次のフィールドはサーバーによって管理されているため、更新されないことがあります。

  • available_capacity
  • current_route_segment_version
  • current_trips
  • name
  • waypoints_version

attributes フィールドが更新されると、車両の属性がすべてリクエストで指定された属性に置き換えられます。一部の属性のみを更新する場合は、UpdateVehicleAttributes メソッドをご覧ください。

同様に、waypoints フィールドは更新できますが、現在車両にあるすべてのウェイポイントを含める必要があります。他のウェイポイントを含めることはできません。

update_mask

FieldMask

必須。更新する Vehicle のフィールドを示すフィールド マスク。フィールド名を少なくとも 1 つ指定する必要があります。

車両

車両のメタデータ。

フィールド
name

string

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

vehicle_state

VehicleState

車両の状態。

supported_trip_types[]

TripType

この車両でサポートされているルートの種類。

current_trips[]

string

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

last_location

VehicleLocation

車両の最終報告地点。

maximum_capacity

int32

この車両が乗車できる乗客の総数。この値にはドライバーは含まれません。1 以上の値を指定してください。

attributes[]

VehicleAttribute

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

vehicle_type

VehicleType

必須。この車両のタイプ。SearchVehicles の結果で車両をフィルタするために使用できます。所要時間とルートの計算にも影響します。

license_plate

LicensePlate

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

route[]
(deprecated)

TerminalLocation

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

current_route_segment

string

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

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

current_route_segment_traffic

TrafficPolylineData

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

current_route_segment_version

Timestamp

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

current_route_segment_end_point

TripWaypoint

current_route_segment が終了するウェイポイント。これは、UpdateVehicle 呼び出しで、完全なルートのウェイポイント、ウェイポイント LatLng、または current_route_segment の最後の LatLng としてドライバーから指定できます。完全な指定がない場合、Fleet Engine は実際のウェイポイントに補間します。current_route_segment も指定しない限り、このフィールドは UpdateVehicle 呼び出しで無視されます。

remaining_distance_meters

Int32Value

current_route_segment の残りの走行距離。この値は、車両に割り当てられているすべてのアクティブなルートの Trip.remaining_distance_meters でも返されます。current_route_segment フィールドが空の場合、値は指定されません。

eta_to_first_waypoint

Timestamp

waypoints フィールドの最初のエントリまでの推定所要時間。waypoints フィールドまたは Vehicle.current_route_segment フィールドが空の場合、値は指定されません。

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

remaining_time_seconds

Int32Value

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

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

waypoints[]

TripWaypoint

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

waypoints_version

Timestamp

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

back_to_back_enabled

bool

ドライバーが連続した乗車を受け入れているかどうかを示します。true の場合、SearchVehicles には、現在ルートに割り当てられている車両も含まれる場合があります。デフォルト値は false です。

navigation_status

NavigationStatus

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

device_settings

DeviceSettings

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

VehicleType

車両の種類。

フィールド
category

Category

車種のカテゴリ

カテゴリ

車種のカテゴリ

列挙型
UNKNOWN デフォルト。指定されていない車両カテゴリまたは認識できない車両カテゴリに使用されます。
AUTO 自動車。
TAXI タクシーとして機能する車両(通常はライセンスまたは規制対象)。
TRUCK 通常、大容量のストレージを備えた車両。
TWO_WHEELER オートバイ、原付き、その他の 2 輪車
BICYCLE 人力による移動手段。
PEDESTRIAN 歩行者専用道路を歩行または走行している人間の移動体。

VehicleAttribute

車両属性を Key-Value ペアとして記述します。「key:value」文字列の長さは 256 文字を超えることはできません。

フィールド
key

string

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

value

string

属性の値。

共用体フィールド vehicle_attribute_value。属性の値は、文字列、ブール値、または double 型にすることができます。vehicle_attribute_value は次のいずれかになります。
string_value

string

文字列型の属性値。

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

bool_value

bool

ブール型の属性値。

number_value

double

倍精度型の属性値。

VehicleAttributeList

車両属性のリスト内のリストのデータ型。

フィールド
attributes[]

VehicleAttribute

このコレクションの属性のリスト。

VehicleLocation

特定の時点での車両の位置、速度、進行方向。

フィールド
location

LatLng

車両の場所。Fleet Engine に送信される車両の位置情報は GPS 位置情報です。レスポンスで受け取る車両の位置情報は、GPS 位置情報、補足位置情報、その他の推定位置情報のいずれかです。ソースは location_sensor で指定します。

horizontal_accuracy
(deprecated)

DoubleValue

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

latlng_accuracy

DoubleValue

半径として location メートルの精度。

heading

Int32Value

車両が移動している方向(度単位)。0 は北を表します。有効な範囲は [0,360] です。

bearing_accuracy
(deprecated)

DoubleValue

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

heading_accuracy

DoubleValue

精度は heading 度です。

altitude

DoubleValue

WGS84 を基準とした標高(メートル)。

vertical_accuracy
(deprecated)

DoubleValue

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

altitude_accuracy

DoubleValue

精度 altitude(メートル単位)。

speed_kmph
(deprecated)

Int32Value

車両の速度(時速キロメートル)。非推奨: 代わりに、speed を使用してください。

speed

DoubleValue

車両の速度(メートル/秒)

speed_accuracy

DoubleValue

speed の精度(メートル/秒)。

update_time

Timestamp

センサーのクロックに基づいて、センサーから location が報告された時刻。

server_time

Timestamp

出力専用。サーバーが位置情報を受信した時刻。

location_sensor

LocationSensor

位置情報のプロバイダ(GPS など)。

is_road_snapped

BoolValue

location が道路にスナップされているかどうか。

is_gps_sensor_enabled

BoolValue

入力のみのモバイル デバイスで GPS センサーが有効になっているかどうかを示します。

time_since_update

Int32Value

入力のみのこの位置情報がサーバーに最初に送信されてからの時間(秒)。最初の更新ではゼロになります。時刻が不明な場合(アプリの再起動時など)は、この値は 0 にリセットされます。

num_stale_updates
(deprecated)

Int32Value

入力のみの非推奨: 位置情報が古いかどうかを判断するために、他のシグナルが使用されるようになりました。

raw_location

LatLng

未加工の車両位置(道路スナッパで処理されていない)。

raw_location_time

Timestamp

元の位置情報に関連付けられたタイムスタンプ。

raw_location_sensor

LocationSensor

元の位置情報のソース。デフォルトは GPS です。

raw_location_accuracy

DoubleValue

raw_location の精度(半径として、メートル単位)。

supplemental_location

LatLng

統合アプリが提供する補足的な位置情報。

supplemental_location_time

Timestamp

補足の場所に関連付けられたタイムスタンプ。

supplemental_location_sensor

LocationSensor

補足情報の場所のソース。デフォルトは CUSTOMER_SUPPLIED_LOCATION です。

supplemental_location_accuracy

DoubleValue

supplemental_location の精度(半径として、メートル単位)。

road_snapped
(deprecated)

bool

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

VehicleMatch

車両 SearchVehiclesRequest のアクティブなルートのポイントに一致する車両と、その車両の関連する推定値が含まれます。

フィールド
vehicle

Vehicle

必須。リクエストに一致する車両。

vehicle_pickup_eta

Timestamp

リクエストで指定された集荷場所までの車両の到着予定時刻。値が空白の場合は、車両の到着予定時刻の計算に失敗したことを示します。SearchVehiclesRequest.include_back_to_backtrue で、この車両にアクティブなルートがある場合、vehicle_pickup_eta には現在のアクティブなルートを完了するために必要な時間が含まれます。

vehicle_pickup_distance_meters

Int32Value

車両の現在地からリクエストで指定された乗車地までの距離(既存のルートの途中の乗車地や降車地を含む)。この距離は、計算された運転(ルート)距離と、ナビゲーションの終点とリクエストされた乗車地点間の直線距離で構成されます。(通常、ナビの目的地とリクエストされた集合場所の距離は短いです)。値が空の場合は、距離の計算中にエラーが発生したことを示します。

vehicle_pickup_straight_line_distance_meters

Int32Value

必須。車両とリクエストで指定された集合場所との直線距離。

vehicle_dropoff_eta

Timestamp

リクエストで指定された降車地点までの車両の総走行所要時間。所要時間には、リクエストで指定された dropoff_point の前に立ち寄る地点での停車時間も含まれます。この値は、リクエストで集荷ポイントが指定されている場合にのみ入力されます。値が空の場合は、所要時間の計算中にエラーが発生したことを示します。

vehicle_pickup_to_dropoff_distance_meters

Int32Value

リクエストで指定された集荷地から降車地までの車両の走行距離(メートル単位)。距離は 2 つのポイント間の距離のみで、車両の位置や、車両が乗車地点または降車地点に到着する前に訪問する必要があるその他のポイントは含まれません。この値は、リクエストで dropoff_point が指定されている場合にのみ入力されます。値が空の場合、リクエストで指定された集荷地から降車地までの距離の計算に失敗したことを示します。

trip_type

TripType

必須。乗車地点までの到着予定時間を計算するために使用されたリクエストのルートタイプ。

vehicle_trips_waypoints[]

Waypoint

所要時間の計算に使用されるウェイポイントの順序付きリスト。このリストには、車両の位置情報、車両のアクティブなルートの乗車地、リクエストで指定された乗車地が含まれます。リストが空の場合は、車両の到着予定時刻の計算に失敗したことを示します。

vehicle_match_type

VehicleMatchType

車両の一致のタイプ。

requested_ordered_by

VehicleMatchOrder

車両の一致を並べ替えるためにリクエストされた順序。ordered_by と同じです。

ordered_by

VehicleMatchOrder

車両の一致を並べ替えるためにリクエストされた順序。requested_ordered_by と同じです。

VehicleMatchType

車両の一致のタイプ。

列挙型
UNKNOWN 不明な車両の一致タイプ
EXCLUSIVE 車両には現在ルートがなく、乗車地点に移動できます。
BACK_TO_BACK 車両は現在ルートに割り当てられていますが、進行中のルートを完了した後に乗車地点に移動できます。到着予定時刻と距離の計算では、既存のルートも考慮されます。
CARPOOL 車両に相乗りに十分な座席がある。
CARPOOL_BACK_TO_BACK 車両は、現在進行中のルートを完了してから、乗車地点に向かいます。到着予定時刻と距離の計算では、既存のルートも考慮されます。

VehicleState

Vehicle の状態。

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

VisualTrafficReportPolylineRendering

クライアントがルート沿いのポリラインの一部に色を付ける方法を記述します。

フィールド
road_stretch[]

RoadStretch

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

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

RoadStretch

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

フィールド
style

Style

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

offset_meters

int32

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

length_meters

int32

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

スタイル

交通状況のスタイル。交通の速度を示します。

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

ウェイポイント

SearchVehiclesResponseVehicleMatch のルート上の中間点を記述します。このコンセプトは、他のすべてのエンドポイントで TripWaypoint として表されます。

フィールド
lat_lng

LatLng

このウェイポイントの位置。

eta

Timestamp

車両がこのウェイポイントに到着する予定時刻。

WaypointType

ウェイポイントのタイプ。

列挙型
UNKNOWN_WAYPOINT_TYPE 不明なまたは未指定のウェイポイント タイプ。
PICKUP_WAYPOINT_TYPE 乗客や荷物の集荷地点。
DROP_OFF_WAYPOINT_TYPE 乗客や荷物を降ろすためのウェイポイント。
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE 複数の目的地を訪れるルートの中間地点のウェイポイント。