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

Необходимый. Указывает количество пассажиров, рассматриваемых для поездки. Значение должно быть больше или равно единице. Драйвер не учитывается в значении мощности.

enum ( TripType )

Необходимый. Представляет тип предлагаемой поездки. Должен включать ровно один тип. UNKNOWN_TRIP_TYPE не разрешен. Ограничивает поиск только теми транспортными средствами, которые поддерживают данный тип поездки.

string ( Duration format)

Ограничивает поиск только теми транспортными средствами, которые отправили обновления местоположения в Fleet Engine в течение указанного периода. Стационарные транспортные средства, все еще передающие свое местоположение, не считаются устаревшими. Если это поле не задано, сервер использует пять минут в качестве значения по умолчанию.

Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « s ». Пример: "3.5s" .

object ( VehicleType )

Необходимый. Ограничивает поиск транспортными средствами одного из указанных типов. Должен быть указан хотя бы один тип транспортного средства. Типы транспортных средств с категорией UNKNOWN не допускаются.

object ( VehicleAttribute )

Вызывающие программы могут формировать сложные логические операции, используя любую комбинацию полей requiredAttributes , requiredOneOfAttributes и requiredOneOfAttributeSets .

requiredAttributes — это список; requiredOneOfAttributes использует сообщение, которое разрешает список списков. В сочетании эти два поля позволяют составить это выражение:

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

Ограничивает поиск только теми транспортными средствами с указанными атрибутами. Это поле представляет собой операцию конъюнкции/И. Допускается максимум 50 обязательных атрибутов. Это соответствует максимальному количеству атрибутов, разрешенных для транспортного средства.

object ( VehicleAttributeList )

Ограничивает поиск только теми транспортными средствами, у которых есть хотя бы один из указанных атрибутов в каждом VehicleAttributeList . В каждом списке транспортное средство должно соответствовать хотя бы одному из атрибутов. Это поле представляет собой включающую операцию разъединения/ИЛИ в каждом VehicleAttributeList и операцию объединения/И в коллекции VehicleAttributeList .

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 .

enum ( VehicleMatchOrder )

Необходимый. Указывает желаемый критерий упорядочения результатов.

boolean

Это указывает на то, подходят ли для этого поиска транспортные средства с одной активной поездкой. Это поле используется только в том случае, если currentTripsPresent не указано. Если currentTripsPresent не указан и это поле имеет значение false , транспортные средства с назначенными поездками исключаются из результатов поиска. Если currentTripsPresent не указан и это поле имеет true , результаты поиска могут включать транспортные средства с одной активной поездкой, имеющей статус ENROUTE_TO_DROPOFF . Если указано currentTripsPresent , для этого поля не может быть установлено значение true.

Значение по умолчанию — false .

string

Указывает поездку, связанную с этим SearchVehicleRequest .

enum ( CurrentTripsPresent )

Это указывает на то, подходят ли для этого поиска автомобили с активными поездками. Должно быть установлено значение, отличное от CURRENT_TRIPS_PRESENT_UNSPECIFIED , если tripType включает SHARED .

string

Необязательный. Запрос-фильтр, применяемый при поиске транспортных средств. См. http://aip.dev/160 для примеров синтаксиса фильтра.

Это поле предназначено для замены полей requiredAttributes , requiredOneOfAttributes и required_one_of_attributes_sets . Если здесь указано непустое значение, следующие поля должны быть пустыми: requiredAttributes , requiredOneOfAttributes и required_one_of_attributes_sets .

Этот фильтр работает как предложение AND с другими ограничениями, такими как minimumCapacity или vehicleTypes .

Обратите внимание, что поддерживаются только запросы по атрибутам транспортного средства (например, attributes.<key> = <value> или attributes.<key1> = <value1> AND attributes.<key2> = <value2> ). Максимальное количество ограничений, разрешенное в запросе фильтра, — 50.

Кроме того, все атрибуты хранятся в виде строк, поэтому единственным поддерживаемым сравнением атрибутов является сравнение строк. Для сравнения с числовыми или логическими значениями значения должны быть явно заключены в кавычки, чтобы их можно было рассматривать как строки (например, attributes.<key> = "10" или attributes.<key> = "true" ).