Method: providers.deliveryVehicles.list

Recebe todos os DeliveryVehicles que atendem aos critérios de filtragem especificados.

Solicitação HTTP

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

O URL usa a sintaxe de transcodificação gRPC.

Parâmetros de caminho

Parâmetros
parent

string

Obrigatório. Precisa estar no formato providers/{provider}. O provider precisa ser o ID do projeto do Google Cloud. Por exemplo, sample-cloud-project.

Parâmetros de consulta

Parâmetros
header

object (DeliveryRequestHeader)

Opcional. O cabeçalho de solicitação padrão da API Delivery.
pageSize

integer

Opcional. O número máximo de veículos a serem retornados. O serviço pode retornar menos que esse valor. Se você não especificar esse número, o servidor vai determinar o número de resultados a serem retornados.
pageToken

string

Opcional. Um token de página recebido de uma chamada deliveryVehicles.list anterior. É necessário fornecer isso para recuperar a página subsequente.

Ao paginar, todos os outros parâmetros fornecidos para deliveryVehicles.list precisam corresponder à chamada que forneceu o token da página.
filter

string

Opcional. Uma consulta de filtro a ser aplicada ao listar veículos de entrega. Consulte http://aip.dev/160 para conferir exemplos da sintaxe de filtro. Se você não especificar um valor ou uma string vazia para o filtro, todos os veículos de entrega serão retornados.

As únicas consultas compatíveis com deliveryVehicles.list são em atributos de veículo (por exemplo, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Além disso, todos os atributos são armazenados como strings. Portanto, as únicas comparações compatíveis com atributos são comparações de string. Para fazer uma comparação com valores numéricos ou booleanos, os valores precisam estar explicitamente entre aspas para serem tratados como strings (por exemplo, attributes.<key> = "10" ou attributes.<key> = "true").

O número máximo de restrições permitido em uma consulta de filtro é 50. Uma restrição faz parte da consulta no formato attribute.<KEY> <COMPARATOR> <VALUE>, por exemplo, attributes.foo = bar é uma restrição.
viewport

object (Viewport)

Opcional. Um filtro que limita os veículos retornados àqueles cujo último local conhecido estava na área retangular definida pelo viewport.

Corpo da solicitação

O corpo da solicitação precisa estar vazio.

Corpo da resposta

A mensagem de resposta deliveryVehicles.list.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "deliveryVehicles": [
    {
      object (DeliveryVehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Campos
deliveryVehicles[]

object (DeliveryVehicle)

Conjunto de veículos de entrega que atendem aos critérios de filtragem solicitados. Quando nenhum filtro é especificado, a solicitação retorna todos os veículos de entrega. Uma resposta bem-sucedida também pode estar vazia. Uma resposta vazia indica que nenhum veículo de entrega foi encontrado que atenda aos critérios de filtro solicitados.
nextPageToken

string

É possível transmitir esse token no ListDeliveryVehiclesRequest para continuar listando os resultados. Quando todos os resultados forem retornados, esse campo não estará na resposta ou será uma string vazia.
totalSize

string (int64 format)

O número total de veículos de entrega que correspondem aos critérios de solicitação em todas as páginas.

Janela de visualização

Uma viewport de latitude-longitude, representada como dois pontos low e high diagonalmente opostos. Uma janela de visualização é considerada uma região fechada, ou seja, ela inclui o limite. Os limites de latitude precisam variar entre -90 e 90 graus, e os limites de longitude precisam variar entre -180 e 180 graus. Vários casos incluem:

  • Se low = high, a viewport consiste nesse único ponto.

  • Se low.longitude > high.longitude, o intervalo de longitude é invertido (a janela de visualização cruza a linha de longitude de 180 graus).

  • Se low.longitude = -180 graus e high.longitude = 180 graus, a viewport inclui todas as longitudes.

  • Se low.longitude = 180 graus e high.longitude = -180 graus, o intervalo de longitude estará vazio.

  • Se low.latitude for maior que high.latitude, o intervalo de latitude estará vazio.

low e high precisam ser preenchidos, e a caixa representada não pode estar vazia (conforme especificado nas definições acima). Uma janela de visualização vazia resultará em erro.

Por exemplo, esta janela de visualização abrange totalmente Nova York:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Representação JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campos
low

object (LatLng)

Obrigatório. O ponto mais baixo da janela de visualização.
high

object (LatLng)

Obrigatório. O ponto alto da janela de visualização.