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 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 100 attributs au maximum, et chacun d'entre eux doit être associé à une clé unique.
vehicleType

object (VehicleType)

Obligatoire. Type de véhicule. Permet de filtrer les véhicules dans les résultats vehicles.search. Influe également sur l'heure d'arrivée prévue et le calcul de l'itinéraire.
licensePlate

object (LicensePlate)

Informations sur 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 jusqu'au prochain point de cheminement. 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é à être utilisé uniquement 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é à être utilisé uniquement 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 de renvoyer des routes qui n'ont pas changé.

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)

Point de cheminement où currentRouteSegment se termine. Lors des appels vehicles.update, les conducteurs peuvent fournir cette valeur soit en tant que point de cheminement complet, en tant que point de cheminement LatLng ou en tant que dernier LatLng du currentRouteSegment. Fleet Engine s'efforcera alors d'interpoler au mieux 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 restante en voiture 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)

L'heure d'arrivée prévue de 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.

Lorsque vous mettez à jour un véhicule, remainingTimeSeconds est prioritaire sur etaToFirstWaypoint dans la même requête.

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

integer

Uniquement en entrée. Temps de trajet restant pour la 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.

Lorsque vous mettez à jour 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.

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

boolean

Indique si le conducteur accepte les trajets aller-retour. 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 la 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'une Vehicle

Enums
UNKNOWN_VEHICLE_STATE Valeur par défaut, utilisée 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'un trajet 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 longueur de la chaîne "key:value" ne peut 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, valeur booléenne 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 finira par être abandonné. Pour les méthodes de création ou de mise à jour, vous pouvez utiliser l'un ou l'autre champ, mais nous vous recommandons vivement d'utiliser stringValue. Si stringValue et value sont tous les deux définis, ils doivent être identiques, sans quoi une erreur est 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 du type de véhicule

Catégorie

Catégories de type de véhicule

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 agissant en tant que taxi (généralement agréé ou réglementé)
TRUCK Il s'agit généralement d'un véhicule disposant d'une grande capacité de stockage.
TWO_WHEELER Moto, cyclomoteur ou autre véhicule à deux roues
BICYCLE Transport à énergie humaine.
PEDESTRIAN Transporteur humain (généralement à pied ou en courant) empruntant des voies piétonnes.

LicensePlate

Informations sur la plaque d'immatriculation du véhicule. Pour éviter de conserver des informations permettant d'identifier personnellement l'utilisateur, seules les informations minimales concernant la plaque d'immatriculation sont enregistrées comme faisant partie de 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 indiquée sur celle-ci.

  • "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)

Rendu en polyligne de la vitesse du trafic dans toutes les régions sur une portion du trajet d'un client.

VisualTrafficReportPolylineRendering

Décrit comment 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 qui doivent être affichées le long de la polyligne. Il est garanti que les tronçons ne se chevauchent pas et ne couvrent pas nécessairement l'intégralité de l'itinéraire.

En l'absence de tronçon de route pour le style, le client doit appliquer la valeur 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 les [offsetMeters, offsetMeters + lengthMeters).
lengthMeters

integer

Obligatoire. Longueur du tracé auquel appliquer le style.

Style

Style de trafic indiquant la vitesse de circulation.

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)

Comment les fonctionnalités de localisation sont configurées pour se comporter 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

La manière dont 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 LocationPowerSaveMode non défini
LOCATION_MODE_NO_CHANGE L'économiseur de batterie n'a aucune incidence sur les fournisseurs de localisation, ou bien celui-ci est désactivé.
LOCATION_MODE_GPS_DISABLED_WHEN_SCREEN_OFF Le fournisseur de localisation par 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 localisation resteront disponibles, mais les correctifs de localisation ne doivent être fournis qu'aux applications au premier plan.
LOCATION_MODE_THROTTLE_REQUESTS_WHEN_SCREEN_OFF La localisation n'est pas désactivée, mais LocationManager limite toutes les requêtes adressé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 (chargée, 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 (chargée, en charge, etc.)

Enums
UNKNOWN_BATTERY_STATUS État de la batterie inconnu.
BATTERY_STATUS_CHARGING La batterie est en cours de chargement.
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 recharge 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 transport ou de livraison à la demande.

get

 Renvoie un véhicule Fleet Engine.

list

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

searchFuzzed
(deprecated)

 Obsolète: utilisez plutôt SearchVehicles.

update

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

updateAttributes

 Met à jour partiellement les attributs du véhicule.

updateLocation
(deprecated)

 Obsolète: utilisez plutôt la méthode UpdateVehicle.