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 compatibles avec 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 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.

object (VehicleAttribute)

Liste des attributs du véhicule. Un véhicule peut comporter 100 attributs au maximum, chacun d'entre eux devant être associé à une clé unique.

object (VehicleType)

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

object (LicensePlate)

Informations sur 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 accéder 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.

object (TrafficPolylineData)

Uniquement en entrée. Fleet Engine utilise ces informations pour améliorer le partage de trajets. Remarque: Ce champ est destiné à être utilisé uniquement 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 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 après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

object (TripWaypoint)

Point de cheminement où se termine currentRouteSegment. Il peut être fourni par les conducteurs lors des appels vehicles.update en tant que point de cheminement pour un trajet 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 s'il n'est pas complètement 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 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 après la virgule. 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 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.

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 cette valeur en cache 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 après la virgule. Exemples: "2014-10-02T15:01:23Z" et "2014-10-02T15:01:23.045123456Z".

boolean

Indique si le conducteur accepte les allers-retours. 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.

enum (NavigationStatus)

État de la navigation du véhicule.

object (DeviceSettings)

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

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

boolean

Valeur d'attribut de type booléen.

number

Valeur d'attribut de type double.

{
  "category": enum (Category)
}

enum (Category)

Catégorie du 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

La plaque d'immatriculation contient le dernier chiffre de la plaque d'immatriculation ou "-1" pour indiquer qu'aucune valeur numérique n'est indiquée.

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

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

object (VisualTrafficReportPolylineRendering)

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

{
  "roadStretch": [
    {
      object (RoadStretch)
    }
  ]
}

object (RoadStretch)

Facultatif. Sections de route devant ê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 de l'itinéraire.

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

enum (Style)

Obligatoire. Style à appliquer.

integer

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

integer

Obligatoire. Longueur du tracé auquel appliquer le style.

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

enum (LocationPowerSaveMode)

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

object (BatteryInfo)

Informations sur l'état de la batterie.

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

enum (BatteryStatus)

État de la batterie, qu'elle soit pleine, en charge, etc.

enum (PowerSource)

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

number

Pourcentage actuel de la batterie [0-100].