Package maps.fleetengine.v1

インデックス

TripService

旅行管理サービス。

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Fleet Engine で乗車を作成し、新しい乗車を返します。

DeleteTrip

rpc DeleteTrip(DeleteTripRequest) returns (Empty)

1 つの Trip を削除します。

乗車が有効で車両に割り当てられている場合は、FAILED_PRECONDITION を返します。

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

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

DeleteVehicle

rpc DeleteVehicle(DeleteVehicleRequest) returns (Empty)

Fleet Engine から車両を削除します。

車両に割り当てられているアクティブな乗車がある場合は、FAILED_PRECONDITION を返します。

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 では、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 フィールドはすべて無視されます。たとえば、作成リクエストで trip_statusCANCELED を渡しても、すべての乗車は trip_statusNEW で始まります。

EXCLUSIVE の乗車のみが intermediate_destinations をサポートします。

共有乗車で 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

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

  • vehicleState
  • supportedTripTypes
  • maximumCapacity
  • vehicleType

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

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

DeleteTripRequest

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

フィールド
header

RequestHeader

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

name

string

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

DeleteVehicleRequest

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

フィールド
header

RequestHeader

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

name

string

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

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

返されるべき Trip フィールドのサブセットとその解釈。

current_route_segment_version

Timestamp

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

remaining_waypoints_version
(deprecated)

Timestamp

非推奨: Trip.remaining_waypoints は常に取得されます。remaining_waypoints_route_version を使用して、Trip.remaining_waypoints.traffic_to_waypointTrip.remaining_waypoints.path_to_waypoint のデータを取得するタイミングを制御します。

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_attributesrequired_one_of_attributesrequired_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[]

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

「en-US」や「sr-Latn」などの BCP-47 言語コード。詳しくは、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 の VehicleType は許可されていません。

required_attributes[]

VehicleAttribute

呼び出し元は、required_attributesrequired_one_of_attributesrequired_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

地点の正確な LatLng を示します。point または place のいずれかを入力として指定する必要があります。両方が指定されている場合、ルーティングには point が使用され、メタデータには place が使用されます。入力として place のみが指定されている場合、pointplace から計算され、出力に含まれます。

place

string

このビジネスを表す場所のリソース名。形式は places/{place_id} です。point または place のいずれかを入力として指定する必要があります。両方が指定されている場合、ルーティングには point が使用され、メタデータには place が使用されます。place は入力に含まれている場合にのみ出力に含まれます。つまり、LatLng から place のルックアップは実行されません。

この機能は試験運用中です。

point_location_source

PointSource

出力専用。point フィールドのソース。

terminal_point_id
(deprecated)

TerminalPointId

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

access_point_id
(deprecated)

string

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

trip_id
(deprecated)

string

サポート終了。

terminal_location_type
(deprecated)

WaypointType

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

PointSource

LatLng のソースを示します。

列挙型
POINT_SOURCE_UNSPECIFIED ポイントソースが指定されていません。
POINT_SOURCE_DEVELOPER_PROVIDED LatLng はデベロッパーによって明示的に提供されました。
POINT_SOURCE_CALCULATED_FROM_PLACE LatLng は、指定された場所から計算されました。

TerminalPointId

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

フィールド
value
(deprecated)

string

サポート終了。

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

string

サポート終了。

generated_id
(deprecated)

string

サポート終了。

TrafficPolylineData

予想される車両ルートに沿った交通状況。

フィールド
traffic_rendering

VisualTrafficReportPolylineRendering

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

ルート

旅行のメタデータ。

フィールド
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

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

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

出力専用。次の経由地までの ETA(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

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

attributes[]

TripAttribute

カスタム乗車属性のリスト。各属性には一意のキーが必要です。

TripAttribute

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

フィールド
key

string

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

共用体フィールド trip_attribute_value。属性の値は、文字列、ブール値、または倍精度浮動小数点数型にできます。trip_attribute_value は次のいずれかになります。
string_value

string

文字列型の属性値。

bool_value

bool

ブール型の属性値。

number_value

double

倍精度型の属性値。

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 このルートは車両専用です。

TripView

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

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

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

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

フィールド
header

RequestHeader

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

name

string

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

trip

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

必須。更新する Trip のフィールドを示すフィールド マスク。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

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

past_locations[]

VehicleLocation

入力のみのこの車両が過去にいた場所のうち、まだ Fleet Engine に報告されていない場所。これは UpdateVehicleRequest で、以前サーバーに送信できなかった位置情報を記録するために使用されます。通常、これは車両がインターネットに接続されていない場合に発生します。

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 フィールドの最初のエントリまでの ETA。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_waypoint - current_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 オートバイ、原付、その他の二輪車
BICYCLE 人力による輸送。
PEDESTRIAN 歩行者用通路を移動する人。通常は歩行または走行しています。

VehicleAttribute

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

フィールド
key

string

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

value

string

属性の値。

共用体フィールド vehicle_attribute_value。属性の値は、文字列、ブール値、または倍精度浮動小数点数型にできます。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 になります。時間が不明な場合(アプリの再起動時など)、この値は 0 にリセットされます。

num_stale_updates
(deprecated)

Int32Value

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

raw_location

LatLng

車両の生の位置情報(道路スナッパーで処理されていない)。

raw_location_time

Timestamp

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

raw_location_sensor

LocationSensor

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

raw_location_accuracy

DoubleValue

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

flp_location

LatLng

Android の Fused Location Provider からの位置情報。

flp_update_time

Timestamp

flp_location のタイムスタンプを更新

flp_latlng_accuracy_meters

DoubleValue

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

flp_heading_degrees

Int32Value

Fused Location Provider によって決定された、車両の移動方向(度単位)。0 は北を表します。有効な範囲は [0,360) です。

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

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

vehicle_pickup_distance_meters

Int32Value

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

vehicle_pickup_straight_line_distance_meters

Int32Value

必須。リクエストで指定された車両と乗車地点の間の直線距離。

vehicle_dropoff_eta

Timestamp

リクエストで指定された降車地点までの車両の運転 ETA 全体。到着予定時刻には、リクエストで指定された dropoff_point の前に経由地に立ち寄る時間も含まれます。この値は、リクエストでドロップオフ ポイントが指定されている場合にのみ入力されます。値が空の場合は、到着予定時刻の計算でエラーが発生したことを示します。

vehicle_pickup_to_dropoff_distance_meters

Int32Value

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

trip_type

TripType

必須。乗車地点までの到着予定時刻の計算に使用されたリクエストの乗車タイプ。

vehicle_trips_waypoints[]

Waypoint

到着予定時刻の計算に使用される経由地の順序付きリスト。このリストには、車両の位置、車両の有効な乗車地点、リクエストで指定された乗車地点が含まれます。空のリストは、車両の ETA の計算が失敗したことを示します。

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

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

フィールド
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 複数の目的地がある旅行の中間地点の経由地。