REST Resource: projects.trips

Ressource : Trip

Un voyage.

Représentation JSON 
{
  "name": string,
  "config": {
    object (TripConfig)
  },
  "androidAppId": string,
  "iosAppId": string,
  "authToken": {
    object (AuthToken)
  },
  "state": enum (State),
  "execution": {
    object (TripExecution)
  },
  "createTime": string,
  "updateTime": string
}
Champs
name

string

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

object (TripConfig)

Immuable. Configuration du trajet.
androidAppId

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 androidAppId ou iosAppId.
iosAppId

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 androidAppId ou iosAppId.
authToken

object (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 trips.create.
state

enum (State)

Uniquement en sortie. État du trajet.
execution

object (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.
createTime

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

TripConfig

Configuration du trajet.

Représentation JSON 
{
  "enableHighFrequencyUpdates": boolean,
  "enablePubsub": boolean,
  "pubsubFieldMask": string
}
Champs
enableHighFrequencyUpdates

boolean

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

boolean

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

string (FieldMask format)

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 :

  • androidAppId
  • iosAppId
  • authToken
  • config

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

Il s'agit d'une liste de noms de champs complets séparés par une virgule. Exemple : "user.displayName,photo".

AuthToken

Jeton d'authentification.

Représentation JSON 
{
  "token": string,
  "expireTime": string
}
Champs
token

string

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

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

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

TripExecution

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

Représentation JSON 
{
  "origin": {
    object (Location)
  },
  "destination": {
    object (Stop)
  },
  "location": {
    object (Location)
  },
  "traveledDuration": string,
  "remainingDuration": string,
  "traveledDistanceMeters": integer,
  "remainingDistanceMeters": integer,
  "stopAddedInRoute": boolean
}
Champs
origin

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

object (Stop)

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

object (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.
traveledDuration

string (Duration format)

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

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
remainingDuration

string (Duration format)

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

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"
traveledDistanceMeters

integer

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

integer

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

boolean

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

Emplacement

Position indiquée par l'application mobile.

Représentation JSON 
{
  "point": {
    object (LatLng)
  },
  "sourceTime": string,
  "serverTime": string
}
Champs
point

object (LatLng)

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

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
serverTime

string (Timestamp format)

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

Utilise la norme RFC 3339, où la sortie générée utilise toujours le format UTC (indiqué par "Z" pour le temps universel coordonné) avec des secondes fractionnaires de 0, 3, 6 ou 9 chiffres décimaux. Des décalages horaires autres que "Z" (UTC) sont également acceptés. Exemples : "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".

LatLng

Objet représentant une paire latitude/longitude. Cette valeur est exprimée par une paire de doubles représentant les degrés de latitude et de longitude. Sauf indication contraire, cet objet doit être conforme à la norme WGS84. Les valeurs doivent se situer dans les limites normalisées.

Représentation JSON 
{
  "latitude": number,
  "longitude": number
}
Champs
latitude

number

Latitude en degrés. Elle doit être comprise dans la plage [-90.0, +90.0].
longitude

number

Longitude en degrés. Elle doit être comprise dans la plage [-180.0, +180.0].

Arrêter

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

Représentation JSON 
{
  "point": {
    object (LatLng)
  }
}
Champs
point

object (LatLng)

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

Méthodes

create

 Crée un trajet.

get

 Récupère un trajet.