Method: providers.vehicles.search

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

HTTP リクエスト

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search

この URL は gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

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

リクエスト本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "header": {
    object (RequestHeader)
  },
  "pickupPoint": {
    object (TerminalLocation)
  },
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "pickupRadiusMeters": integer,
  "count": integer,
  "minimumCapacity": integer,
  "tripTypes": [
    enum (TripType)
  ],
  "maximumStaleness": string,
  "vehicleTypes": [
    {
      object (VehicleType)
    }
  ],
  "requiredAttributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "requiredOneOfAttributes": [
    {
      object (VehicleAttributeList)
    }
  ],
  "requiredOneOfAttributeSets": [
    {
      object (VehicleAttributeList)
    }
  ],
  "orderBy": enum (VehicleMatchOrder),
  "includeBackToBack": boolean,
  "tripId": string,
  "currentTripsPresent": enum (CurrentTripsPresent),
  "filter": string
}
フィールド
header

object (RequestHeader)

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

object (TerminalLocation)

必須。検索する付近の乗車地点。
dropoffPoint

object (TerminalLocation)

お客様の持ち込み場所。tripTypes に TripType.SHARED が含まれる場合、このフィールドは必須です。
pickupRadiusMeters

integer

必須。乗車地点を中心とした車両検索半径を定義します。検索半径内の車両のみが返されます。値は 400 ～ 10,000 メートル（両端を含む）の範囲で指定する必要があります。
count

integer

必須。返却する車両の最大数を指定します。値は 1 ～ 50 にする必要があります。
minimumCapacity

integer

必須。ルートの検討対象となる乗客の人数を指定します。値は 1 以上にする必要があります。運転手は容量の値で考慮されません。
tripTypes[]

enum (TripType)

必須。提案されたルートのタイプを表します。タイプを 1 つだけ指定してください。UNKNOWN_TRIP_TYPE は許可されていません。指定したルートタイプに対応できる車両にのみ検索を制限します。
maximumStaleness

string (Duration format)

指定した時間内に位置情報の更新を Fleet Engine に送信した車両のみに検索を制限します。位置情報を送信している静止車両は、古くなったとはみなされません。このフィールドが設定されていない場合、サーバーはデフォルト値として 5 分を使用します。

「s」で終わる小数 9 桁までの秒単位の期間。例: "3.5s"。
vehicleTypes[]

object (VehicleType)

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

object (VehicleAttribute)

呼び出し元は、requiredAttributes、requiredOneOfAttributes、requiredOneOfAttributeSets のフィールドを自由に組み合わせて、複雑な論理演算を作成できます。

requiredAttributes はリストです。requiredOneOfAttributes はリストのリストを許可するメッセージを使用します。2 つのフィールドを組み合わせることで、次の式の構成が可能になります。

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

指定した属性を持つ車両のみに検索を制限します。このフィールドは論理積/AND 演算です。指定できる requiredAttributes は最大 50 個です。車両で許可されている属性の最大数に一致します。
requiredOneOfAttributes[]

object (VehicleAttributeList)

各 VehicleAttributeList で指定された 1 つ以上の属性を持つ車両のみに検索を制限します。各リスト内で、車両は少なくとも 1 つの属性に一致する必要があります。このフィールドは、各 VehicleAttributeList における包括的な分離/OR 演算と、VehicleAttributeList のコレクション全体での論理/AND 演算です。
requiredOneOfAttributeSets[]

object (VehicleAttributeList)

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

requiredOneOfAttributes と同様に、requiredOneOfAttributeSets はリストのリストを許可するメッセージを使用し、次のような式を許可します。

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

VehicleAttributeList 内のすべての属性を持つ車両のみに検索を制限します。各リスト内で、車両はすべての属性に一致する必要があります。このフィールドは、各 VehicleAttributeList の論理積/AND 演算と、VehicleAttributeList のコレクション全体での包括的な分離/OR 演算です。
orderBy

enum (VehicleMatchOrder)

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

boolean

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

デフォルト値は false です。
tripId

string

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

enum (CurrentTripsPresent)

有効なルートがある車両がこの検索の対象となるかどうかを示します。tripType に SHARED が含まれている場合は、CURRENT_TRIPS_PRESENT_UNSPECIFIED 以外に設定する必要があります。
filter

string

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

このフィールドは、requiredAttributes、requiredOneOfAttributes、required_one_of_attributes_sets の各フィールドを置き換えるように設計されています。空でない値をここで指定する場合、requiredAttributes、requiredOneOfAttributes、required_one_of_attributes_sets の各フィールドは空にする必要があります。

このフィルタは、minimumCapacity や vehicleTypes などの他の制約との AND 句として機能します。

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

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

レスポンスの本文

成功した場合、レスポンスの本文には SearchVehiclesResponse のインスタンスが含まれます。