Method: providers.trips.search

Receber todas as viagens de um veículo específico.

Solicitação HTTP

POST https://fleetengine.googleapis.com/v1/{parent=providers/*}/trips:search

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 provedor precisa ser o ID do projeto (por exemplo, sample-cloud-project) do projeto do Google Cloud do qual a conta de serviço que faz a chamada é membro.

Corpo da solicitação

O corpo da solicitação contém dados com a seguinte estrutura:

Representação JSON 
{
  "header": {
    object (RequestHeader)
  },
  "vehicleId": string,
  "activeTripsOnly": boolean,
  "pageSize": integer,
  "pageToken": string,
  "minimumStaleness": string
}
Campos
header

object (RequestHeader)

O cabeçalho de solicitação padrão do Fleet Engine.
vehicleId

string

O veículo associado às viagens na solicitação. Se não for especificado, as viagens retornadas não vão conter:

  • currentRouteSegment
  • remainingWaypoints
  • remainingDistanceMeters
  • etaToFirstWaypoint
activeTripsOnly

boolean

Se ela for definida como verdadeira, a resposta incluirá viagens que influenciam o trajeto de um motorista.
pageSize

integer

Se não for definido, o servidor decidirá o número de resultados a serem retornados.
pageToken

string

Defina esse valor como um valor retornado anteriormente em SearchTripsResponse para continuar a partir dos resultados anteriores.
minimumStaleness

string (Duration format)

Se especificado, retorna as viagens que não foram atualizadas após o horário (current - minimumStaleness).

Duração em segundos com até nove dígitos fracionários, terminando em "s". Exemplo: "3.5s".

Corpo da resposta

Mensagem de resposta trips.search.

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

Representação JSON 
{
  "trips": [
    {
      object (Trip)
    }
  ],
  "nextPageToken": string
}
Campos
trips[]

object (Trip)

A lista de viagens para o veículo solicitado.
nextPageToken

string

Transmita esse token no SearchTripsRequest para percorrer os resultados da lista. A API retorna uma lista de viagens em cada chamada. Quando não há mais resultados, a lista de viagens fica vazia.