- Solicitação HTTP
- Parâmetros de caminho
- Parâmetros de consulta
- Corpo da solicitação
- Corpo da resposta
- Janela de visualização
Retorna uma lista paginada de veículos associados a um provedor que corresponde às opções de solicitação.
Solicitação HTTP
GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles
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 |
O cabeçalho de solicitação padrão do Fleet Engine. |
pageSize |
O número máximo de veículos a serem retornados. Valor padrão: 100. |
pageToken |
O valor do |
minimumCapacity |
Especifica a capacidade mínima exigida do veículo. Todos os veículos retornados terão um |
tripTypes[] |
Restringe a resposta a veículos que aceitam pelo menos um dos tipos de viagem especificados. |
maximumStaleness |
Restringe a resposta aos veículos que enviaram atualizações de localização para o Fleet Engine no período especificado. Veículos parados que ainda estiverem transmitindo a localização não são considerados desatualizados. Se presente, precisa ser uma duração positiva válida. Duração em segundos com até nove dígitos fracionários, terminando em " |
vehicleTypeCategories[] |
Obrigatório. Restringe a resposta a veículos com uma das categorias de tipo especificadas. A política |
requiredAttributes[] |
Os autores da chamada podem formar operações lógicas complexas usando qualquer combinação dos campos
Restringe a resposta a veículos com os atributos especificados. Este campo é uma operação de conjunção/E. São permitidos no máximo 50 requiredAttributes. Esse número corresponde ao número máximo de atributos permitidos em um veículo. Cada string repetida precisa estar no formato "chave:valor". |
requiredOneOfAttributes[] |
Restringe a resposta a veículos com pelo menos um dos atributos especificados em cada |
requiredOneOfAttributeSets[] |
Assim como
Restringe a resposta a veículos que correspondem a todos os atributos em uma |
vehicleState |
Restringe a resposta aos veículos que têm esse estado. |
onTripOnly |
Devolva apenas os veículos com as viagens atuais. |
filter |
Opcional. Uma consulta de filtro para aplicar na listagem de veículos. Acesse http://aip.dev/160 para ver exemplos da sintaxe de filtro. Esse campo foi projetado para substituir os campos Esse filtro funciona como uma cláusula "E" com outras restrições, como As únicas consultas aceitas são em atributos de veículos (por exemplo, Além disso, todos os atributos são armazenados como strings. Portanto, as únicas comparações compatíveis com os atributos são as de strings. Para comparação com valores numéricos ou booleanos, os valores precisam estar explicitamente entre aspas para serem tratados como strings (por exemplo, |
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
Mensagem de resposta de vehicles.list
.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"vehicles": [
{
object ( |
Campos | |
---|---|
vehicles[] |
Veículos que correspondem aos critérios na solicitação. O número máximo de veículos retornados é determinado pelo campo |
nextPageToken |
Token para recuperar a próxima página de veículos ou vazio se não houver mais veículos que atendam aos critérios da solicitação. |
totalSize |
Obrigatório. Número total de veículos 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 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. |