Package google.maps.navconnect.v1

Índice

Servicio para que los clientes de NavConnect creen y obtengan viajes.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Crea un viaje. Se debe llamar a este método antes de que la aplicación para dispositivos móviles pueda iniciar el viaje. El viaje devuelto tendrá el campo auth_token establecido.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform
GetTrip

rpc GetTrip(GetTripRequest) returns (Trip)

Obtiene un viaje.

Permisos de autorización

Requiere el siguiente permiso de OAuth:

  • https://www.googleapis.com/auth/cloud-platform

AuthToken

Es un token de autenticación.

Campos
token

string

Solo salida. Es el token de autenticación que se debe pasar a la aplicación para dispositivos móviles.
expire_time

Timestamp

Solo salida. Fecha y hora en la que vencerá el token de autenticación.

CreateTripRequest

Es el mensaje de solicitud para NavConnectService.CreateTrip.

Campos
parent

string

Obligatorio. Es el recurso principal en el que se creará este viaje. Formato: projects/{project_number}
trip_id

string

Obligatorio. Es el ID que se usará para el viaje, que se convertirá en el componente final del nombre del recurso del viaje.

Este valor debe ser un UUID válido según RFC-4122.
trip

Trip

Obligatorio. Es el viaje que se creará.

GetTripRequest

Es el mensaje de solicitud de NavConnectService.GetTrip.

Campos
name

string

Obligatorio. Es el nombre del recurso del viaje que se obtendrá. Formato: projects/{project}/trips/{trip_id}

Ubicación

Es una ubicación según la informa la aplicación para dispositivos móviles.

Campos
point

LatLng

Solo salida. Latitud y longitud de la ubicación
source_time

Timestamp

Solo salida. Es la fecha y hora en la que el cliente indicó que se obtuvo la ubicación.
server_time

Timestamp

Solo salida. Es la fecha y hora en la que el servidor recibió esta actualización de ubicación.

Detener

Es una parada en el viaje en la que se debe realizar alguna tarea.

Campos
point

LatLng

Obligatorio. Ubicación de la parada como latitud y longitud.

Viaje

Un viaje

Campos
name

string

Solo salida. Es el identificador. Es el nombre del recurso del viaje. Formato: projects/{project_number}/trips/{trip_id}.
config

TripConfig

Inmutable. Es la configuración del viaje.
android_app_id

string

Solo entrada. Inmutable. Es el ID de aplicación para Android de la aplicación para dispositivos móviles que usará el viaje. Se debe configurar al menos uno de los valores android_app_id o ios_app_id.
ios_app_id

string

Solo entrada. Inmutable. Es el ID del paquete de iOS de la aplicación para dispositivos móviles que usará el viaje. Se debe configurar al menos uno de los valores android_app_id o ios_app_id.
auth_token

AuthToken

Solo salida. Es un token opaco que autoriza el acceso para comenzar un viaje de NavConnect en Google Maps o Waze, y otorga a estas aplicaciones acceso para actualizar el viaje. Solo lo devuelve CreateTrip.
state

State

Solo salida. Es el estado del viaje.
execution

TripExecution

Solo salida. Son los datos más recientes sobre la ejecución del viaje. Es posible que no se establezca si el viaje está en estado de error.
create_time

Timestamp

Solo salida. Fecha y hora según el servidor en la que se creó el viaje.
update_time

Timestamp

Solo salida. Fecha y hora en que el servidor recibió la actualización de viaje más reciente.

Estado

Son todos los estados posibles del viaje.

Enums
STATE_UNSPECIFIED El estado del viaje no está especificado.
NEW Se creó el viaje, pero aún no comenzó.
ENROUTE El transporte está en camino al destino.
ARRIVED El transportista llegó al destino.
SUSPENDED Se suspendió el viaje.
FAILED El viaje no se completó correctamente.
CLIENT_ERROR El viaje falló debido a un error del cliente.

TripConfig

Es la configuración del viaje.

Campos
enable_high_frequency_updates

bool

Opcional. Indica si se deben habilitar las actualizaciones de viaje de alta frecuencia.

NOTA: Si habilitas esta función, el viaje se registrará como uso del nivel Enterprise y estará sujeto a las tarifas de ese nivel.
enable_pubsub

bool

Opcional. Indica si se deben habilitar las notificaciones de Pub/Sub para el viaje.
pubsub_field_mask

FieldMask

Opcional. Si se configura, solo se incluirá el subconjunto especificado de los campos de Trip en las notificaciones de Pub/Sub.

Si no se configura, todos los campos de Trip se incluirán en las notificaciones de Pub/Sub (comportamiento predeterminado).

Los siguientes campos no son compatibles:

  • android_app_id
  • ios_app_id
  • auth_token
  • config

NOTA: Este campo se ignora si enable_pubsub es falso.

TripExecution

Son datos sobre la ejecución del viaje.

Campos
origin

Location

Solo salida. Es el origen del viaje, que suele ser la ubicación del transportista al inicio del viaje de NavConnect.
destination

Stop

Solo salida. Es el destino del viaje según lo informa la aplicación para dispositivos móviles.
location

Location

Solo salida. Es el indicador de ubicación que representa la última ubicación conocida del transportista. Esta será la ubicación ajustada a la ruta si está disponible.
traveled_duration

Duration

Solo salida. Es el tiempo transcurrido hasta el momento.
remaining_duration

Duration

Solo salida. Es el tiempo restante estimado para este viaje según Google.
traveled_distance_meters

int32

Solo salida. Es la distancia recorrida desde el origen en metros.
remaining_distance_meters

int32

Solo salida. Distancia restante al destino en metros.
stop_added_in_route

bool

Solo salida. Indica si se agregó una parada a lo largo de la ruta.