索引
TripService
(インターフェース)VehicleService
(インターフェース)BatteryInfo
(メッセージ)BatteryStatus
(列挙型)BillingPlatformIdentifier
(列挙型)ConsumableTrafficPolyline
(メッセージ)CreateTripRequest
(メッセージ)CreateVehicleRequest
(メッセージ)DeviceSettings
(メッセージ)GetTripRequest
(メッセージ)GetVehicleRequest
(メッセージ)LicensePlate
(メッセージ)ListVehiclesRequest
(メッセージ)ListVehiclesResponse
(メッセージ)LocationPowerSaveMode
(列挙型)LocationSensor
(列挙型)NavigationStatus
(列挙型)PolylineFormatType
(列挙型)PowerSource
(列挙型)ReportBillableTripRequest
(メッセージ)ReportBillableTripRequest.SolutionType
(列挙型)RequestHeader
(メッセージ)RequestHeader.Platform
(列挙型)RequestHeader.SdkType
(列挙型)SearchTripsRequest
(メッセージ)SearchTripsResponse
(メッセージ)SearchVehiclesRequest
(メッセージ)SearchVehiclesRequest.CurrentTripsPresent
(列挙型)SearchVehiclesRequest.VehicleMatchOrder
(列挙型)SearchVehiclesResponse
(メッセージ)SpeedReadingInterval
(メッセージ)SpeedReadingInterval.Speed
(列挙型)StopLocation
(メッセージ)TerminalLocation
(メッセージ)TerminalPointId
(メッセージ)(非推奨)TrafficPolylineData
(メッセージ)Trip
(メッセージ)TripStatus
(列挙型)TripType
(列挙型)TripView
(列挙型)TripWaypoint
(メッセージ)UpdateTripRequest
(メッセージ)UpdateVehicleAttributesRequest
(メッセージ)UpdateVehicleAttributesResponse
(メッセージ)UpdateVehicleRequest
(メッセージ)Vehicle
(メッセージ)Vehicle.VehicleType
(メッセージ)Vehicle.VehicleType.Category
(列挙型)VehicleAttribute
(メッセージ)VehicleAttributeList
(メッセージ)VehicleLocation
(メッセージ)VehicleMatch
(メッセージ)VehicleMatch.VehicleMatchType
(列挙型)VehicleState
(列挙型)VisualTrafficReportPolylineRendering
(メッセージ)VisualTrafficReportPolylineRendering.RoadStretch
(メッセージ)VisualTrafficReportPolylineRendering.RoadStretch.Style
(列挙型)Waypoint
(メッセージ)WaypointType
(列挙型)
TripService
ルート管理サービス。
CreateTrip |
---|
Fleet Engine でルートを作成し、新しいルートを返します。 |
GetTrip |
---|
1 つのルートに関する情報を取得する。 |
ReportBillableTrip |
---|
請求対象のルートの使用状況を報告します。 |
SearchTrips |
---|
特定の車両のすべてのルートを取得します。 |
UpdateTrip |
---|
ルートデータを更新します。 |
VehicleService
車両管理サービス。
CreateVehicle |
---|
オンデマンドの配車サービス プロバイダまたは配達プロバイダに関連付けられた新しい車両をインスタンス化します。各
その他のフィールドはすべて省略可能で、指定されていれば使用されます。 |
GetVehicle |
---|
Fleet Engine から車両を返します。 |
ListVehicles |
---|
リクエスト オプションに一致するプロバイダに関連付けられている車両のページ分けされたリストを返します。 |
SearchVehicles |
---|
リクエストのオプションに一致する車両のリストを返します。 |
UpdateVehicle |
---|
更新された車両データを Fleet Engine に書き込みます。
車両
|
UpdateVehicleAttributes |
---|
車両の属性を部分的に更新します。リクエストで指定された属性のみが更新されます。他の属性は変更されません。注: これは |
BatteryInfo
デバイスのバッテリーに関する情報。
フィールド | |
---|---|
battery_status |
バッテリーの状態(フル、充電など) |
power_source |
バッテリー電源のステータス。 |
battery_percentage |
現在のバッテリー残量(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[] |
前の地点から現在の地点までの経路上の速度です。 |
encoded_path_to_waypoint |
前の地点から現在の地点まで、ドライバーが通過する経路。この進路にはランドマークがあるため、クライアントは経路に沿って交通マーカーを表示できます( |
CreateTripRequest
CreateTrip リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
parent |
必須。 |
trip_id |
必須。一意のルート ID。次の制限事項が適用されます。
|
trip |
必須。作成するルート エンティティ。 ルートを作成する際は、以下のフィールドが必要です。
指定すると、次のフィールドが使用されます。
その他の Trip フィールドはすべて無視されます。たとえば、すべてのルートは、作成リクエストで
共有ルートに
|
CreateVehicleRequest
CreateVehicle
リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
parent |
必須。 |
vehicle_id |
必須。一意の車両 ID。次の制限事項が適用されます。
|
vehicle |
必須。作成する車両エンティティ。車両を作成する際は、以下のフィールドが必要です。
車両を作成する際、以下のフィールドは無視されます。
その他のフィールドはすべて省略可能で、指定されていれば使用されます。 |
DeviceSettings
モバイル デバイスのさまざまな設定に関する情報。
フィールド | |
---|---|
location_power_save_mode |
バッテリー セーバーがオンのときにデバイスの位置情報機能がどのように動作するかを設定します。 |
is_power_save_mode |
デバイスが現在省電力モードかどうか。 |
is_interactive |
デバイスが操作可能な状態かどうか。 |
battery_info |
バッテリーの状態に関する情報。 |
GetTripRequest
GetTrip リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
name |
必須。 |
view |
返す必要がある Trip フィールドのサブセットとその解釈。 |
current_route_segment_version |
|
remaining_waypoints_version |
|
route_format_type |
返される現在のルート形式、 |
current_route_segment_traffic_version |
|
remaining_waypoints_route_version |
|
GetVehicleRequest
GetVehicle
リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
name |
必須。 |
current_route_segment_version |
|
waypoints_version |
|
LicensePlate
車両のナンバー プレート情報。個人を特定できる情報が保存されないように、ナンバー プレートに関する最小限の情報のみがエンティティの一部として保存されます。
フィールド | |
---|---|
country_code |
必須。CLDR 国/地域コード。たとえば、米国の場合は |
last_character |
ナンバー プレートの最後の桁、またはナンバー プレートに数値が含まれていない場合は「-1」。
|
ListVehiclesRequest
ListVehicles
リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
parent |
必須。 |
page_size |
返却する車両の最大数。デフォルト値: 100。 |
page_token |
前の |
minimum_capacity |
車両に必要な最小キャパシティを指定します。返されるすべての車両の |
trip_types[] |
指定したルートタイプのうち少なくとも 1 つをサポートする車両にのみレスポンスを制限します。 |
maximum_staleness |
指定した期間内に位置情報の更新データを Fleet Engine に送信した車両へのレスポンスを制限します。位置情報を送信している静止車両は、最新ではないとは見なされません。存在する場合は、有効な正の値の期間を指定する必要があります。 |
vehicle_type_categories[] |
必須。指定されたタイプ カテゴリのいずれかを持つ車両へのレスポンスを制限します。 |
required_attributes[] |
呼び出し元は、
レスポンスを、指定された属性を持つ車両に制限します。このフィールドは論理積(AND)演算です。指定できる required_attributes の数は 50 個までです。車両で使用できる属性の最大数と同じです。繰り返される各文字列は、「key:value」の形式にする必要があります。 |
required_one_of_attributes[] |
各 |
required_one_of_attribute_sets[] |
|
vehicle_state |
この車両ステータスを持つ車両へのレスポンスを制限します。 |
on_trip_only |
現在のルートの車両のみを返す。 |
filter |
省略可。車両を一覧表示するときに適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。 このフィールドは、 このフィルタは、 なお、サポートされているクエリは車両属性( また、すべての属性は文字列として格納されるため、属性との比較でサポートされるのは文字列比較のみです。数値またはブール値と比較するには、値を文字列として扱われるように明示的に引用符で囲む必要があります(例: |
viewport |
省略可。返される車両を、最後に確認された場所がビューポートによって定義された長方形の領域内にあった車両に限定するフィルタ。 |
ListVehiclesResponse
ListVehicles
レスポンス メッセージ。
フィールド | |
---|---|
vehicles[] |
リクエストの条件に一致する車両。返される車両の最大数は、リクエストの |
next_page_token |
車両の次のページを取得するためのトークン。リクエスト条件を満たす車両が他にない場合は空になります。 |
total_size |
必須。すべてのページにおいて、リクエスト条件に一致する車両の合計数。 |
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 オペレーティング システム上の位置情報プロバイダ。 |
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 |
必須。 |
country_code |
必須。ルートの所在国の 2 文字の国コード。価格は国コードに従って定義されます。 |
platform |
リクエストが発行されたプラットフォーム。 |
related_ids[] |
報告されたルートに直接関連する識別子。通常は、ルート ID が利用可能になる前に行われた事前予約オペレーションの ID(セッション ID など)です。 |
solution_type |
報告されたルートに使用される Google マーケティング プラットフォーム サービス ソリューションのタイプ( |
SolutionType
報告されるルートのさまざまなソリューション タイプを選択できるセレクタです。
列挙型 | |
---|---|
SOLUTION_TYPE_UNSPECIFIED |
デフォルト値。下位互換性を確保するため、API はデフォルトで ON_DEMAND_RIDESHARING_AND_DELIVERIES を使用します。これが、サポートされている最初のソリューション タイプです。 |
ON_DEMAND_RIDESHARING_AND_DELIVERIES |
このソリューションは、オンデマンドの配車サービスおよび配達サービスです。 |
RequestHeader
RequestHeader には、すべての Fleet Engine RPC リクエストに共通するフィールドが含まれます。
フィールド | |
---|---|
language_code |
en-US や sr-Latn などの BCP-47 言語コード。詳しくは、http://www.unicode.org/reports/tr35/#Unicode_locale_identifier を参照してください。指定しない場合、レスポンスは任意の言語で作成できます。そのような名前が存在する場合は、英語が優先されます。フィールド値の例: |
region_code |
必須。リクエスト送信元のリージョンの CLDR リージョン コード。フィールド値の例: |
sdk_version |
呼び出し元の SDK のバージョン(該当する場合)。バージョンの形式は「major.minor.patch」です(例: |
os_version |
呼び出し元の SDK が実行されているオペレーティング システムのバージョン。フィールド値の例: |
device_model |
呼び出し元の SDK が実行されているデバイスのモデル。フィールド値の例: |
sdk_type |
リクエストを送信する SDK のタイプ。 |
maps_sdk_version |
呼び出し元の SDK が依存している MapSDK のバージョン(該当する場合)。バージョンの形式は「major.minor.patch」です(例: |
nav_sdk_version |
呼び出し元 SDK が依存する NavSDK のバージョン(該当する場合)。バージョンの形式は「major.minor.patch」です(例: |
platform |
呼び出し元 SDK のプラットフォーム。 |
manufacturer |
呼び出し元 SDK の Android デバイスのメーカー。Android SDK にのみ適用されます。フィールド値の例: |
android_api_level |
呼び出し元 SDK の Android API レベル。Android SDK にのみ適用されます。フィールド値の例: |
trace_id |
オプションの 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 |
標準の Fleet Engine リクエスト ヘッダー。 |
parent |
必須。 |
vehicle_id |
リクエスト内のルートに関連付けられている車両。指定しない場合、返されるルートに以下は含まれません。
|
active_trips_only |
true に設定すると、ドライバーのルートに影響するルートがレスポンスに含まれます。 |
page_size |
設定されていない場合、返される結果の数はサーバーが決定します。 |
page_token |
以前の結果から続行するには、以前に |
minimum_staleness |
指定すると、時刻 |
SearchTripsResponse
SearchTrips レスポンス メッセージ。
フィールド | |
---|---|
trips[] |
リクエストされた車両のルートのリスト。 |
next_page_token |
このトークンを SearchTripsRequest に渡して、リスト結果をページ分割します。API は呼び出しごとにルートリストを返し、結果が残っていない場合はルートリストが空になります。 |
SearchVehiclesRequest
SearchVehicles
リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
parent |
必須。 |
pickup_point |
必須。検索する付近の乗車ポイント。 |
dropoff_point |
お客様の降車場所。 |
pickup_radius_meters |
必須。乗車地点を中心とした車両検索の半径を定義します。検索半径内の車両のみが返されます。値は 400 ~ 10,000 メートルの範囲で指定してください。 |
count |
必須。返す車両の最大数を指定します。値は 1 ~ 50 の範囲で指定してください。 |
minimum_capacity |
必須。ルートの人数を指定します。1 以上の値を指定してください。ドライバは容量の値に考慮されません。 |
trip_types[] |
必須。提案されたルートのタイプを表します。タイプを 1 つだけ含める必要があります。 |
maximum_staleness |
検索を、指定した期間内に Fleet Engine に位置情報の更新を送信した車両のみに限定します。位置情報を送信している静止車両は、最新ではないとは見なされません。このフィールドが設定されていない場合、サーバーはデフォルト値として 5 分を使用します。 |
vehicle_types[] |
必須。検索対象を、指定されたタイプのいずれかを持つ車両に制限します。車両タイプを少なくとも 1 つ指定する必要があります。カテゴリが |
required_attributes[] |
呼び出し元は、
検索対象を、指定した属性を持つ車両のみに制限します。このフィールドは論理積(AND)演算です。指定できる required_attributes の数は 50 個までです。車両で使用できる属性の最大数と同じです。 |
required_one_of_attributes[] |
検索対象を、各 |
required_one_of_attribute_sets[] |
|
order_by |
必須。結果の順序付けの基準を指定します。 |
include_back_to_back |
1 つの有効なルートを含む車両がこの検索の対象となるかどうかを示します。このフィールドは、 デフォルト値は |
trip_id |
この |
current_trips_present |
有効なルートがある車両がこの検索の対象となるかどうかを示します。 |
filter |
省略可。車両の検索時に適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。 このフィールドは、 このフィルタは、 なお、サポートされているクエリは車両属性( また、すべての属性は文字列として格納されるため、属性との比較でサポートされるのは文字列比較のみです。数値またはブール値と比較するには、値を文字列として扱われるように明示的に引用符で囲む必要があります(例: |
CurrentTripsPresent
車両の現在のルートについての制限の種類を指定します。
列挙型 | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
ルートがある車両の空き状況は、include_back_to_back フィールドによって管理されます。 |
NONE |
ルートのない車両が検索結果に表示されることがあります。この値を使用する場合、include_back_to_back を true にすることはできません。 |
ANY |
5 件以下の現在のルートと 10 地点を含む車両が検索結果に含まれます。この値を使用する場合、include_back_to_back を true にすることはできません。 |
VehicleMatchOrder
レスポンス内の車両の一致順序を指定します。
列挙型 | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
デフォルト。車両の一致順序が未指定または認識できない場合に使用されます。 |
PICKUP_POINT_ETA |
乗車場所までの運転時間の昇順。 |
PICKUP_POINT_DISTANCE |
乗車場所までの運転距離の昇順。 |
DROPOFF_POINT_ETA |
降車場所までの車両走行時間の昇順。この注文は、リクエストで降車場所が指定されている場合にのみ使用できます。 |
PICKUP_POINT_STRAIGHT_DISTANCE |
車両で最後に報告された場所から乗車地点までの直線距離の昇順。 |
COST |
設定された一致費用の昇順。一致費用は、直線距離と到着予定時刻の加重計算として定義されます。重み付けはデフォルト値で設定されており、お客様ごとに変更できます。プロジェクトでこれらの重み付けを変更する必要がある場合は、Google サポートにお問い合わせください。 |
SearchVehiclesResponse
SearchVehicles
レスポンス メッセージ。
フィールド | |
---|---|
matches[] |
|
SpeedReadingInterval
経路の連続するセグメントにおけるトラフィック密度インジケーター。ポイント P_0、P_1、...、P_N(ゼロベースのインデックス)を持つパスが指定された場合、SpeedReadingInterval は間隔を定義し、次のカテゴリを使用してそのトラフィックを記述します。
フィールド | |
---|---|
start_polyline_point_index |
パス内のこの区間の開始インデックス。JSON では、インデックスが 0 の場合、フィールドにデータが入力されていないように見えます。 |
end_polyline_point_index |
パス内のこの区間の終了インデックス。JSON では、インデックスが 0 の場合、フィールドにデータが入力されていないように見えます。 |
speed |
この区間のトラフィック速度。 |
スピード
交通データに基づくポリラインの速度の分類。
列挙型 | |
---|---|
SPEED_UNSPECIFIED |
デフォルト値。この値は使用されません。 |
NORMAL |
通常の速度です。速度低下は検出されません。 |
SLOW |
軽い渋滞は検知されましたが、渋滞は発生していません。 |
TRAFFIC_JAM |
渋滞を検出しました。 |
StopLocation
停車地(乗車または降車)が行われた実際の場所。
フィールド | |
---|---|
point |
必須。実際の場所を表します。 |
timestamp |
停車地が発生した時間を示します。 |
stop_time |
入力のみ。非推奨です。タイムスタンプ フィールドを使用します。 |
TerminalLocation
ウェイポイントの位置を記述します。
フィールド | |
---|---|
point |
必須。ルートの地点の地点を示します。 |
terminal_point_id |
非推奨: 代わりに |
access_point_id |
非推奨: 代わりに |
trip_id |
廃止されました。 |
terminal_location_type |
非推奨: |
TerminalPointId
非推奨: TerminalPoints は Fleet Engine でサポートされなくなりました。TerminalLocation.point
を代わりに使用してください。
フィールド | |
---|---|
value |
廃止されました。 |
共用体フィールド Id 。非推奨です。Id は次のいずれかになります。 |
|
place_id |
廃止されました。 |
generated_id |
廃止されました。 |
TrafficPolylineData
想定している車両ルートの交通状況。
フィールド | |
---|---|
traffic_rendering |
顧客の乗車区間におけるすべての地域の交通速度を示すポリライン レンダリング。 |
ルート
ルートのメタデータ。
フィールド | |
---|---|
name |
出力専用。形式は「providers/{provider}/trips/{trip}」です。 |
vehicle_id |
このルートを走行する車両の ID。 |
trip_status |
ルートの現在のステータス。 |
trip_type |
ルートのタイプ。 |
pickup_point |
お客様が集荷と指定した場所。 |
actual_pickup_point |
入力のみ。お客様が集荷された日時と場所。このフィールドは、プロバイダが実際の受け取りに関する情報に関するフィードバックを提供するためのものです。 |
actual_pickup_arrival_point |
入力のみ。ドライバーが乗車ポイントに到着する実際の時刻と場所。このフィールドは、プロバイダが乗車場所への実際の到着情報についてフィードバックを提供するためのものです。 |
pickup_time |
出力専用。今後乗客が乗車する予定時刻、または乗車時刻の実際の時刻のいずれか。 |
intermediate_destinations[] |
(乗車と降車に加えて)リクエストの対象となる中間の駅 / 停留所。現時点では、この機能は共有ルートではサポートされていません。 |
intermediate_destinations_version |
|
intermediate_destination_index |
|
actual_intermediate_destination_arrival_points[] |
入力のみ。ドライバーが中間目的地に到着した実際の時刻と場所。このフィールドは、プロバイダが中間目的地での実際の到着情報についてフィードバックを提供するためのものです。 |
actual_intermediate_destinations[] |
入力のみ。お客様が中間の配送先から集荷された日時と場所。このフィールドは、プロバイダが中間目的地での実際の乗車情報に関するフィードバックを提供するためのものです。 |
dropoff_point |
お客様が持ち込みを予定している場所。 |
actual_dropoff_point |
入力のみ。お客様が放棄した日時と場所。これは、プロバイダが実際の持ち込み情報に関するフィードバックを提供するためのものです。 |
dropoff_time |
出力専用。乗客が最終目的地で降車する推定時刻、または降車する実際の時刻のいずれか。 |
remaining_waypoints[] |
出力専用。現在地から降車場所までのフルパス(両端を含む)。この経路には、他のルートの地点を含めることができます。 |
vehicle_waypoints[] |
このフィールドでは、ルートのウェイポイントを手動で順序付けできます。割り当てられた車両の残りのすべての地点と、このルートの乗車地点と降車地点が含まれています。ルートが車両に割り当てられていない場合、Fleet Engine はこのフィールドを無視します。プライバシー上の理由から、このフィールドは |
route[] |
出力専用。現在のルートで、replication_waypoints の最初のエントリーまでのルートが予想されます。最初のウェイポイントは別のルートに属している場合があります。 |
current_route_segment |
出力専用。次のウェイポイントへのエンコードされたパス。 注: このフィールドは、Driver SDK と Consumer SDK による使用のみを対象としています。デコードはまだサポートされていません。 |
current_route_segment_version |
出力専用。経路が最後に変更された時刻を示します。 注: このフィールドは、Driver SDK と Consumer SDK による使用のみを対象としています。 |
current_route_segment_traffic |
出力専用。 注: このフィールドは、Driver SDK と Consumer SDK による使用のみを対象としています。 |
current_route_segment_traffic_version |
出力専用。 注: このフィールドは、Driver SDK と Consumer SDK による使用のみを対象としています。 |
current_route_segment_end_point |
出力専用。 |
remaining_distance_meters |
出力専用。 |
eta_to_first_waypoint |
出力専用。次の地点( |
remaining_time_to_first_waypoint |
出力専用。ルートデータが返された時点から |
remaining_waypoints_version |
出力専用。 |
remaining_waypoints_route_version |
出力専用。 |
number_of_passengers |
変更不可。このルートの乗客数を示します。運転手は含みません。 |
last_location |
出力専用。ルート上で最後に報告された車両の位置を示します。 |
last_location_snappable |
出力専用。車両の |
view |
入力される 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 |
このウェイポイントの位置。 |
trip_id |
このウェイポイントに関連付けられたルート。 |
waypoint_type |
このルートにおいてこの地点が果たす役割(乗車や降車など)。 |
path_to_waypoint[] |
前のウェイポイントから現在のウェイポイントまでのパス。リストの最初のウェイポイントで未定義です。このフィールドは、リクエストされた場合にのみ入力されます。 |
encoded_path_to_waypoint |
前の地点から現在の地点までのエンコードされたパス。 注: このフィールドは、Driver SDK と Consumer SDK による使用のみを対象としています。デコードはまだサポートされていません。 |
traffic_to_waypoint |
この地点までの経路の交通状況です。交通状況のデータを利用できるのは、Google Map Platform 配車と配達ソリューションのお客様のみです。 |
distance_meters |
前のウェイポイントから現在のウェイポイントまでのパス距離。リストの最初のウェイポイントで未定義です。 |
eta |
この地点に到着する予定時刻です。リストの最初のウェイポイントで未定義です。 |
duration |
前の地点からこの地点までの移動時間です。リストの最初のウェイポイントで未定義です。 |
UpdateTripRequest
UpdateTrip リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
name |
必須。 |
trip |
必須。更新情報に関連付けられたルート。 Fleet Engine によって維持されるフィールドは次のとおりです。Trip.update を使用して更新しないでください。
共有ルートの
複数の目的地を含むルートの競合状態を回避するには、ルートのステータスを |
update_mask |
必須。ルート内で更新するフィールドを示すフィールド マスク。 |
UpdateVehicleAttributesRequest
UpdateVehicleAttributes
リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
name |
必須。 |
attributes[] |
必須。更新する車両属性。記載されていない属性の変更や削除は行われません。 |
UpdateVehicleAttributesResponse
UpdateVehicleAttributes
レスポンス メッセージ。
フィールド | |
---|---|
attributes[] |
必須。車両属性の完全なリスト(新しい属性、変更された属性、元の属性を含む)。 |
UpdateVehicleRequest
UpdateVehicle リクエスト メッセージ。
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
name |
必須。 |
vehicle |
必須。適用する
同様に、 |
update_mask |
必須。 |
車両
車両のメタデータ。
フィールド | |
---|---|
name |
出力専用。この車両の一意の名前。形式は |
vehicle_state |
車両の状態。 |
supported_trip_types[] |
この車両でサポートされているルートのタイプ。 |
current_trips[] |
出力専用。この車両に現在割り当てられているルートの |
last_location |
最後に報告された車両の位置。 |
maximum_capacity |
この車両の乗車人数の合計。この値ではドライバは考慮されません。1 以上の値を指定してください。 |
attributes[] |
車両属性のリスト。車両に指定できる属性は最大 100 個で、各属性には一意のキーが必要です。 |
vehicle_type |
必須。この車両のタイプ。 |
license_plate |
車両のナンバー プレート情報。 |
route[] |
非推奨: 代わりに |
current_route_segment |
ドライバー アプリが次のウェイポイントまで進むルートを指定するポリライン。このリストは、車両に割り当てられているすべての有効なルートについて、 注: このフィールドは、Driver SDK による使用のみを目的としています。デコードはまだサポートされていません。 |
current_route_segment_traffic |
入力のみ。Fleet Engine はこの情報を使用して、ジャーニーの共有を改善します。注: このフィールドは、Driver SDK による使用のみを目的としています。 |
current_route_segment_version |
出力専用。 |
current_route_segment_end_point |
|
remaining_distance_meters |
|
eta_to_first_waypoint |
車両を更新する場合、同じリクエスト内で |
remaining_time_seconds |
入力のみ。 車両を更新する場合、同じリクエスト内で |
waypoints[] |
この車両に割り当てられている残りのウェイポイント。 |
waypoints_version |
出力専用。 |
back_to_back_enabled |
連続したルートを運転手が受け入れているかどうかを示します。 |
navigation_status |
車両のナビゲーション ステータス。 |
device_settings |
入力のみ。ドライバが使用しているモバイル デバイスの設定に関する情報。 |
VehicleType
車両のタイプ。
フィールド | |
---|---|
category |
車種カテゴリ |
カテゴリ
車両タイプのカテゴリ
列挙型 | |
---|---|
UNKNOWN |
デフォルト。未指定または認識できない車両カテゴリに使用されます。 |
AUTO |
自動車。 |
TAXI |
タクシーとして動作する車両(通常は認可済みまたは規制対象の車両)。 |
TRUCK |
一般に、収納容量が大きい車両。 |
TWO_WHEELER |
オートバイ、原動機付自転車、その他の二輪車 |
BICYCLE |
人間による輸送。 |
PEDESTRIAN |
通常は歩いたり走ったりする、歩行者専用の通路を歩く人間のトランスポーター。 |
VehicleAttribute
車両属性を Key-Value ペアとして記述します。「key:value」文字列の長さは 256 文字以内にしてください。
フィールド | |
---|---|
key |
属性のキー。キーにコロン(:)を含めることはできません。 |
value |
属性の値。 |
共用体フィールド vehicle_attribute_value 。属性の値には、string、bool、double 型を指定できます。vehicle_attribute_value は次のいずれかになります。 |
|
string_value |
文字列型の属性値。 注: これは、最終的にサポートが終了する |
bool_value |
ブール値型の属性値。 |
number_value |
二重型属性値。 |
VehicleAttributeList
車両属性のリストのリストデータ型。
フィールド | |
---|---|
attributes[] |
このコレクション内の属性のリスト。 |
VehicleLocation
ある時点における車両の位置、速度、方角。
フィールド | |
---|---|
location |
車両の位置。Fleet Engine に送信された場合、車両の位置は GPS 位置情報となります。レスポンスで受信された車両の位置は、GPS 位置、補足位置、その他の推定位置のいずれかになります。ソースは |
horizontal_accuracy |
非推奨: 代わりに |
latlng_accuracy |
|
heading |
車両の移動方向(度単位)。0 は北を表します。有効な範囲は [0,360] です。 |
bearing_accuracy |
非推奨: 代わりに |
heading_accuracy |
|
altitude |
WGS84 からの高度(メートル単位)。 |
vertical_accuracy |
非推奨: 代わりに |
altitude_accuracy |
|
speed_kmph |
車両の速度(km/時)。非推奨: 代わりに |
speed |
車両の速度(メートル/秒) |
speed_accuracy |
|
update_time |
センサーのクロックに基づき、センサーが |
server_time |
出力専用。サーバーが位置情報を受信した時刻。 |
location_sensor |
位置情報のプロバイダ( |
is_road_snapped |
|
is_gps_sensor_enabled |
入力のみ。モバイル デバイスで GPS センサーが有効になっているかどうかを示します。 |
time_since_update |
入力のみ。この場所が最初にサーバーに送信されてからの時間(秒)。最初の更新ではゼロになります。時刻が不明な場合(アプリが再起動された場合など)、この値はゼロにリセットされます。 |
num_stale_updates |
入力のみ。非推奨: 位置情報が古くなっているかどうかを判断するために、他のシグナルが使用されるようになりました。 |
raw_location |
未加工の車両の位置情報(ロード スナッパーで処理されていない)。 |
raw_location_time |
元の場所に関連付けられたタイムスタンプ。 |
raw_location_sensor |
未加工の場所のソース。デフォルトは |
raw_location_accuracy |
半径で表した |
supplemental_location |
統合するアプリによって提供される補助的な位置情報。 |
supplemental_location_time |
補助的な場所に関連付けられたタイムスタンプ。 |
supplemental_location_sensor |
補助的な場所のソース。デフォルトは |
supplemental_location_accuracy |
半径で表した |
road_snapped |
非推奨: 代わりに |
VehicleMatch
車両 SearchVehiclesRequest
の有効なルートのポイントに一致する車両の車両と関連する推定値が含まれます。
フィールド | |
---|---|
vehicle |
必須。リクエストに一致する車両。 |
vehicle_pickup_eta |
リクエストで指定された乗車場所までの車両の運転 ETA。空の値は、車両の到着予定時刻を計算できなかったことを示します。 |
vehicle_pickup_distance_meters |
車両の現在地からリクエストで指定された乗車ポイントまでの距離(既存のルートの中間乗車地点または降車地点を含む)。この距離は、計算された運転(ルート)距離と、ナビゲーションの終点とリクエストされた乗車ポイントの間の直線距離で構成されます。(ナビゲーションの終点からリクエストされた乗車ポイントまでの距離は通常短いです)。空の値は、距離の計算でエラーが発生したことを示します。 |
vehicle_pickup_straight_line_distance_meters |
必須。リクエストで指定された乗車場所から車両までの直線距離。 |
vehicle_dropoff_eta |
リクエストで指定された降車場所までの車両の到着予定時刻。ETA には、リクエストで指定された |
vehicle_pickup_to_dropoff_distance_meters |
リクエストで指定された乗車地点から降車地点までの車両の走行距離(メートル単位)。距離は 2 地点間の範囲のみであり、車両の位置や、車両が乗車ポイントまたは降車地点を訪問する前に訪問する必要があるその他のポイントは含まれません。この値は、リクエストで |
trip_type |
必須。乗車場所までの到着予定時刻を計算するために使用されたリクエストのルートタイプ。 |
vehicle_trips_waypoints[] |
到着予定時刻の計算に使用されるウェイポイントの順序付きリスト。このリストには、車両の位置情報、車両のアクティブなルートの乗車地点、リクエストで提供された乗車地点が含まれます。空のリストは、車両の到着予定時刻を計算できなかったことを示します。 |
vehicle_match_type |
車両の一致タイプ。 |
requested_ordered_by |
車両の一致の並べ替えにリクエストされた順序。 |
ordered_by |
この車両に使用された実際の注文。通常、これはリクエストの 'order_by' フィールドと一致しますが、内部サーバーエラーなどの特定の状況では、別のメソッド( |
VehicleMatchType
車両の一致タイプ。
列挙型 | |
---|---|
UNKNOWN |
不明な車両マッチタイプ |
EXCLUSIVE |
車両には現在ルートが割り当てられておらず、乗車地点に進むことができます。 |
BACK_TO_BACK |
車両は現在ルートに割り当てられていますが、進行中のルートの完了後に乗車地点に進むことができます。到着予定時刻と距離の計算では、既存のルートが考慮されます。 |
CARPOOL |
相乗りに十分なキャパシティがある。 |
CARPOOL_BACK_TO_BACK |
車両は、乗車地点より前に現在のアクティブなルートを終了します。到着予定時刻と距離の計算では、既存のルートが考慮されます。 |
VehicleState
Vehicle
の状態。
列挙型 | |
---|---|
UNKNOWN_VEHICLE_STATE |
デフォルト。未指定または認識できない車両状態に使用されます。 |
OFFLINE |
車両が新しいルートを受け入れていません。注: 車両は、割り当てられたルートが完了中もこの状態で運転を続ける場合があります。 |
ONLINE |
車両が新しいルートを受け入れています。 |
VisualTrafficReportPolylineRendering
クライアントがルートに沿ったポリラインの一部に色を付ける方法について説明します。
フィールド | |
---|---|
road_stretch[] |
省略可。ポリラインに沿ってレンダリングされる道路の範囲。ストレッチは重複しないことが保証されており、必ずしもルート全体にわたるとは限りません。 道路のストレッチによるスタイル設定がない場合は、クライアントはルートにデフォルトを適用する必要があります。 |
RoadStretch
レンダリングする 1 つの道路区間。
フィールド | |
---|---|
style |
必須。適用するスタイル。 |
offset_meters |
必須。スタイルは |
length_meters |
必須。スタイルを適用するパスの長さ。 |
スタイル
交通状況を示すスタイル。
列挙型 | |
---|---|
STYLE_UNSPECIFIED |
スタイルが選択されていません。 |
SLOWER_TRAFFIC |
トラフィックが減少している。 |
TRAFFIC_JAM |
渋滞が発生しています。 |
ウェイポイント
SearchVehiclesResponse
の VehicleMatch
のルートに沿った中間点を記述します。このコンセプトは、他のすべてのエンドポイントで TripWaypoint
として表されます。
フィールド | |
---|---|
lat_lng |
このウェイポイントの位置。 |
eta |
車両がこの地点に到着する推定時刻。 |
WaypointType
地点のタイプ。
列挙型 | |
---|---|
UNKNOWN_WAYPOINT_TYPE |
ウェイポイントのタイプが不明または未指定。 |
PICKUP_WAYPOINT_TYPE |
乗客やアイテムを受け取るための地点。 |
DROP_OFF_WAYPOINT_TYPE |
乗客やアイテムを持ち込むための地点。 |
INTERMEDIATE_DESTINATION_WAYPOINT_TYPE |
複数の目的地を経由するルートの中間地点の地点。 |