REST Resource: providers.trips

Ressource : Trip

Métadonnées du trajet

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 viendra récupérer la commande.
actualPickupPoint

object (StopLocation)

Uniquement en entrée. Emplacement exact et heure de prise en charge du client Ce champ permet au fournisseur de fournir des commentaires sur les informations de retrait réelles.
actualPickupArrivalPoint

object (StopLocation)

Uniquement en entrée. Heure et lieu exacts de l'arrivée du chauffeur au point de prise en charge. Ce champ permet au fournisseur de fournir des informations sur l'heure d'arrivée réelle au point de ramassage.
pickupTime

string (Timestamp format)

Uniquement en sortie. Heure estimée à laquelle le ou les passagers seront pris en charge ou heure réelle à laquelle ils ont été pris en charge.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
intermediateDestinations[]

object (TerminalLocation)

Arrêts intermédiaires dans l'ordre indiqué dans la demande de trajet (en plus des points de départ et d'arrivée). Dans un premier temps, cette option 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é.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
intermediateDestinationIndex

integer

Lorsque TripStatus est ENROUTE_TO_INTERMEDIATE_DESTINATION, nombre compris entre [0..N-1] indiquant la destination intermédiaire que le véhicule traversera ensuite. Lorsque TripStatus est défini sur ARRIVED_AT_INTERMEDIATE_DESTINATION, un nombre compris entre [0..N-1] indiquant la destination intermédiaire à laquelle se trouve le véhicule. Cette valeur est définie par le fournisseur. Si aucun intermediateDestinations n'est défini, ce champ est ignoré.
actualIntermediateDestinationArrivalPoints[]

object (StopLocation)

Uniquement en entrée. Heure et lieu réels de l'arrivée du conducteur à 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, ainsi que le lieu de prise en charge Ce champ permet au fournisseur de fournir des commentaires sur les informations de retrait réelles aux destinations intermédiaires.
dropoffPoint

object (TerminalLocation)

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

object (StopLocation)

Uniquement en entrée. L'heure et le lieu réels du moment et du lieu où le client a été déposé Ce champ permet au fournisseur de fournir des commentaires sur les informations de dépôt réelles.
dropoffTime

string (Timestamp format)

Uniquement en sortie. Il peut s'agir de l'heure à laquelle les usagers seront déposés à la destination finale ou de l'heure réelle à laquelle ils seront déposés.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
remainingWaypoints[]

object (TripWaypoint)

Uniquement en sortie. Chemin complet (inclus) entre la position actuelle et le point de dépôt. Ce chemin peut inclure des points de cheminement d'autres trajets.
vehicleWaypoints[]

object (TripWaypoint)

Ce champ permet de définir manuellement l'ordre des points de cheminement pour le trajet. Il contient tous les points de repère restants pour le véhicule attribué, ainsi que les points de prise en charge et de dépose de 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é que par le serveur pour les appels trips.update et trips.create, et NON pour les appels trips.get.
route[]

object (LatLng)

Uniquement en sortie. Itinéraire prévu pour ce trajet jusqu'à la première entrée de remainingWaypoints. Notez que le premier point de cheminement peut appartenir à un autre trajet.
currentRouteSegment

string

Uniquement en sortie. Chemin d'accès au prochain point de repère encodé.

Remarque : Ce champ n'est destiné qu'à être utilisé par le SDK Driver et le SDK Consumer. Le décodage n'est pas encore disponible.
currentRouteSegmentVersion

string (Timestamp format)

Uniquement en sortie. Indique la date de la dernière modification de l'itinéraire.

Remarque : Ce champ n'est destiné qu'à être utilisé par le SDK Driver et le SDK Consumer.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. 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, le cas échéant.

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

string (Timestamp format)

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

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

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
currentRouteSegmentEndPoint

object (TripWaypoint)

Uniquement en sortie. Point d'intérêt où currentRouteSegment se termine.
remainingDistanceMeters

integer

Uniquement en sortie. Distance restante à parcourir 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. Heure d'arrivée prévue au point de cheminement suivant (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é).

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
remainingTimeToFirstWaypoint

string (Duration format)

Uniquement en sortie. Durée entre le retour des données de 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é).

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. 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 les 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.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".
numberOfPassengers

integer

Immuable. Indique le nombre de passagers de ce trajet, sans inclure le conducteur. 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 le lastLocation du véhicule peut être ancré au currentRouteSegment. "False" si lastLocation ou currentRouteSegment n'existe pas. Il est calculé par Fleet Engine. Toute mise à jour effectuée par les clients sera ignorée.
view

enum (TripView)

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

TripStatus

État d'un trajet indiquant sa progression.

Enums
UNKNOWN_TRIP_STATUS Par défaut, utilisé pour l'état de trajet non spécifié ou non reconnu.
NEW Nouveau voyage.
ENROUTE_TO_PICKUP Le chauffeur est en route vers le point 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 conducteur se dirige vers une destination intermédiaire (et non vers le point de dépose).
ENROUTE_TO_DROPOFF Le conducteur a pris en charge 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

Emplacement exact où un arrêt (reprise/dépose) s'est produit.

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

object (LatLng)

Obligatoire. Indique l'emplacement réel.
timestamp

string (Timestamp format)

Indique quand l'arrêt s'est produit.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. 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 d'horodatage.

Horodatage au format RFC3339 UTC "Zulu", avec une résolution de l'ordre de la nanoseconde et jusqu'à neuf chiffres décimaux. Exemples : "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

TripView

Sélecteur pour différents ensembles de champs "Trip" dans une réponse trips.get. Pour en savoir plus, consultez AIP-157. 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 assurer la stabilité et l'assistance, nous recommandons aux clients de sélectionner un TripView autre que SDK.
SDK Inclut des champs qui ne peuvent pas être interprétés ni gérés à l'aide de bibliothèques accessibles au public.
JOURNEY_SHARING_V1S Les champs de 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 le moteur de parc et renvoie le nouveau trajet.

get

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

update

 Met à jour les données du trajet.