REST Resource: projects.trips

Recurso: Trip

Uma viagem.

Representação JSON 
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
Campos
name

string

Apenas saída. Identificador. O nome do recurso da viagem. Formato: projects/{project_number}/trips/{tripId}.
config

object (TripConfig)

Imutável. A configuração da viagem.
androidAppId

string

Somente entrada. Imutável. O ID do aplicativo Android do app para dispositivos móveis que vai usar a viagem. É necessário definir pelo menos uma das propriedades: androidAppId ou iosAppId.
iosAppId

string

Somente entrada. Imutável. O ID do pacote iOS do aplicativo para dispositivos móveis que vai usar a viagem. É necessário definir pelo menos uma das propriedades: androidAppId ou iosAppId.
authToken

object (AuthToken)

Apenas saída. Um token opaco que autoriza o acesso para iniciar uma viagem do NavConnect no Google Maps ou no Waze e concede a esses aplicativos acesso para atualizar a viagem. Retornado apenas por trips.create.
state

enum (State)

Apenas saída. O estado da viagem.
execution

object (TripExecution)

Apenas saída. Os dados mais recentes sobre a execução da viagem. Isso não pode ser definido se a viagem estiver em um estado de erro.
createTime

string (Timestamp format)

Apenas saída. Horário de criação da viagem de acordo com o servidor.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Apenas saída. Hora em que o servidor recebeu a atualização mais recente da viagem.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

TripConfig

Configuração da viagem.

Representação JSON 
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string,
  "enableRemainingRouteReporting": boolean
}
Campos
enableHighFrequencyUpdates

boolean

Opcional. Define se as atualizações de viagem de alta frequência serão ativadas.

OBSERVAÇÃO: ao ativar esse recurso, a viagem é registrada no uso do nível Enterprise e está sujeita às taxas desse nível.
enablePubsub

boolean

Opcional. Se as notificações do Pub/Sub para a viagem estão ativadas.
pubsubFieldMask

string (FieldMask format)

Opcional. Se definido, apenas o subconjunto especificado dos campos "Trip" será incluído nas notificações do Pub/Sub.

Se não estiver definido, todos os campos de viagem serão incluídos nas notificações do Pub/Sub (comportamento padrão).

Os seguintes campos não são compatíveis:

  • androidAppId
  • iosAppId
  • authToken
  • config

OBSERVAÇÃO: esse campo será ignorado se enablePubsub for "false".

É uma lista separada por vírgulas de nomes de campos totalmente qualificados. Exemplo: "user.displayName,photo".
enableRemainingRouteReporting

boolean

Opcional. Se o relatório da rota restante da viagem deve ser ativado.

OBSERVAÇÃO: ao ativar esse recurso, a viagem é registrada no uso do nível Enterprise e está sujeita às taxas desse nível.

AuthToken

Um token de autenticação.

Representação JSON 
{
  "token": string,
  "expireTime": string
}
Campos
token

string

Apenas saída. O token de autenticação que precisa ser transmitido ao aplicativo para dispositivos móveis.
expireTime

string (Timestamp format)

Apenas saída. Horário em que o token de autenticação vai expirar.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

Estado

Todos os estados possíveis da viagem.

Tipos enumerados
STATE_UNSPECIFIED O estado da viagem não foi especificado.
NEW A viagem foi criada, mas ainda não começou.
ENROUTE O transportador está a caminho do destino.
ARRIVED O transportador chegou ao destino.
SUSPENDED A viagem foi suspensa.
FAILED A viagem não foi concluída.
CLIENT_ERROR A viagem falhou devido a um erro do cliente.
CANCELED A viagem foi cancelada explicitamente pelo desenvolvedor.

TripExecution

Dados sobre a execução da viagem.

