REST Resource: providers.vehicles

{
  "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)
  }
}

string

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

enum (VehicleState)

État du véhicule.

enum (TripType)

Types de trajets acceptés par ce véhicule.

string

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

object (VehicleLocation)

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

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.

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.

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.

object (LicensePlate)

Informations relatives à la plaque d'immatriculation du véhicule

object (TerminalLocation)

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

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.

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.

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

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é.

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.

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

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.

object (TripWaypoint)

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

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

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.

enum (NavigationStatus)

État de navigation du véhicule.

object (DeviceSettings)

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

{
  "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.
}

string

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

string

Valeur de l'attribut.

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.

boolean

Valeur d'attribut de type booléen.

number

Valeur d'attribut saisie en double.

{
  "category": enum (Category)
}

enum (Category)

Catégorie de type de véhicule

{
  "countryCode": string,
  "lastCharacter": string
}

string

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

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"

{
  "trafficRendering": {
    object (VisualTrafficReportPolylineRendering)
  }
}

object (VisualTrafficReportPolylineRendering)

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

{
  "roadStretch": [
    {
      object (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.

{
  "style": enum (Style),
  "offsetMeters": integer,
  "lengthMeters": integer
}

enum (Style)

Obligatoire. Style à appliquer.

integer

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

integer

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

{
  "locationPowerSaveMode": enum (LocationPowerSaveMode),
  "isPowerSaveMode": boolean,
  "isInteractive": boolean,
  "batteryInfo": {
    object (BatteryInfo)
  }
}

enum (LocationPowerSaveMode)

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

boolean

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

boolean

Indique si l'appareil est en mode interactif.

object (BatteryInfo)

Informations sur l'état de la batterie.

{
  "batteryStatus": enum (BatteryStatus),
  "powerSource": enum (PowerSource),
  "batteryPercentage": number
}

enum (BatteryStatus)

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

enum (PowerSource)

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

number

Pourcentage actuel de la batterie [0-100].