Method: providers.vehicles.search

object (RequestHeader)

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

object (TerminalLocation)

必須。近くの集荷所。

object (TerminalLocation)

お客様が指定した集荷場所。tripTypes に TripType.SHARED が含まれている場合は、このフィールドは必須です。

integer

必須。集合場所の周囲の車両検索範囲を定義します。検索範囲内の車両のみが返されます。値は 400 ～ 10,000 メートルの範囲で指定する必要があります。

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

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 の連結演算子（AND）と、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> など）に関するクエリのみです。フィルタクエリで許可される制限の最大数は 50 です。

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