Method: providers.vehicles.list

Возвращает постраничный список транспортных средств, связанных с поставщиком, которые соответствуют параметрам запроса.

HTTP-запрос

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles

URL-адрес использует синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Необходимый. Должно быть в формате providers/{provider} . Поставщиком должен быть идентификатор проекта (например, sample-cloud-project ) проекта Google Cloud, участником которого является сервисный аккаунт, выполняющий этот вызов.

Параметры запроса

Параметры
header

object ( RequestHeader )

Стандартный заголовок запроса Fleet Engine.

pageSize

integer

Максимальное количество возвращаемых автомобилей. Значение по умолчанию: 100.

pageToken

string

Значение nextPageToken , предоставленное предыдущим вызовом vehicles.list , чтобы вы могли перемещаться по группам транспортных средств. Значение не определено, если критерии фильтра запроса не совпадают с критериями фильтра для предыдущего вызова vehicles.list .

minimumCapacity

integer

Указывает необходимую минимальную грузоподъемность автомобиля. Все возвращенные транспортные средства будут иметь maximumCapacity , превышающую или равную этому значению. Если установлено, должно быть больше или равно 0.

tripTypes[]

enum ( TripType )

Ограничивает ответ транспортными средствами, которые поддерживают хотя бы один из указанных типов поездок.

maximumStaleness

string ( Duration format)

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

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

vehicleTypeCategories[]

enum ( Category )

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

requiredAttributes[]

string

Вызывающие объекты могут формировать сложные логические операции, используя любую комбинацию полей 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 обязательных атрибутов. Это соответствует максимальному количеству атрибутов, разрешенных для транспортного средства. Каждая повторяющаяся строка должна иметь формат «ключ:значение».

requiredOneOfAttributes[]

string

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

requiredOneOfAttributeSets[]

string

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 . Каждая повторяющаяся строка должна иметь формат «ключ1:значение1|ключ2:значение2|ключ3:значение3».

vehicleState

enum ( VehicleState )

Ограничивает ответ транспортными средствами, имеющими это состояние.

onTripOnly

boolean

Возвращайте только автомобили с текущей поездкой(ями).

filter

string

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

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

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

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

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

viewport

object ( Viewport )

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

Тело запроса

Тело запроса должно быть пустым.

Тело ответа

ответное сообщение vehicles.list .

В случае успеха тело ответа содержит данные следующей структуры:

JSON-представление
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Поля
vehicles[]

object ( Vehicle )

Транспортные средства, соответствующие критериям запроса. Максимальное количество возвращаемых транспортных средств определяется полем pageSize в запросе.

nextPageToken

string

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

totalSize

string ( int64 format)

Необходимый. Общее количество автомобилей, соответствующих критериям запроса на всех страницах.

Область просмотра

Окно просмотра широты и долготы, представленное в виде двух диагонально противоположных 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 (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Поля
low

object ( LatLng )

Необходимый. Нижняя точка смотрового окна.

high

object ( LatLng )

Необходимый. Самая высокая точка смотрового окна.