- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Janela de visualização
Recebe todos os DeliveryVehicle
s 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 |
Obrigatório. Precisa estar no formato |
Parâmetros de consulta
Parâmetros | |
---|---|
header |
Opcional. O cabeçalho de solicitação padrão da API Delivery. |
pageSize |
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 determinará o número de resultados a serem retornados. |
pageToken |
Opcional. Um token de página recebido de uma chamada Ao paginar, todos os outros parâmetros fornecidos para |
filter |
Opcional. Uma consulta de filtro para aplicar ao listar veículos de entrega. Consulte http://aip.dev/160 para ver exemplos de sintaxe de filtro. Se você não especificar um valor ou especificar uma string vazia para o filtro, todos os veículos de entrega serão retornados. As únicas consultas aceitas para O número máximo de restrições permitido em uma consulta de filtro é 50. Uma restrição faz parte da consulta no formato |
viewport |
Opcional. Um filtro que limita os veículos retornados àqueles cujo último local conhecido estava na área retangular definida pela janela de visualização. |
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 ( |
Campos | |
---|---|
deliveryVehicles[] |
O conjunto de veículos de entrega que atende 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 não foram encontrados veículos de entrega que atendem aos critérios do filtro solicitado. |
nextPageToken |
É possível transmitir esse token no |
totalSize |
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 janela de visualização de latitude e longitude, representada como dois pontos diagonalmente opostos low
e high
. Uma janela de visualização é considerada uma região fechada, ou seja, inclui seus limites. Os limites de latitude devem variar entre -90 e 90 graus, e os limites de longitude devem variar entre -180 e 180 graus. Os vários casos incluem:
Se
low
=high
, a janela de visualização consistirá nesse único ponto.Se
low.longitude
>high.longitude
, o intervalo de longitude será invertido (a janela de visualização cruza a linha de 180 graus de longitude).Se
low.longitude
= -180 graus ehigh.longitude
= 180 graus, a janela de visualização incluirá todas as longitudes.Se
low.longitude
= 180 graus ehigh.longitude
= -180 graus, o intervalo de longitude está vazio.Se
low.latitude
>high.latitude
, o intervalo de latitude está vazio.
Tanto low
quanto high
precisam ser preenchidos, e a caixa representada não pode ficar vazia (conforme especificado pelas 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 ( |
Campos | |
---|---|
low |
Obrigatório. O ponto baixo da janela de visualização. |
high |
Obrigatório. O ponto alto da janela de visualização. |