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 演算）です。最大 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 での結合（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>）。1 つのフィルタクエリで許可される制限の最大数は 50 です。

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