- HTTP リクエスト
- パスパラメータ
- リクエストの本文
- レスポンスの本文
- VehicleAttributeList
- VehicleMatchOrder
- CurrentTripsPresent
- VehicleMatch
- 地点
- VehicleMatchType
リクエストのオプションに一致する車両のリストを返します。
HTTP リクエスト
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
この URL は gRPC Transcoding 構文を使用します。
パスパラメータ
パラメータ | |
---|---|
parent |
必須。 |
リクエスト本文
リクエストの本文には、次の構造のデータが含まれます。
JSON 表現 |
---|
{ "header": { object ( |
フィールド | |
---|---|
header |
標準の Fleet Engine リクエスト ヘッダー。 |
pickupPoint |
必須。検索する付近の乗車ポイント。 |
dropoffPoint |
お客様の降車場所。 |
pickupRadiusMeters |
必須。乗車地点を中心とした車両検索の半径を定義します。検索半径内の車両のみが返されます。値は 400 ~ 10,000 メートルの範囲で指定してください。 |
count |
必須。返す車両の最大数を指定します。値は 1 ~ 50 の範囲で指定してください。 |
minimumCapacity |
必須。ルートの人数を指定します。1 以上の値を指定してください。ドライバは容量の値に考慮されません。 |
tripTypes[] |
必須。提案されたルートのタイプを表します。タイプを 1 つだけ含める必要があります。 |
maximumStaleness |
検索を、指定した期間内に Fleet Engine に位置情報の更新を送信した車両のみに限定します。位置情報を送信している静止車両は、最新ではないとは見なされません。このフィールドが設定されていない場合、サーバーはデフォルト値として 5 分を使用します。 「 |
vehicleTypes[] |
必須。検索対象を、指定されたタイプのいずれかを持つ車両に制限します。車両タイプを少なくとも 1 つ指定する必要があります。カテゴリが |
requiredAttributes[] |
呼び出し元は、
検索対象を、指定した属性を持つ車両のみに制限します。このフィールドは論理積(AND)演算です。指定できる requiredAttributes は最大 50 個です。車両で使用できる属性の最大数と同じです。 |
requiredOneOfAttributes[] |
検索対象を、各 |
requiredOneOfAttributeSets[] |
|
orderBy |
必須。結果の順序付けの基準を指定します。 |
includeBackToBack |
1 つの有効なルートを含む車両がこの検索の対象となるかどうかを示します。このフィールドは、 デフォルト値は |
tripId |
この |
currentTripsPresent |
有効なルートがある車両がこの検索の対象となるかどうかを示します。 |
filter |
省略可。車両の検索時に適用するフィルタクエリ。フィルタ構文の例については、http://aip.dev/160 をご覧ください。 このフィールドは、 このフィルタは、 なお、サポートされているクエリは車両属性( また、すべての属性は文字列として格納されるため、属性との比較でサポートされるのは文字列比較のみです。数値またはブール値と比較するには、値を文字列として扱われるように明示的に引用符で囲む必要があります(例: |
レスポンスの本文
vehicles.search
レスポンス メッセージ。
成功した場合、レスポンスの本文には次の構造のデータが含まれます。
JSON 表現 |
---|
{
"matches": [
{
object ( |
フィールド | |
---|---|
matches[] |
|
VehicleAttributeList
車両属性のリストのリストデータ型。
JSON 表現 |
---|
{
"attributes": [
{
object ( |
フィールド | |
---|---|
attributes[] |
このコレクション内の属性のリスト。 |
VehicleMatchOrder
レスポンス内の車両の一致順序を指定します。
列挙型 | |
---|---|
UNKNOWN_VEHICLE_MATCH_ORDER |
デフォルト。車両の一致順序が未指定または認識できない場合に使用されます。 |
PICKUP_POINT_ETA |
乗車場所までの運転時間の昇順。 |
PICKUP_POINT_DISTANCE |
乗車場所までの運転距離の昇順。 |
DROPOFF_POINT_ETA |
降車場所までの車両走行時間の昇順。この注文は、リクエストで降車場所が指定されている場合にのみ使用できます。 |
PICKUP_POINT_STRAIGHT_DISTANCE |
車両で最後に報告された場所から乗車地点までの直線距離の昇順。 |
COST |
設定された一致費用の昇順。一致費用は、直線距離と到着予定時刻の加重計算として定義されます。重み付けはデフォルト値で設定されており、お客様ごとに変更できます。プロジェクトでこれらの重み付けを変更する必要がある場合は、Google サポートにお問い合わせください。 |
CurrentTripsPresent
車両の現在のルートについての制限の種類を指定します。
列挙型 | |
---|---|
CURRENT_TRIPS_PRESENT_UNSPECIFIED |
ルートがある車両の空き状況は、includeBackToBack フィールドによって管理されます。 |
NONE |
ルートのない車両が検索結果に表示されることがあります。この値を使用する場合、includeBackToBack を true にすることはできません。 |
ANY |
5 件以下の現在のルートと 10 地点を含む車両が検索結果に含まれます。この値を使用する場合、includeBackToBack を true にすることはできません。 |
VehicleMatch
車両 SearchVehiclesRequest
の有効なルートのポイントに一致する車両の車両と関連する推定値が含まれます。
JSON 表現 |
---|
{ "vehicle": { object ( |
フィールド | |
---|---|
vehicle |
必須。リクエストに一致する車両。 |
vehiclePickupEta |
リクエストで指定された乗車場所までの車両の運転 ETA。空の値は、車両の到着予定時刻を計算できなかったことを示します。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
vehiclePickupDistanceMeters |
車両の現在地からリクエストで指定された乗車ポイントまでの距離(既存のルートの中間乗車地点または降車地点を含む)。この距離は、計算された運転(ルート)距離と、ナビゲーションの終点とリクエストされた乗車ポイントの間の直線距離で構成されます。(ナビゲーションの終点からリクエストされた乗車ポイントまでの距離は通常短いです)。空の値は、距離の計算でエラーが発生したことを示します。 |
vehiclePickupStraightLineDistanceMeters |
必須。リクエストで指定された乗車場所から車両までの直線距離。 |
vehicleDropoffEta |
リクエストで指定された降車場所までの車両の到着予定時刻。ETA には、リクエストで指定された RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
vehiclePickupToDropoffDistanceMeters |
リクエストで指定された乗車地点から降車地点までの車両の走行距離(メートル単位)。距離は 2 地点間の範囲のみであり、車両の位置や、車両が乗車ポイントまたは降車地点を訪問する前に訪問する必要があるその他のポイントは含まれません。この値は、リクエストで |
tripType |
必須。乗車場所までの到着予定時刻を計算するために使用されたリクエストのルートタイプ。 |
vehicleTripsWaypoints[] |
到着予定時刻の計算に使用されるウェイポイントの順序付きリスト。このリストには、車両の位置情報、車両のアクティブなルートの乗車地点、リクエストで提供された乗車地点が含まれます。空のリストは、車両の到着予定時刻を計算できなかったことを示します。 |
vehicleMatchType |
車両の一致タイプ。 |
requestedOrderedBy |
車両の一致の並べ替えにリクエストされた順序。 |
orderedBy |
この車両に使用された実際の注文。通常、これはリクエストの「orderBy」フィールドと一致しますが、内部サーバーエラーなどの特定の状況では、別のメソッド( |
ウェイポイント
SearchVehiclesResponse
の VehicleMatch
のルートに沿った中間点を記述します。このコンセプトは、他のすべてのエンドポイントで TripWaypoint
として表されます。
JSON 表現 |
---|
{
"latLng": {
object ( |
フィールド | |
---|---|
latLng |
このウェイポイントの位置。 |
eta |
車両がこの地点に到着する推定時刻。 RFC3339 UTC「Zulu」形式のタイムスタンプ。精度はナノ秒まで、小数点以下は最大 9 桁。例: |
VehicleMatchType
車両の一致タイプ。
列挙型 | |
---|---|
UNKNOWN |
不明な車両マッチタイプ |
EXCLUSIVE |
車両には現在ルートが割り当てられておらず、乗車地点に進むことができます。 |
BACK_TO_BACK |
車両は現在ルートに割り当てられていますが、進行中のルートの完了後に乗車地点に進むことができます。到着予定時刻と距離の計算では、既存のルートが考慮されます。 |
CARPOOL |
相乗りに十分なキャパシティがある。 |
CARPOOL_BACK_TO_BACK |
車両は、乗車地点より前に現在のアクティブなルートを終了します。到着予定時刻と距離の計算では、既存のルートが考慮されます。 |