Method: providers.vehicles.search

object (RequestHeader)

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

object (TerminalLocation)

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

object (TerminalLocation)

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

integer

必須。乗車地点を中心とした車両検索半径を定義します。検索半径内の車両のみが返されます。値は 400 ～ 10,000 m の範囲で指定してください。

integer

必須。返される車両の最大数を指定します。値は 1 ～ 50 の範囲で指定してください。

integer

必須。旅行の対象となる乗客の人数を指定します。1 以上の値を指定してください。ドライバは容量値で考慮されません。

enum (TripType)

必須。提案されたルートのタイプを表します。タイプを 1 つだけ含める必要があります。UNKNOWN_TRIP_TYPE は使用できません。検索対象のルートタイプをサポートできる車両のみに限定します。

string (Duration format)

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

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

object (VehicleType)

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

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）演算です。最大 50 個の requiredAttributes を使用できます。車両で許可される最大属性数と一致します。

object (VehicleAttributeList)

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

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 での結合/論理積と、VehicleAttributeList のコレクション全体にわたる包含的分離/OR 演算です。

enum (VehicleMatchOrder)

必須。結果の表示順序の基準を指定します。

boolean

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

デフォルト値は false です。

string

この SearchVehicleRequest に関連付けられたルートを示します。

enum (CurrentTripsPresent)

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

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> など）に関するものだけです。1 つのフィルタクエリで許可される制限の最大数は 50 です。

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