REST Resource: providers.trips

Ressource: Trip

Métadonnées des trajets.

Représentation JSON 
{
  "name": string,
  "vehicleId": string,
  "tripStatus": enum (TripStatus),
  "tripType": enum (TripType),
  "pickupPoint": {
    object (TerminalLocation)
  },
  "actualPickupPoint": {
    object (StopLocation)
  },
  "actualPickupArrivalPoint": {
    object (StopLocation)
  },
  "pickupTime": string,
  "intermediateDestinations": [
    {
      object (TerminalLocation)
    }
  ],
  "intermediateDestinationsVersion": string,
  "intermediateDestinationIndex": integer,
  "actualIntermediateDestinationArrivalPoints": [
    {
      object (StopLocation)
    }
  ],
  "actualIntermediateDestinations": [
    {
      object (StopLocation)
    }
  ],
  "dropoffPoint": {
    object (TerminalLocation)
  },
  "actualDropoffPoint": {
    object (StopLocation)
  },
  "dropoffTime": string,
  "remainingWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "vehicleWaypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "route": [
    {
      object (LatLng)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentTraffic": {
    object (ConsumableTrafficPolyline)
  },
  "currentRouteSegmentTrafficVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeToFirstWaypoint": string,
  "remainingWaypointsVersion": string,
  "remainingWaypointsRouteVersion": string,
  "numberOfPassengers": integer,
  "lastLocation": {
    object (VehicleLocation)
  },
  "lastLocationSnappable": boolean,
  "view": enum (TripView)
}
Champs
name

string

Uniquement en sortie. Au format "providers/{provider}/trips/{trip}"
vehicleId

string

Identifiant du véhicule effectuant ce trajet.
tripStatus

enum (TripStatus)

État actuel du trajet.
tripType

enum (TripType)

Type de trajet.
pickupPoint

object (TerminalLocation)

Lieu où le client indique qu'il sera récupéré.
actualPickupPoint

object (StopLocation)

Uniquement en entrée. Lieu réel où et quand le client a été récupéré. Ce champ permet au fournisseur de fournir des commentaires sur les informations réelles de retrait.
actualPickupArrivalPoint

object (StopLocation)

Uniquement en entrée. Heure et lieu réels d'arrivée du chauffeur au point de prise en charge. Ce champ permet au fournisseur de fournir des commentaires sur les informations d'arrivée réelles au point retrait.
pickupTime

string (Timestamp format)

Uniquement en sortie. soit l'heure future estimée de prise en charge du ou des passagers, soit l'heure réelle à laquelle ils seront pris en charge.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
intermediateDestinations[]

object (TerminalLocation)

Arrêts intermédiaires pour que le trajet soit demandé (en plus des montées et des descentes). Dans un premier temps, cette fonctionnalité ne sera pas disponible pour les trajets partagés.
intermediateDestinationsVersion

string (Timestamp format)

Indique la dernière fois que le intermediateDestinations a été modifié. Votre serveur doit mettre en cache cette valeur et la transmettre dans UpdateTripRequest lors de la mise à jour de intermediateDestinationIndex pour s'assurer que intermediateDestinations n'est pas modifié.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
intermediateDestinationIndex

integer

Lorsque TripStatus est défini sur ENROUTE_TO_INTERMEDIATE_DESTINATION, il s'agit d'un nombre compris entre [0..N-1] et indiquant la destination intermédiaire que le véhicule traversera. Lorsque TripStatus est défini sur ARRIVED_AT_INTERMEDIATE_DESTINATION, il s'agit d'un nombre compris entre [0..N-1] et indiquant la destination intermédiaire où se trouve le véhicule. Le fournisseur définit cette valeur. Si aucun intermediateDestinations n'est défini, ce champ est ignoré.
actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Uniquement en entrée. Heure et lieu réels d'arrivée du chauffeur à une destination intermédiaire. Ce champ permet au fournisseur de fournir des commentaires sur les informations d'arrivée réelles aux destinations intermédiaires.
actualIntermediateDestinations[]

object (StopLocation)

Uniquement en entrée. L'heure et le lieu réels de prise en charge du client à une destination intermédiaire. Ce champ permet au fournisseur de fournir des commentaires sur les informations réelles de retrait aux destinations intermédiaires.
dropoffPoint

object (TerminalLocation)

Lieu où le client indique qu'il sera déposé.
actualDropoffPoint

object (StopLocation)

Uniquement en entrée. Heure et lieu réels de départ et d'arrivée du client. Ce champ permet au fournisseur de fournir des commentaires sur les informations réelles de dépôt.
dropoffTime

string (Timestamp format)

Uniquement en sortie. soit l'heure future estimée de dépose des usagers à la destination finale, soit l'heure réelle à laquelle ils seront déposés.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
remainingWaypoints[]

object (TripWaypoint)

Uniquement en sortie. Chemin complet depuis la position actuelle jusqu'au point de dépôt (inclus). Ce trajet peut inclure des points de cheminement d'autres trajets.
vehicleWaypoints[]

object (TripWaypoint)

Ce champ permet d'organiser manuellement les points de cheminement du trajet. Il contient tous les points de cheminement restants du véhicule attribué, ainsi que les points de cheminement de prise en charge et de dépose pour ce trajet. Si le trajet n'a pas été attribué à un véhicule, Fleet Engine ignore ce champ. Pour des raisons de confidentialité, ce champ n'est renseigné par le serveur que lors des appels trips.update et trips.create, et non lors des appels trips.get.
route[]

object (LatLng)

Uniquement en sortie. Itinéraire prévu pour ce trajet vers la première entrée dans les lieux restants. Notez que le premier point de cheminement peut appartenir à un autre trajet.
currentRouteSegment

string

Uniquement en sortie. Trajet encodé vers le point de cheminement suivant.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public. Le décodage n'est pas encore pris en charge.
currentRouteSegmentVersion

string (Timestamp format)

Uniquement en sortie. Indique la dernière fois que l'itinéraire a été modifié.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentTraffic

object (ConsumableTrafficPolyline)

Uniquement en sortie. Indique les conditions de circulation le long du currentRouteSegment lorsqu'elles sont disponibles.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public.
currentRouteSegmentTrafficVersion

string (Timestamp format)

Uniquement en sortie. Indique la dernière fois que le currentRouteSegmentTraffic a été modifié.

Remarque: Ce champ est destiné à être utilisé uniquement par le SDK Driver et le SDK grand public.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

Uniquement en sortie. Point de cheminement où currentRouteSegment se termine.
remainingDistanceMeters

integer

Uniquement en sortie. Distance restante en voiture dans le champ currentRouteSegment. La valeur n'est pas spécifiée si le trajet n'est pas attribué à un véhicule, ou s'il est terminé ou annulé.
etaToFirstWaypoint

string (Timestamp format)

Uniquement en sortie. L'heure d'arrivée prévue du point de cheminement suivant (la première entrée dans le champ remainingWaypoints). La valeur n'est pas spécifiée si le trajet n'est pas attribué à un véhicule ou s'il est inactif (terminé ou annulé).

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
remainingTimeToFirstWaypoint

string (Duration format)

Uniquement en sortie. Durée entre le renvoi des données sur le trajet et l'heure dans Trip.eta_to_first_waypoint. La valeur n'est pas spécifiée si le trajet n'est pas attribué à un véhicule ou s'il est inactif (terminé ou annulé).

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

string (Timestamp format)

Uniquement en sortie. Indique la dernière fois que remainingWaypoints a été modifié (un point de cheminement a été ajouté, supprimé ou modifié).

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
remainingWaypointsRouteVersion

string (Timestamp format)

Uniquement en sortie. Indique la dernière fois que remainingWaypoints.path_to_waypoint et remainingWaypoints.traffic_to_waypoint ont été modifiés. Votre application cliente doit mettre en cache cette valeur et la transmettre dans GetTripRequest pour s'assurer que les chemins d'accès et le trafic de remainingWaypoints ne sont renvoyés que s'ils sont mis à jour.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
numberOfPassengers

integer

Immuable. Indique le nombre de passagers pour ce trajet (le conducteur n'est pas inclus). Un véhicule doit avoir de la capacité disponible pour être renvoyé dans une réponse vehicles.search.
lastLocation

object (VehicleLocation)

Uniquement en sortie. Indique la dernière position signalée du véhicule sur l'itinéraire.
lastLocationSnappable

boolean

Uniquement en sortie. Indique si l'élément lastLocation du véhicule peut être ancré à l'élément currentRouteSegment. "False" si lastLocation ou currentRouteSegment n'existe pas. Il est calculé par Fleet Engine. Toute mise à jour des clients sera ignorée.
view

enum (TripView)

Sous-ensemble des champs "Trajet" renseignés et comment ils doivent être interprétés.

TripStatus

État d'un trajet indiquant sa progression.

Enums
UNKNOWN_TRIP_STATUS Valeur par défaut, utilisée pour l'état du trajet non spécifié ou non reconnu.
NEW Trajet créé.
ENROUTE_TO_PICKUP Le chauffeur se dirige vers le lieu de prise en charge.
ARRIVED_AT_PICKUP Le chauffeur est arrivé au point de prise en charge.
ARRIVED_AT_INTERMEDIATE_DESTINATION Le chauffeur est arrivé à une destination intermédiaire et attend le passager.
ENROUTE_TO_INTERMEDIATE_DESTINATION le chauffeur se dirige vers une destination intermédiaire (et non le point de dépôt).
ENROUTE_TO_DROPOFF Le chauffeur a pris le passager et se dirige vers la prochaine destination.
COMPLETE le passager a été déposé et le trajet est terminé ;
CANCELED Le trajet a été annulé avant la prise en charge par le conducteur, le passager ou le fournisseur de covoiturage.

StopLocation

Lieu réel où l'arrêt (prise en charge/dépôt) s'est produit.

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

object (LatLng)

Obligatoire. Indique la position réelle.
timestamp

string (Timestamp format)

Indique à quel moment l'arrêt s'est produit.

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
stopTime
(deprecated)

string (Timestamp format)

Uniquement en entrée. Obsolète. Utilisez le champ "Timestamp".

Code temporel au format RFC3339 UTC "Zulu", avec une résolution à la nanoseconde et jusqu'à neuf chiffres fractionnaires. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

TripView

Sélecteur pour différents ensembles de champs "Trip" (Trajet) dans une réponse trips.get. Consultez AIP-157 pour plus de contexte. D'autres vues sont susceptibles d'être ajoutées.

Enums
TRIP_VIEW_UNSPECIFIED Valeur par défaut. Pour assurer la rétrocompatibilité, l'API utilise par défaut une vue du SDK. Pour des raisons de stabilité et de compatibilité, nous recommandons aux clients de sélectionner une TripView autre que SDK.
SDK Inclut des champs qui peuvent ne pas être interprétables ou pris en charge par les bibliothèques accessibles au public.
JOURNEY_SHARING_V1S Les champs du trajet sont renseignés pour le cas d'utilisation du partage de trajet. Cette vue est destinée aux communications de serveur à serveur.

Méthodes

create

 Crée un trajet dans Fleet Engine et l'affiche.

get

 Obtenez des informations sur un seul trajet.
Obtenez tous les trajets pour un véhicule spécifique.

update

 Met à jour les données sur les trajets.