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)

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

SearchFuzzedVehicles

rpc SearchFuzzedVehicles(SearchVehiclesRequest) returns (SearchVehiclesResponse)

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

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

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

  • 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

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

current_route_segment_version

Timestamp

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

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 未定義の 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 または Assisted 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

報告されたルートに使用される Google マーケティング プラットフォーム サービス ソリューションのタイプ(ON_DEMAND_RIDESHARING_AND_DELIVERIES など)。

SolutionType

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

列挙型
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 の 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

TerminalPointId

終点の ID。

access_point_id
(deprecated)

string

廃止されました。

trip_id
(deprecated)

string

廃止されました。

terminal_location_type
(deprecated)

WaypointType

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

TerminalPointId

終点を指定します。

フィールド
value

string

終点の一意の ID。

共用体フィールド 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_destinations が変更されないように、intermediate_destination_index の更新時にサーバーがこの値をキャッシュに保存して UpdateTripRequest に渡す必要があります。

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

出力専用。現在のルートで、replication_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 が最後に変更された時刻を示します。remaining_waypoints のパスとトラフィックが更新された場合にのみ返されるように、クライアント アプリはこの値をキャッシュに保存して GetTripRequest に渡す必要があります。

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 フィールドのサブセットと、その解釈方法。

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 レスポンスに含まれるさまざまなルートのフィールド セットのセレクタ。コンテキストについては 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 Map 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

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

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

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

waypoints[]

TripWaypoint

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

waypoints_version

Timestamp

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

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。属性の値には、string、bool、double 型を指定できます。vehicle_attribute_value は次のいずれかになります。
string_value

string

文字列型の属性値。

注: これは、最終的にサポートが終了する value フィールドと同じです。create メソッドまたは update メソッドでは、どちらのフィールドも使用できますが、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

車両の速度(km/時)。非推奨: 代わりに 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

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

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

リクエストで指定された乗車場所までの車両の運転 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

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

vehicle_match_type

VehicleMatchType

車両の一致タイプ。

requested_ordered_by

VehicleMatchOrder

車両の一致の並べ替えにリクエストされた順序。

ordered_by

VehicleMatchOrder

この車両に使用された実際の注文。通常、これはリクエストの 'order_by' フィールドと一致しますが、内部サーバーエラーなどの特定の状況では、別のメソッド(PICKUP_POINT_STRAIGHT_DISTANCE など)が使用されることがあります。

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 複数の目的地を経由するルートの中間地点の地点。