Package google.maps.navconnect.v1

Index

Service permettant aux clients NavConnect de créer et d'obtenir des trajets.

CreateTrip

rpc CreateTrip(CreateTripRequest) returns (Trip)

Crée un trajet. Cette méthode doit être appelée avant que l'application mobile puisse démarrer le trajet. Le champ auth_token du trajet renvoyé sera défini.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

rpc GetTrip(GetTripRequest) returns (Trip)

Récupère un trajet.

Champs d'application des autorisations

Requiert le niveau d'accès OAuth suivant :

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

AuthToken

Jeton d'authentification.

Champs
token

string

Uniquement en sortie. Jeton d'authentification à transmettre à l'application mobile.

expire_time

Timestamp

Uniquement en sortie. Heure d'expiration du jeton d'authentification.

CreateTripRequest

Message de requête pour NavConnectService.CreateTrip.

Champs
parent

string

Obligatoire. Ressource parente sous laquelle ce trajet sera créé. Format : projects/{project_number}

trip_id

string

Obligatoire. ID à utiliser pour le trajet, qui constituera le composant final du nom de ressource du trajet.

Cette valeur doit être un UUID RFC-4122 valide.

trip

Trip

Obligatoire. Trajet à créer.

GetTripRequest

Message de requête pour NavConnectService.GetTrip.

Champs
name

string

Obligatoire. Nom de ressource du trajet à récupérer. Format : projects/{project}/trips/{trip_id}

Emplacement

Position indiquée par l'application mobile.

Champs
point

LatLng

Uniquement en sortie. Latitude et longitude de l'établissement.

source_time

Timestamp

Uniquement en sortie. Heure à laquelle la position a été obtenue, telle qu'indiquée par le client.

server_time

Timestamp

Uniquement en sortie. Heure à laquelle le serveur a reçu cette mise à jour de la position.

Arrêter

Arrêt du trajet où une tâche doit être effectuée.

Champs
point

LatLng

Obligatoire. Emplacement de l'arrêt sous forme de latitude/longitude.

Trajet

Un voyage.

Champs
name

string

Uniquement en sortie. Identifiant. Nom de ressource du trajet. Format : projects/{project_number}/trips/{trip_id}.

config

TripConfig

Immuable. Configuration du trajet.

android_app_id

string

Uniquement en entrée. Immuable. ID d'application Android de l'application mobile qui utilisera le trajet. Vous devez définir au moins l'un des champs android_app_id ou ios_app_id.

ios_app_id

string

Uniquement en entrée. Immuable. ID de bundle iOS de l'application mobile qui utilisera le trajet. Vous devez définir au moins l'un des champs android_app_id ou ios_app_id.

auth_token

AuthToken

Uniquement en sortie. Jeton opaque qui autorise l'accès pour commencer un trajet NavConnect dans Google Maps ou Waze, et qui accorde à ces applications l'accès pour mettre à jour le trajet. Renvoi uniquement par CreateTrip.

state

State

Uniquement en sortie. État du trajet.

execution

TripExecution

Uniquement en sortie. Dernières données sur l'exécution du trajet. Ce paramètre ne peut pas être défini si le trajet est en état d'erreur.

create_time

Timestamp

Uniquement en sortie. Heure à laquelle le trajet a été créé, selon le serveur.

update_time

Timestamp

Uniquement en sortie. Heure à laquelle le serveur a reçu la dernière mise à jour du trajet.

État

Tous les états de trajet possibles.

Enums
STATE_UNSPECIFIED L'état du trajet n'est pas spécifié.
NEW Le trajet a été créé, mais n'a pas encore commencé.
ENROUTE Le transporteur est en route vers la destination.
ARRIVED Le transporteur est arrivé à destination.
SUSPENDED Le trajet a été suspendu.
FAILED Le trajet n'a pas pu être effectué.
CLIENT_ERROR Le trajet a échoué en raison d'une erreur client.

TripConfig

Configuration du trajet.

Champs
enable_high_frequency_updates

bool

Facultatif. Indique si les mises à jour fréquentes des trajets doivent être activées.

REMARQUE : Si vous activez cette fonctionnalité, le trajet sera enregistré dans l'utilisation du niveau Enterprise et sera soumis aux tarifs de ce niveau.

enable_pubsub

bool

Facultatif. Indique si les notifications Pub/Sub doivent être activées pour le trajet.

pubsub_field_mask

FieldMask

Facultatif. Si cette valeur est définie, seul le sous-ensemble spécifié des champs "Trajet" sera inclus dans les notifications Pub/Sub.

Si ce champ n'est pas défini, tous les champs "Trip" seront inclus dans les notifications Pub/Sub (comportement par défaut).

Les champs suivants ne sont pas acceptés :

  • android_app_id
  • ios_app_id
  • auth_token
  • config

REMARQUE : Ce champ est ignoré si enable_pubsub est défini sur "false".

TripExecution

Données sur l'exécution du trajet.

Champs
origin

Location

Uniquement en sortie. Point de départ du trajet, qui correspond généralement à l'emplacement du transporteur au début du trajet NavConnect.

destination

Stop

Uniquement en sortie. Destination du trajet indiquée par l'application mobile.

location

Location

Uniquement en sortie. Signal de localisation représentant la dernière position connue du transporteur. Il s'agit de l'emplacement sur la route, si disponible.

traveled_duration

Duration

Uniquement en sortie. Temps de trajet écoulé jusqu'à présent.

remaining_duration

Duration

Uniquement en sortie. Temps restant pour ce trajet, tel qu'estimé par Google.

traveled_distance_meters

int32

Uniquement en sortie. Distance parcourue depuis l'origine en mètres.

remaining_distance_meters

int32

Uniquement en sortie. Distance restante jusqu'à la destination, en mètres.

stop_added_in_route

bool

Uniquement en sortie. Indique si un arrêt a été ajouté sur l'itinéraire.