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

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}

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.

Parar

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

Campos
point

LatLng

Obrigatório. O local 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 app 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.

TripConfig

Configuração da viagem.

Campos
enable_high_frequency_updates

bool

Opcional. Se as atualizações de viagem de alta frequência devem ser 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 pubsub.

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

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

Duration

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

Duration

Apenas saída. Tempo restante desta viagem, 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.