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 de ce véhicule. Il a le format suivant : providers/{provider}/vehicles/{vehicle}.
vehicleState

enum (VehicleState)

État du véhicule.
supportedTripTypes[]

enum (TripType)

Types de trajets compatibles avec 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 de passagers que ce véhicule peut transporter. Le conducteur n'est pas pris en compte dans cette valeur. Cette valeur doit être supérieure ou égale à un.
attributes[]

object (VehicleAttribute)

Liste des attributs du véhicule. Un véhicule peut comporter au maximum 100 attributs, 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. Elle a également une incidence sur l'heure d'arrivée prévue et les calculs d'itinéraire.
licensePlate

object (LicensePlate)

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

object (TerminalLocation)

Obsolète: utilisez Vehicle.waypoints à la place.
currentRouteSegment

string

Polyligne spécifiant le trajet que l'application du conducteur prévoit d'emprunter jusqu'au prochain point de repère. Cette liste est également renvoyée dans Trip.current_route_segment pour tous les trajets actifs attribués au véhicule.

Remarque: Ce champ n'est destiné qu'à être utilisé par le SDK du pilote. Le décodage n'est pas encore disponible.
currentRouteSegmentTraffic

object (TrafficPolylineData)

Uniquement en entrée. Fleet Engine utilise ces informations pour améliorer le partage de trajets. Remarque: Ce champ n'est destiné qu'à être utilisé par le SDK du pilote.
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 de renvoyer des itinéraires qui n'ont pas changé.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
currentRouteSegmentEndPoint

object (TripWaypoint)

Point de repère où currentRouteSegment se termine. Les conducteurs peuvent fournir cette information dans les appels vehicles.update sous la forme d'un point de cheminement de trajet complet, d'un point de cheminement LatLng ou du dernier LatLng de la currentRouteSegment. Fleet Engine fera ensuite de son mieux pour interpoler un point de cheminement réel s'il 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 restante à parcourir en voiture pour l'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 estimée à la première entrée du champ waypoints. La valeur n'est pas spécifiée si le champ waypoints est vide ou si le champ Vehicle.current_route_segment est vide.

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

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
remainingTimeSeconds

integer

Uniquement en entrée. Temps de trajet restant pour l'currentRouteSegment. La valeur n'est pas spécifiée si le champ waypoints est vide ou si le champ 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 a la priorité sur etaToFirstWaypoint dans la même requête.
waypoints[]

object (TripWaypoint)

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

string (Timestamp format)

Uniquement en sortie. Date 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.

Utilise la norme RFC 3339, où la sortie générée est toujours normalisée avec le suffixe Z et utilise 0, 3, 6 ou 9 chiffres décimaux. Les décalages autres que "Z" sont également acceptés. Exemples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" ou "2014-10-02T15:01:23+05:30".
backToBackEnabled

boolean

Indique si le conducteur accepte les trajets consécutifs. Si la valeur est true, vehicles.search peut inclure le véhicule même s'il est actuellement attribué à 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 conducteur.

VehicleState

État d'un Vehicle.

Enums
UNKNOWN_VEHICLE_STATE Valeur par défaut, utilisée pour les états de véhicule non spécifiés ou non reconnus.
OFFLINE Le véhicule n'accepte plus 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 sous la forme d'une paire clé-valeur. La longueur de la chaîne "clé:valeur" 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. La valeur de l'attribut peut être de type chaîne, booléen 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 à double type.

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 automobile.
TAXI Tout véhicule qui sert de taxi (généralement sous licence ou réglementé).
TRUCK En général, un véhicule avec une grande capacité de stockage.
TWO_WHEELER Moto, mobylette ou autre véhicule à deux roues
BICYCLE Transport à propulsion humaine
PEDESTRIAN Transporteur humain, généralement à pied ou en courant, se déplaçant le long de voies piétonnes.

LicensePlate

Informations sur la plaque d'immatriculation du véhicule. Pour éviter de stocker des informations permettant d'identifier personnellement l'utilisateur, seules les informations minimales sur la plaque d'immatriculation sont stockées dans l'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

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

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

TrafficPolylineData

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

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

object (VisualTrafficReportPolylineRendering)

Affichage d'une polyligne représentant la vitesse du trafic pour toutes les régions sur un tronçon du trajet d'un client.

VisualTrafficReportPolylineRendering

Décrit comment les clients doivent colorer une partie de la polyligne le long du parcours.

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

object (RoadStretch)

Facultatif. Segments de route à afficher le long de la polyligne. Les tronçons ne se chevauchent pas et ne couvrent pas nécessairement l'ensemble du trajet.

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

RoadStretch

Un tronçon de route à afficher.

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 chemin d'accès 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 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)

Comportement 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 dans un état 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 la fonctionnalité "Économiseur de batterie" est activée. (https://developer.android.com/reference/android/os/PowerManager#getLocationPowerSaveMode())

Enums
UNKNOWN_LOCATION_POWER_SAVE_MODE Undefined LocationPowerSaveMode
LOCATION_MODE_NO_CHANGE Soit les fournisseurs de position ne doivent pas être affectés par l'économiseur de batterie, soit l'économiseur de batterie est désactivé.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Le fournisseur de position 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 position 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 position restent disponibles, mais les corrections de position ne doivent être fournies 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 n'est pas 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 ou en 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 ou en 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 se décharge.
BATTERY_STATUS_FULL La batterie est pleine.
BATTERY_STATUS_NOT_CHARGING La batterie ne se recharge pas.
BATTERY_STATUS_POWER_LOW La batterie est faible.

PowerSource

Type de chargeur utilisé pour recharger 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

 Instancier un nouveau véhicule associé à un fournisseur de services de covoiturage ou de livraison à la demande

get

 Renvoie un véhicule à partir de Fleet Engine.

list

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

update

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

updateAttributes

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