Package google.maps.navconnect.v1

Índice

Serviço para clientes do NavConnect criarem e receberem viagens.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Cria uma viagem. Isso precisa ser chamado antes que o aplicativo móvel possa iniciar a viagem. A viagem retornada terá o campo auth_token definido.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso parent:

  • navigationconnect.trips.create

Para mais informações, consulte a documentação do IAM.
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Recebe uma viagem.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform
Permissões do IAM

Requer a seguinte permissão do IAM no recurso name:

  • navigationconnect.trips.get

Para mais informações, consulte a documentação do IAM.

AuthToken

Um token de autenticação.

Campos
token

string

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

Timestamp

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

CreateTripRequest

Mensagem de solicitação para NavConnectService.CreateTrip.

Campos
parent

string

Obrigatório. O recurso principal em que esta viagem será criada. Formato: projects/{project_number}
trip_id

string

Obrigatório. O ID a ser usado na viagem, que se tornará o componente final do nome do recurso da viagem.

Esse valor precisa ser um UUID RFC-4122 válido.
trip

Trip

Obrigatório. A viagem a ser criada.

GetTripRequest

Mensagem de solicitação para NavConnectService.GetTrip.

Campos
name

string

Obrigatório. O nome do recurso da viagem a ser recebida. Formato: projects/{project}/trips/{trip_id}
route_polyline_format

RoutePolylineFormat

Opcional. O formato da polilinha de rota a ser retornada. Se não estiver definido, a polilinha da rota SIMPLE será retornada.

RoutePolylineFormat

Especifica o formato da polilinha da rota.

Tipos enumerados
ROUTE_POLYLINE_FORMAT_UNSPECIFIED O formato da polilinha da rota não foi especificado.
SIMPLE A polilinha da rota é retornada como uma matriz simples de pontos representados como google.type.LatLng.
ENCODED A polilinha da rota é retornada como uma string codificada. Consulte https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
S2ENCODED A polilinha do trajeto é codificada como uma S2Polyline. Consulte https://s2geometry.io/devguide/basic_types.html.
GEO_JSON A polilinha do trajeto é retornada como uma LineString GeoJSON. Consulte https://tools.ietf.org/html/rfc7946#section-3.1.4.

Local

Um local informado pelo aplicativo para dispositivos móveis.

Campos
point

LatLng

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

Timestamp

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

Timestamp

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

Rota

Uma polilinha de rota.

Campos
traffic_information[]

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:
simple_polyline

SimplePolyline

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

string

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

bytes

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

Struct

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.

Campos
points[]

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.

Campos
speed

Speed

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

int32

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

int32

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.

Parar

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

Campos
point

LatLng

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

Viagem

Uma viagem.

Campos
name

string

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

TripConfig

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

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: android_app_id ou ios_app_id.
ios_app_id

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: android_app_id ou ios_app_id.
auth_token

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 CreateTrip.
state

State

Apenas saída. O estado da viagem.
execution

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.
create_time

Timestamp

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

Timestamp

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

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.

TripConfig

Configuração da viagem.

Campos
enable_high_frequency_updates

bool

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.
enable_pubsub

bool

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

FieldMask

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:

  • android_app_id
  • ios_app_id
  • auth_token
  • config

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

bool

Opcional. Indica 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.

TripExecution

Dados sobre a execução da viagem.

Campos
origin

Location

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

Stop

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

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.
remaining_route

Route

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

Duration

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

Duration

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

int32

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

int32

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

bool

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