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

Nécessite l'autorisation IAM suivante sur la ressource parent :

  • navigationconnect.trips.create

Pour en savoir plus, consultez la documentation IAM.

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

Nécessite l'autorisation IAM suivante sur la ressource name :

  • navigationconnect.trips.get

Pour en savoir plus, consultez la documentation IAM.

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}

route_polyline_format

RoutePolylineFormat

Facultatif. Format de la polyligne de l'itinéraire à renvoyer. Si elle n'est pas définie, la polyligne de l'itinéraire SIMPLE est renvoyée.

RoutePolylineFormat

Spécifie le format de la polyligne de l'itinéraire.

Enums
ROUTE_POLYLINE_FORMAT_UNSPECIFIED Le format de la polyligne de l'itinéraire n'est pas spécifié.
SIMPLE La polyligne de l'itinéraire est renvoyée sous la forme d'un simple tableau de points représentés par google.type.LatLng.
ENCODED La polyligne de l'itinéraire est renvoyée sous forme de chaîne encodée. Consultez https://developers.google.com/maps/documentation/utilities/polylinealgorithm.
S2ENCODED La polyligne de l'itinéraire est encodée en tant que S2Polyline. Consultez https://s2geometry.io/devguide/basic_types.html.
GEO_JSON La polyligne de l'itinéraire est renvoyée sous forme de LineString GeoJSON. Consultez la page https://tools.ietf.org/html/rfc7946#section-3.1.4.

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.

Itinéraire

Polyligne d'un itinéraire.

Champs
traffic_information[]

SpeedReadingInterval

Uniquement en sortie. Informations sur le trafic sur la polyligne décrites sous forme d'intervalles de lecture de la vitesse.

NOTES :

  • Les intervalles ne se chevauchent pas.
  • Les intervalles sont contigus.
  • Les intervalles couvrent l'intégralité de la polyligne.
  • Les intervalles sont triés par ordre croissant de l'index.
  • La vitesse est spécifiée pour chaque intervalle.

Champ d'union format. Format de l'itinéraire.

Le format renseigné est contrôlé par le paramètre route_polyline_format. Si elle n'est pas définie, elle est définie par défaut sur une polyligne simple. format ne peut être qu'un des éléments suivants :

simple_polyline

SimplePolyline

Uniquement en sortie. Itinéraire sous forme de liste simple de coordonnées latlng.

encoded_polyline

string

Uniquement en sortie. Itinéraire sous forme de polyligne encodée. Consultez https://developers.google.com/maps/documentation/utilities/polylinealgorithm.

s2_polyline

bytes

Uniquement en sortie. Itinéraire sous forme de S2Polyline encodée. Consultez https://s2geometry.io/devguide/basic_types.html.

geo_json

Struct

Uniquement en sortie. Itinéraire sous forme de LineString GeoJSON. Consultez la page https://tools.ietf.org/html/rfc7946#section-3.1.4.

SimplePolyline

Représente une polyligne à l'aide d'une simple liste de points.

Champs
points[]

LatLng

Uniquement en sortie. Liste ordonnée de points représentant la polyligne.

SpeedReadingInterval

Indicateur de densité du trafic sur un segment contigu d'un chemin. Étant donné un chemin avec des points P_0, P_1, ... , P_N (index basé sur zéro), SpeedReadingInterval définit un intervalle et décrit son trafic à l'aide des catégories Speed.

Champs
speed

Speed

Uniquement en sortie. Vitesse du trafic dans cet intervalle.

start_polyline_point_index

int32

Uniquement en sortie. Index de début de cet intervalle dans le chemin d'accès.

end_polyline_point_index

int32

Uniquement en sortie. Index de fin de cet intervalle dans le chemin.

Vitesse

Classification de la vitesse des polylignes en fonction des données sur le trafic.

Enums
SPEED_UNSPECIFIED La vitesse n'est pas spécifiée.
NORMAL Vitesse normale, pas de ralentissement.
SLOW Ralentissement détecté, trafic faible à moyen.
TRAFFIC_JAM les ralentissements de trafic, y compris le trafic à l'arrêt ;

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 du 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. Retourné 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. Cette valeur ne peut pas être définie 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.
CANCELED Le trajet a été explicitement annulé par le développeur.

TripConfig

Configuration du trajet.

Champs
enable_high_frequency_updates

bool

Facultatif. Indique si les mises à jour de trajet à haute fréquence doivent être activées.

REMARQUE : Si vous activez cette fonctionnalité, le trajet est enregistré dans l'utilisation du niveau Enterprise et est 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".

enable_remaining_route_reporting

bool

Facultatif. Indique si les rapports sur les itinéraires restants doivent être activés pour le trajet.

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

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.

remaining_route

Route

Uniquement en sortie. Fournit la polyligne pour la partie restante de l'itinéraire.

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é à l'itinéraire.