REST Resource: providers.vehicles

Ressource: Vehicle

Métadonnées du véhicule.

Représentation JSON 
{
  "name": string,
  "vehicleState": enum (VehicleState),
  "supportedTripTypes": [
    enum (TripType)
  ],
  "currentTrips": [
    string
  ],
  "lastLocation": {
    object (VehicleLocation)
  },
  "maximumCapacity": integer,
  "attributes": [
    {
      object (VehicleAttribute)
    }
  ],
  "vehicleType": {
    object (VehicleType)
  },
  "licensePlate": {
    object (LicensePlate)
  },
  "route": [
    {
      object (TerminalLocation)
    }
  ],
  "currentRouteSegment": string,
  "currentRouteSegmentTraffic": {
    object (TrafficPolylineData)
  },
  "currentRouteSegmentVersion": string,
  "currentRouteSegmentEndPoint": {
    object (TripWaypoint)
  },
  "remainingDistanceMeters": integer,
  "etaToFirstWaypoint": string,
  "remainingTimeSeconds": integer,
  "waypoints": [
    {
      object (TripWaypoint)
    }
  ],
  "waypointsVersion": string,
  "backToBackEnabled": boolean,
  "navigationStatus": enum (NavigationStatus),
  "deviceSettings": {
    object (DeviceSettings)
  }
}
Champs
name

string

Uniquement en sortie. Nom unique du véhicule. Il a le format suivant : providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

État du véhicule.
supportedTripTypes[]

enum (TripType)

Types de trajets acceptés par ce véhicule.
currentTrips[]

string

Uniquement en sortie. Liste des tripId pour les trajets actuellement attribués à ce véhicule.
lastLocation

object (VehicleLocation)

Dernière position signalée du véhicule.
maximumCapacity

integer

Nombre total d'usagers pouvant être transportés par ce véhicule. Le pilote n'est pas pris en compte dans cette valeur. Cette valeur doit être supérieure ou égale à 1.
attributes[]

object (VehicleAttribute)

Liste des attributs du véhicule. Un véhicule peut avoir 100 attributs au maximum, et chaque attribut doit avoir une clé unique.
vehicleType

object (VehicleType)

Obligatoire. Type de ce véhicule. Peut être utilisé pour filtrer les véhicules dans les résultats vehicles.search. Cette fonctionnalité a également une incidence sur le calcul de l'heure d'arrivée prévue et de l'itinéraire.
licensePlate

object (LicensePlate)

Informations relatives à la plaque d'immatriculation du véhicule
route[]
(deprecated)

object (TerminalLocation)

Obsolète: utilisez plutôt Vehicle.waypoints.
currentRouteSegment

string

Polyligne spécifiant l'itinéraire que l'application du conducteur prévoit d'emprunter pour atteindre le point de cheminement suivant. Cette liste est également renvoyée dans Trip.current_route_segment pour tous les trajets actifs attribués au véhicule.

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

object (TrafficPolylineData)

Uniquement en entrée. Fleet Engine utilise ces informations pour améliorer le partage de parcours. Remarque: Ce champ est destiné uniquement à être utilisé par le SDK Driver.
currentRouteSegmentVersion

string (Timestamp format)

Uniquement en sortie. Heure à laquelle currentRouteSegment a été défini. Il peut être stocké par le client et transmis dans les futures requêtes vehicles.get pour éviter les routes renvoyées qui n'ont pas changé.

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)

Point de cheminement où se termine currentRouteSegment. Ces informations peuvent être fournies par les conducteurs lors d'appels vehicles.update, soit en tant que point de cheminement complet pour le trajet, en tant que point de cheminement LatLng, soit en tant que dernier LatLng du currentRouteSegment. Fleet Engine fera alors de son mieux pour interpoler un point de cheminement réel si celui-ci n'est pas entièrement spécifié. Ce champ est ignoré dans les appels vehicles.update, sauf si currentRouteSegment est également spécifié.
remainingDistanceMeters

integer

Distance en voiture restante pour le currentRouteSegment. Cette valeur est également renvoyée dans Trip.remaining_distance_meters pour tous les trajets actifs attribués au véhicule. La valeur n'est pas spécifiée si le champ currentRouteSegment est vide.
etaToFirstWaypoint

string (Timestamp format)

Heure d'arrivée prévue à la première entrée du champ waypoints. La valeur n'est pas spécifiée si le champ waypoints ou Vehicle.current_route_segment est vide.

Lors de la mise à jour d'un véhicule, remainingTimeSeconds est prioritaire sur etaToFirstWaypoint dans la même requête.

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".
remainingTimeSeconds

integer

