Method: providers.vehicles.search

{
  "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
}

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"）。