- 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 da API Delivery padrão. |
pageSize |
Opcional. O número máximo de veículos a serem retornados. O serviço pode retornar menos do que esse número. Se você não especificar esse número, o servidor vai 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. Acesse http://aip.dev/160 para ver exemplos da 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 com suporte 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 cuja última localização conhecida 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 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 ficar vazia. Uma resposta vazia indica que não foram encontrados veículos de entrega que atendem aos critérios do filtro solicitados. |
nextPageToken |
É possível transmitir esse token no |
totalSize |
O número total de veículos de entrega que correspondem aos critérios da solicitação em todas as páginas. |
Janela de visualização
Uma janela de visualização de latitude e longitude, representada como dois pontos low
e high
diagonalmente opostos. Uma janela de visualização é considerada uma região fechada, ou seja, inclui seu limite. Os limites de latitude precisam variar entre -90 e 90 graus, inclusive, e os limites de longitude, entre -180 e 180 graus, inclusive. 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 longitude de 180 graus).Se
low.longitude
= -180 graus ehigh.longitude
= 180 graus, a janela de visualização vai incluir todas as longitudes.Se
low.longitude
= 180 graus ehigh.longitude
= -180 graus, o intervalo de longitude vai ficar vazio.Se
low.latitude
>high.latitude
, o intervalo de latitude vai estar vazio.
low
e high
precisam ser preenchidos, e a caixa representada não pode estar vazia (conforme especificado pelas definições acima). Uma janela de visualização vazia resultará em um erro.
Por exemplo, esta janela de visualização abrange totalmente a cidade de 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 inferior da janela de visualização. |
high |
Obrigatório. O ponto mais alto da janela de visualização. |