Representação JSON 
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "remainingRoute": {
    object (Route)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
Campos
origin

object (Location)

Apenas saída. Origem da viagem, que geralmente é o local do transportador no início da viagem do NavConnect.
destination

object (Stop)

Apenas saída. O destino da viagem informado pelo aplicativo para dispositivos móveis.
location

object (Location)

Apenas saída. O indicador de localização que representa o último local conhecido do transportador. Esse será o local ajustado à via, se disponível.
remainingRoute

object (Route)

Apenas saída. Fornece a polilinha para a parte restante do trajeto.
traveledDuration

string (Duration format)

Apenas saída. Tempo de viagem até agora.

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

string (Duration format)

Apenas saída. Tempo restante da viagem, conforme estimado pelo Google.

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

integer

Apenas saída. Distância percorrida desde a origem em metros.
remainingDistanceMeters

integer

Apenas saída. Distância restante até o destino em metros.
stopAddedInRoute

boolean

Apenas saída. Indica se uma parada foi adicionada ao longo do trajeto.

Local

Um local informado pelo aplicativo para dispositivos móveis.

Representação JSON 
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
Campos
point

object (LatLng)

Apenas saída. A latitude/longitude do local.
sourceTime

string (Timestamp format)

Apenas saída. O momento em que o local foi originado, conforme indicado pelo cliente.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
serverTime

string (Timestamp format)

Apenas saída. A hora em que o servidor recebeu essa atualização do local.

Usa o padrão RFC 3339, em que a saída gerada é sempre convertida em Z e tem 0, 3, 6 ou 9 dígitos fracionários. Além de "Z", outros ajustes também são aceitos. Exemplos: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

LatLng

Um objeto que representa um par de latitude/longitude. Ele é expresso como um par de valores duplos para representar graus de latitude e longitude. A menos que especificado de outra forma, esse objeto precisa seguir o padrão WGS84. Os valores precisam estar dentro de intervalos normalizados.

Representação JSON 
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

A latitude em graus. Precisa estar no intervalo [-90,0, +90,0].
longitude

number

A longitude em graus. Precisa estar no intervalo [-180,0, +180,0].

Parar

Uma parada na viagem em que alguma tarefa precisa ser realizada.

Representação JSON 
{
  "point": {
    object (LatLng)
  }
}
Campos
point

object (LatLng)

Obrigatório. A localização da parada como uma latitude/longitude.

Rota

Uma polilinha de rota.

Representação JSON 
{
  "trafficInformation": [
    {
      object (SpeedReadingInterval)
    }
  ],

  // Union field format can be only one of the following:
  "simplePolyline": {
    object (SimplePolyline)
  },
  "encodedPolyline": string,
  "s2Polyline": string,
  "geoJson": {
    object
  }
  // End of list of possible types for union field format.
}
Campos
trafficInformation[]

object (SpeedReadingInterval)

Apenas saída. Informações de trânsito na polilinha descritas como intervalos de leitura de velocidade.

OBSERVAÇÃO:

  • Os intervalos não se sobrepõem.
  • Os intervalos são contíguos.
  • Os intervalos cobrem toda a polilinha.
  • Os intervalos são classificados por índice crescente.
  • A velocidade é especificada para cada intervalo.

Campo de união format. O formato da rota.

O formato preenchido é controlado pelo parâmetro route_polyline_format. Se não for definido, o padrão será uma polilinha simples. format pode ser apenas de um dos tipos a seguir:
simplePolyline

object (SimplePolyline)

Apenas saída. A rota como uma lista simples de latlngs.
encodedPolyline

string

Apenas saída. O trajeto como uma polilinha codificada. Consulte https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
s2Polyline

string (bytes format)

Apenas saída. O trajeto como uma S2Polyline codificada. Consulte https://s2geometry.io/devguide/basic_types.html.

Uma string codificada em base64.
geoJson

object (Struct format)

Apenas saída. O trajeto como uma LineString GeoJSON. Consulte https://tools.ietf.org/html/rfc7946#section-3.1.4.

SimplePolyline

Representa uma polilinha usando uma lista simples de pontos.

Representação JSON 
{
  "points": [
    {
      object (LatLng)
    }
  ]
}
Campos
points[]

object (LatLng)

Apenas saída. Lista ordenada de pontos que representam a polilinha.

SpeedReadingInterval

Indicador de intensidade do trânsito em um segmento contíguo de um trajeto. Dado um trajeto com pontos P_0, P_1, ... , P_N (índice de base zero), o SpeedReadingInterval define um intervalo e descreve o trânsito dele usando as categorias Speed.

Representação JSON 
{
  "speed": enum (Speed),
  "startPolylinePointIndex": integer,
  "endPolylinePointIndex": integer
}
Campos
speed

enum (Speed)

Apenas saída. Velocidade do trânsito neste intervalo.
startPolylinePointIndex

integer

Apenas saída. O índice inicial desse intervalo no caminho.
endPolylinePointIndex

integer

Apenas saída. O índice final desse intervalo no caminho.

Velocidade

A classificação da velocidade da polilinha com base em informações de trânsito.

Tipos enumerados
SPEED_UNSPECIFIED A velocidade não foi especificada.
NORMAL Velocidade normal, sem trânsito.
SLOW Lentidão detectada, trânsito leve a moderado.
TRAFFIC_JAM Atrasos no trânsito, incluindo trânsito parado.

Métodos

create

 Cria uma viagem.

get

 Recebe uma viagem.