Method: providers.deliveryVehicles.list

Получает все объекты DeliveryVehicle , соответствующие указанным критериям фильтрации.

HTTP-запрос

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

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

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

Параметры
parent

string

Необходимый. Должно быть в формате providers/{provider} . provider должен быть идентификатор проекта Google Cloud. Например, sample-cloud-project .

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

Параметры
header

object ( DeliveryRequestHeader )

Необязательный. Стандартный заголовок запроса API доставки.

page Size

integer

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

page Token

string

Необязательный. Токен страницы, полученный в результате предыдущего вызова deliveryVehicles.list . Вы должны предоставить это, чтобы получить следующую страницу.

При разбиении на страницы все остальные параметры, предоставленные в deliveryVehicles.list должны соответствовать вызову, который предоставил токен страницы.

filter

string

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

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

Максимальное количество ограничений, допустимое в запросе фильтра, — 50. Ограничение — это часть запроса attribute.<KEY> <COMPARATOR> <VALUE> , например attributes.foo = bar — 1 ограничение.

viewport

object ( Viewport )

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

Тело запроса

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

Тело ответа

Ответное сообщение deliveryVehicles.list .

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

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

object ( DeliveryVehicle )

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

next Page Token

string

Вы можете передать этот токен в ListDeliveryVehiclesRequest , чтобы продолжить выводить результаты. Когда будут возвращены все результаты, этого поля не будет в ответе или это будет пустая строка.

total Size

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 )

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