Возвращает список транспортных средств, соответствующих параметрам запроса.
HTTP-запрос
POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles:search
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
parent | Необходимый. Должно быть в формате |
Тело запроса
Тело запроса содержит данные следующей структуры:
JSON-представление |
---|
{ "header": { object ( |
Поля | |
---|---|
header | Стандартный заголовок запроса Fleet Engine. |
pickupPoint | Необходимый. Пункт выдачи, который нужно искать рядом. |
dropoffPoint | Предполагаемое место высадки клиента. Поле является обязательным, если |
pickupRadiusMeters | Необходимый. Определяет радиус поиска автомобиля вокруг точки посадки. Возврату подлежат только транспортные средства, находящиеся в радиусе поиска. Значение должно быть от 400 до 10 000 метров (включительно). |
count | Необходимый. Указывает максимальное количество возвращаемых транспортных средств. Значение должно находиться в диапазоне от 1 до 50 (включительно). |
minimumCapacity | Необходимый. Указывает количество пассажиров, рассматриваемых для поездки. Значение должно быть больше или равно единице. Драйвер не учитывается в значении емкости. |
tripTypes[] | Необходимый. Представляет тип предлагаемой поездки. Должен включать ровно один тип. |
maximumStaleness | Ограничивает поиск только теми транспортными средствами, которые отправили обновления местоположения в Fleet Engine в течение указанного периода. Стационарные транспортные средства, все еще передающие свое местоположение, не считаются устаревшими. Если это поле не задано, сервер использует пять минут в качестве значения по умолчанию. Длительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
vehicleTypes[] | Необходимый. Ограничивает поиск транспортными средствами одного из указанных типов. Должен быть указан хотя бы один тип транспортного средства. Типы транспортных средств с категорией |
requiredAttributes[] | Вызывающие объекты могут формировать сложные логические операции, используя любую комбинацию полей
Ограничивает поиск только теми транспортными средствами с указанными атрибутами. Это поле представляет собой операцию конъюнкции/И. Допускается максимум 50 обязательных атрибутов. Это соответствует максимальному количеству атрибутов, разрешенных для транспортного средства. |
requiredOneOfAttributes[] | Ограничивает поиск только теми транспортными средствами, у которых есть хотя бы один из указанных атрибутов в каждом |
requiredOneOfAttributeSets[] | Подобно
Ограничивает поиск только теми транспортными средствами, которые имеют все атрибуты в |
orderBy | Необходимый. Указывает желаемый критерий упорядочения результатов. |
includeBackToBack | Это указывает на то, подходят ли для этого поиска транспортные средства с одной активной поездкой. Это поле используется только в том случае, если значение Значение по умолчанию |
tripId | Указывает поездку, связанную с этим |
currentTripsPresent | Это указывает на то, подходят ли для этого поиска автомобили с активными поездками. Должно быть установлено значение, отличное от |
filter | Необязательный. Фильтрационный запрос, применяемый при поиске транспортных средств. См. http://aip.dev/160 для примеров синтаксиса фильтра. Это поле предназначено для замены полей Этот фильтр работает как предложение AND с другими ограничениями, такими как Обратите внимание, что поддерживаются только запросы по атрибутам транспортного средства (например, Кроме того, все атрибуты хранятся в виде строк, поэтому единственным поддерживаемым сравнением атрибутов является сравнение строк. Для сравнения с числовыми или логическими значениями значения должны быть явно заключены в кавычки, чтобы их можно было рассматривать как строки (например, |
Тело ответа
В случае успеха тело ответа содержит экземпляр SearchVehiclesResponse
.