Uniquement en entrée. Temps de trajet restant pour le currentRouteSegment. La valeur n'est pas spécifiée si le champ waypoints ou Vehicle.current_route_segment est vide. Cette valeur doit correspondre à etaToFirstWaypoint - current_time si toutes les parties utilisent la même horloge.

Lors de la mise à jour d'un véhicule, remainingTimeSeconds est prioritaire sur etaToFirstWaypoint dans la même requête.
waypoints[]

object (TripWaypoint)

Points de cheminement restants attribués à ce véhicule.
waypointsVersion

string (Timestamp format)

Uniquement en sortie. Heure de la dernière mise à jour du champ waypoints. Les clients doivent mettre en cache cette valeur et la transmettre dans GetVehicleRequest pour s'assurer que le champ waypoints n'est renvoyé que s'il est 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".
backToBackEnabled

boolean

Indique si le conducteur accepte des trajets intervenus. Si la valeur est true, vehicles.search peut inclure le véhicule même s'il est actuellement associé à un trajet. La valeur par défaut est false.
navigationStatus

enum (NavigationStatus)

État de navigation du véhicule.
deviceSettings

object (DeviceSettings)

Uniquement en entrée. Informations sur les paramètres de l'appareil mobile utilisé par le pilote.

VehicleState

État d'un Vehicle.

Enums
UNKNOWN_VEHICLE_STATE Par défaut, utilisé pour les états du véhicule non spécifiés ou non reconnus.
OFFLINE Le véhicule n'accepte pas de nouveaux trajets. Remarque: Le véhicule peut continuer à fonctionner dans cet état pendant qu'il effectue un trajet qui lui est attribué.
ONLINE Le véhicule accepte de nouveaux trajets.

VehicleAttribute

Décrit un attribut de véhicule en tant que paire clé-valeur. La valeur "key:value" La chaîne ne doit pas dépasser 256 caractères.

Représentation JSON 
{
  "key": string,
  "value": string,

  // Union field vehicle_attribute_value can be only one of the following:
  "stringValue": string,
  "boolValue": boolean,
  "numberValue": number
  // End of list of possible types for union field vehicle_attribute_value.
}
Champs
key

string

Clé de l'attribut. Les clés ne doivent pas contenir le caractère deux-points (:).
value

string

Valeur de l'attribut.
Champ d'union vehicle_attribute_value. Valeur de l'attribut. Elle peut être de type "string", "bool" ou "double". vehicle_attribute_value ne peut être qu'un des éléments suivants :
stringValue

string

Valeur d'attribut de type chaîne.

Remarque: Ce champ est identique au champ value, qui sera à terme abandonné. Pour les méthodes de création ou de mise à jour, vous pouvez utiliser l'un ou l'autre des champs, mais nous vous recommandons vivement d'utiliser stringValue. Si stringValue et value sont tous deux définis, ils doivent être identiques, sinon une erreur sera générée. Les deux champs sont renseignés dans les réponses.
boolValue

boolean

Valeur d'attribut de type booléen.
numberValue

number

Valeur d'attribut saisie en double.

VehicleType

Type de véhicule.

Représentation JSON 
{
  "category": enum (Category)
}
Champs
category

enum (Category)

Catégorie de type de véhicule

Catégorie

Catégories de types de véhicules

Enums
UNKNOWN Par défaut, utilisé pour les catégories de véhicules non spécifiées ou non reconnues.
AUTO Une voiture.
TAXI Véhicule agissant en tant que taxi (généralement agréé ou réglementé).
TRUCK Généralement, un véhicule avec une grande capacité de stockage.
TWO_WHEELER Une moto, une cyclomoteur ou un autre véhicule à deux roues
BICYCLE Transport à énergie humaine
PEDESTRIAN Transporteur humain, généralement marchant ou courant, empruntant des voies piétonnes.

LicensePlate

Informations relatives à la plaque d'immatriculation du véhicule. Pour éviter de stocker des informations permettant d'identifier personnellement l'utilisateur, seules les informations minimales concernant la plaque d'immatriculation sont stockées en tant qu'entité.

Représentation JSON 
{
  "countryCode": string,
  "lastCharacter": string
}
Champs
countryCode

string

Obligatoire. Code pays/région CLDR. Par exemple, US pour les États-Unis ou IN pour l'Inde.
lastCharacter

string

Dernier chiffre de la plaque d'immatriculation ou "-1" pour indiquer qu'aucune valeur numérique n'est présente sur la plaque d'immatriculation.

  • "ABC 1234" -> "4"
  • "AB 123 CD" -> "3"
  • « ABCDEF » -> "-1"

TrafficPolylineData

Conditions de circulation sur l'itinéraire prévu pour le véhicule.

Représentation JSON 
{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}
Champs
trafficRendering

object (VisualTrafficReportPolylineRendering)

