Возвращает постраничный список транспортных средств, связанных с поставщиком, которые соответствуют параметрам запроса.
HTTP-запрос
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
URL-адрес использует синтаксис транскодирования gRPC .
Параметры пути
Параметры | |
---|---|
parent | Необходимый. Должно быть в формате |
Параметры запроса
Параметры | |
---|---|
header | Стандартный заголовок запроса Fleet Engine. |
page Size | Максимальное количество возвращаемых автомобилей. Значение по умолчанию: 100. |
page Token | Значение |
minimum Capacity | Указывает необходимую минимальную грузоподъемность автомобиля. Все возвращенные транспортные средства будут иметь |
trip Types[] | Ограничивает ответ транспортными средствами, которые поддерживают хотя бы один из указанных типов поездок. |
maximum Staleness | Ограничивает ответ транспортными средствами, которые отправили обновления местоположения в Fleet Engine в течение указанного периода. Стационарные транспортные средства, все еще передающие свое местоположение, не считаются устаревшими. Если присутствует, должна быть действительная положительная продолжительность. Продолжительность в секундах, содержащая до девяти дробных цифр и оканчивающаяся на « |
vehicle Type Categories[] | Необходимый. Ограничивает ответ транспортными средствами одной из указанных типовых категорий. |
required Attributes[] | Вызывающие объекты могут формировать сложные логические операции, используя любую комбинацию полей
Ограничивает ответ транспортными средствами с указанными атрибутами. Это поле представляет собой операцию конъюнкции/И. Допускается максимум 50 обязательных атрибутов. Это соответствует максимальному количеству атрибутов, разрешенных для транспортного средства. Каждая повторяющаяся строка должна иметь формат «ключ:значение». |
required One Of Attributes[] | Ограничивает ответ транспортными средствами, имеющими хотя бы один из указанных атрибутов в каждом |
required One Of Attribute Sets[] | Подобно
Ограничивает ответ транспортными средствами, которые соответствуют всем атрибутам в |
vehicle State | Ограничивает ответ транспортными средствами, имеющими это состояние. |
on Trip Only | Возвращайте только автомобили с текущей поездкой(ями). |
filter | Необязательный. Запрос-фильтр, применяемый при перечислении транспортных средств. См. http://aip.dev/160 для примеров синтаксиса фильтра. Это поле предназначено для замены полей Этот фильтр работает как предложение AND с другими ограничениями, такими как Обратите внимание, что поддерживаются только запросы по атрибутам транспортного средства (например, Кроме того, все атрибуты хранятся в виде строк, поэтому единственным поддерживаемым сравнением атрибутов является сравнение строк. Для сравнения с числовыми или логическими значениями значения должны быть явно заключены в кавычки, чтобы их можно было рассматривать как строки (например, |
viewport | Необязательный. Фильтр, который ограничивает количество транспортных средств, возвращаемых теми, чье последнее известное местоположение находилось в прямоугольной области, определенной окном просмотра. |
Тело запроса
Тело запроса должно быть пустым.
Тело ответа
ответное сообщение vehicles.list
.
В случае успеха тело ответа содержит данные следующей структуры:
JSON-представление |
---|
{
"vehicles": [
{
object ( |
Поля | |
---|---|
vehicles[] | Транспортные средства, соответствующие критериям запроса. Максимальное количество возвращаемых транспортных средств определяется полем |
next Page Token | Токен для получения следующей страницы транспортных средств или пустой, если транспортных средств, соответствующих критериям запроса, больше нет. |
total Size | Необходимый. Общее количество автомобилей, соответствующих критериям запроса на всех страницах. |
Область просмотра
Окно просмотра широты и долготы, представленное в виде двух диагонально противоположных low
и high
точек. Область просмотра считается закрытой областью, т. е. включает в себя ее границу. Границы широты должны находиться в диапазоне от -90 до 90 градусов включительно, а границы долготы должны находиться в диапазоне от -180 до 180 градусов включительно. Различные случаи включают в себя:
Если
low
=high
, область просмотра состоит из этой единственной точки.Если
low.longitude
>high.longitude
, диапазон долготы инвертируется (окно просмотра пересекает линию долготы в 180 градусов).Если
low.longitude
= -180 градусов иhigh.longitude
= 180 градусов, область просмотра включает все значения долготы.Если
low.longitude
= 180 градусов иhigh.longitude
= -180 градусов, диапазон долготы пуст.Если
low.latitude
>high.latitude
, диапазон широт пуст.
Оба значения low
и high
должны быть заполнены, а представленное поле не может быть пустым (как указано в определениях выше). Пустое окно просмотра приведет к ошибке.
Например, это окно просмотра полностью охватывает Нью-Йорк:
{ "низкая": { "широта": 40,477398, "долгота": -74,259087 }, "высокая": { "широта": 40,91618, "долгота": -73,70018 } }
JSON-представление |
---|
{ "low": { object ( |
Поля | |
---|---|
low | Необходимый. Нижняя точка смотрового окна. |
high | Необходимый. Самая высокая точка смотрового окна. |