Rendu polyligne de la vitesse du trafic dans toutes les régions le long d'une portion de route d'un client.

VisualTrafficReportPolylineRendering

Décrit la manière dont les clients doivent colorer une partie de la polyligne le long de l'itinéraire.

Représentation JSON 
{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}
Champs
roadStretch[]

object (RoadStretch)

Facultatif. Sections de route devant être affichées le long de la polyligne. Les tronçons ne se chevauchent pas nécessairement et ne couvrent pas nécessairement l'intégralité de l'itinéraire.

En l'absence de tronçon de route à appliquer au style, le client doit appliquer la valeur par défaut de l'itinéraire.

RoadStretch

Un tronçon de route à tracer.

Représentation JSON 
{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}
Champs
style

enum (Style)

Obligatoire. Style à appliquer.
offsetMeters

integer

Obligatoire. Le style doit être appliqué entre [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Obligatoire. Longueur du tracé où appliquer le style.

Style

Style de trafic indiquant la vitesse du trafic.

Enums
STYLE_UNSPECIFIED Aucun style sélectionné.
SLOWER_TRAFFIC Le trafic ralentit.
TRAFFIC_JAM Il y a un embouteillage.

DeviceSettings

Informations sur les différents paramètres de l'appareil mobile.

Représentation JSON 
{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}
Champs
locationPowerSaveMode

enum (LocationPowerSaveMode)

Fonctionnement des fonctionnalités de localisation sur l'appareil lorsque l'économiseur de batterie est activé.
isPowerSaveMode

boolean

Indique si l'appareil est actuellement en mode Économie d'énergie.
isInteractive

boolean

Indique si l'appareil est en mode interactif.
batteryInfo

object (BatteryInfo)

Informations sur l'état de la batterie.

LocationPowerSaveMode

Comment les fonctionnalités de localisation sont configurées pour se comporter sur l'appareil mobile lorsque l'économiseur de batterie est activé sur celui-ci est activée. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE LocationPowerSaveMode non définie
LOCATION_MODE_NO_CHANGE L'économiseur de batterie n'a normalement pas d'incidence sur les fournisseurs de services de localisation, ou l'économiseur de batterie est désactivé.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Le fournisseur de géolocalisation basé sur le GPS doit être désactivé lorsque l'économiseur de batterie est activé et que l'appareil n'est pas interactif.
LOCATION_MODE_ALL_DISABLED_WHEN_SCREEN_OFF Tous les fournisseurs de services de localisation doivent être désactivés lorsque l'économiseur de batterie est activé et que l'appareil n'est pas interactif.
LOCATION_MODE_FOREGROUND_ONLY Tous les fournisseurs de services de localisation resteront disponibles, mais les correctifs de localisation ne doivent être fournis qu'aux applications de premier plan.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF La localisation ne sera pas désactivée, mais LocationManager limitera toutes les requêtes envoyées aux fournisseurs lorsque l'appareil est non interactif.

BatteryInfo

Informations sur la batterie de l'appareil.

Représentation JSON 
{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}
Champs
batteryStatus

enum (BatteryStatus)

État de la batterie : pleine, charge, etc.
powerSource

enum (PowerSource)

État de la source d'alimentation de la batterie.
batteryPercentage

number

Pourcentage actuel de la batterie [0-100].

BatteryStatus

État de la batterie : pleine, charge, etc.

Enums
UNKNOWN_BATTERY_STATUS État de la batterie inconnu.
BATTERY_STATUS_CHARGING La batterie est en cours de charge.
BATTERY_STATUS_DISCHARGING La batterie est en cours de décharge.
BATTERY_STATUS_FULL La batterie est pleine.
BATTERY_STATUS_NOT_CHARGING La batterie ne se charge pas.
BATTERY_STATUS_POWER_LOW La batterie est faible.

PowerSource

Type de chargeur utilisé pour charger la batterie.

Enums
UNKNOWN_POWER_SOURCE Source d'alimentation inconnue.
POWER_SOURCE_AC La source d'alimentation est un chargeur secteur.
POWER_SOURCE_USB La source d'alimentation est un port USB.
POWER_SOURCE_WIRELESS La source d'alimentation est sans fil.
POWER_SOURCE_UNPLUGGED La batterie est débranchée.

Méthodes

create

 Instancie un nouveau véhicule associé à un fournisseur de services de covoiturage ou de livraisons à la demande.

get

 Renvoie un véhicule à partir de Fleet Engine.

list

 Renvoie une liste paginée des véhicules associés à un fournisseur qui correspondent aux options de requête.
Renvoie une liste de véhicules correspondant aux options de la requête.

update

 Écrit les données mises à jour du véhicule dans Fleet Engine.

updateAttributes

 Met à jour partiellement les attributs d'un véhicule.