Method: providers.vehicles.list

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

Requête HTTP

GET https://fleetengine.googleapis.com/v1/{parent=providers/*}/vehicles

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
parent

string

Obligatoire. Doit se présenter sous la forme providers/{provider}. Le fournisseur doit être l'ID du projet Google Cloud (par exemple, sample-cloud-project) auquel appartient le compte de service qui effectue cet appel.

Paramètres de requête

Paramètres
header

object (RequestHeader)

En-tête de requête Fleet Engine standard.

pageSize

integer

Nombre maximal de véhicules à renvoyer. La valeur par défaut est 100.

pageToken

string

Valeur de nextPageToken fournie par un appel précédent à vehicles.list afin que vous puissiez paginer des groupes de véhicules. La valeur n'est pas définie si les critères de filtrage de la demande ne sont pas identiques à ceux de l'appel précédent à vehicles.list.

minimumCapacity

integer

Spécifie la capacité minimale requise du véhicule. La valeur maximumCapacity de tous les véhicules renvoyés est supérieure ou égale à cette valeur. S'il est défini, il doit être supérieur ou égal à 0.

tripTypes[]

enum (TripType)

Limite la réponse aux véhicules compatibles avec au moins un des types de trajets spécifiés.

maximumStaleness

string (Duration format)

Limite la réponse aux véhicules qui ont envoyé des mises à jour de position à Fleet Engine au cours de la durée spécifiée. Les véhicules fixes qui transmettent encore leur position ne sont pas considérés comme obsolètes. S'il est présent, il doit s'agir d'une durée positive valide.

Durée en secondes avec neuf chiffres au maximum après la virgule et se terminant par "s". Exemple : "3.5s"

vehicleTypeCategories[]

enum (Category)

Obligatoire. Limite la réponse aux véhicules appartenant à l'une des catégories de types spécifiées. UNKNOWN : non autorisé.

requiredAttributes[]

string

Les appelants peuvent former des opérations logiques complexes en utilisant n'importe quelle combinaison des champs requiredAttributes, requiredOneOfAttributes et requiredOneOfAttributeSets.

requiredAttributes est une liste ; requiredOneOfAttributes utilise un message qui autorise une liste de listes. Ensemble, les deux champs permettent de composer cette expression:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(requiredOneOfAttributes[0][0] OR requiredOneOfAttributes[0][1] OR
...)
AND
(requiredOneOfAttributes[1][0] OR requiredOneOfAttributes[1][1] OR
...)

Limite la réponse aux véhicules avec les attributs spécifiés. Ce champ est une opération de conjonction/opération AND. Un maximum de 50 attributs requiredAttributes est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisé pour un véhicule. Chaque chaîne répétée doit être au format "key:value".

requiredOneOfAttributes[]

string

Limite la réponse aux véhicules avec au moins un des attributs spécifiés dans chaque VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à au moins un des attributs. Ce champ est une opération de disjonction/OU inclusive dans chaque VehicleAttributeList et une opération de conjonction/ET sur la collection de VehicleAttributeList. Chaque chaîne répétée doit être au format "clé1:valeur1|clé2:valeur2|clé3:valeur3".

requiredOneOfAttributeSets[]

string

requiredOneOfAttributeSets fournit des fonctionnalités supplémentaires.

Comme pour requiredOneOfAttributes, requiredOneOfAttributeSets utilise un message qui autorise une liste de listes, ce qui permet d'utiliser des expressions comme celle-ci:

(requiredAttributes[0] AND requiredAttributes[1] AND ...)
AND
(
  (requiredOneOfAttributeSets[0][0] AND
  requiredOneOfAttributeSets[0][1] AND
  ...)
  OR
  (requiredOneOfAttributeSets[1][0] AND
  requiredOneOfAttributeSets[1][1] AND
  ...)
)

Limite la réponse aux véhicules qui correspondent à tous les attributs d'une VehicleAttributeList. Dans chaque liste, un véhicule doit correspondre à tous les attributs. Ce champ est une opération de conjonction/ET dans chaque VehicleAttributeList et une opération de disjonction inclusive/OU dans la collection de VehicleAttributeList. Chaque chaîne répétée doit être au format "clé1:valeur1|clé2:valeur2|clé3:valeur3".

vehicleState

enum (VehicleState)

Limite la réponse aux véhicules dans cet état.

onTripOnly

boolean

Ne renvoyez que les véhicules avec le ou les trajets actuels.

filter

string

Facultatif. Requête de filtre à appliquer lorsque vous listez des véhicules. Consultez la page http://aip.dev/160 pour obtenir des exemples de syntaxe de filtre.

Ce champ est conçu pour remplacer les champs requiredAttributes, requiredOneOfAttributes et required_one_of_attributes_sets. Si une valeur non vide est spécifiée ici, les champs suivants doivent être vides: requiredAttributes, requiredOneOfAttributes et required_one_of_attributes_sets.

Ce filtre fonctionne comme une clause ET avec d'autres contraintes, telles que vehicleState ou onTripOnly.

Notez que les seules requêtes acceptées concernent les attributs du véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). Le nombre maximal de restrictions autorisé dans une requête de filtre est de 50.

De plus, tous les attributs sont stockés sous forme de chaînes. Par conséquent, les seules comparaisons acceptées par rapport aux attributs sont les comparaisons de chaînes. Pour effectuer une comparaison avec des valeurs numériques ou booléennes, les valeurs doivent être explicitement placées entre guillemets pour être traitées comme des chaînes (par exemple, attributes.<key> = "10" ou attributes.<key> = "true").

viewport

object (Viewport)

Facultatif. Filtre qui limite les véhicules renvoyés à ceux dont la dernière position connue se trouvait dans la zone rectangulaire définie par la fenêtre d'affichage.

Corps de la requête

Le corps de la requête doit être vide.

Corps de la réponse

Message de réponse vehicles.list.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON
{
  "vehicles": [
    {
      object (Vehicle)
    }
  ],
  "nextPageToken": string,
  "totalSize": string
}
Champs
vehicles[]

object (Vehicle)

Véhicules correspondant aux critères de la demande. Le nombre maximal de véhicules renvoyés est déterminé par le champ pageSize de la requête.

nextPageToken

string

Jeton permettant de récupérer la page de véhicules suivante ou vide si aucun autre véhicule ne correspond aux critères de la demande.

totalSize

string (int64 format)

Obligatoire. Nombre total de véhicules correspondant aux critères de la demande sur toutes les pages.

Fenêtre d'affichage

Fenêtre d'affichage de latitude-longitude, représentée par deux points low et high opposés en diagonale. Une fenêtre d'affichage est considérée comme une région fermée (elle inclut ses limites). Les limites de latitude doivent être comprises entre -90 et 90 degrés inclus, et les limites de longitude entre -180 et 180 degrés inclus. Voici différents cas de figure:

  • Si low = high, la fenêtre d'affichage est constituée de ce seul point.

  • Si low.longitude > high.longitude, la plage de longitudes est inversée (la fenêtre d'affichage traverse la ligne de longitude à 180 degrés).

  • Si low.longitude = -180 degrés et high.longitude = 180 degrés, la fenêtre d'affichage inclut toutes les longitudes.

  • Si low.longitude = 180 degrés et high.longitude = -180 degrés, la plage de longitudes est vide.

  • Si low.latitude > high.latitude, la plage de latitude est vide.

Les champs low et high doivent tous les deux être renseignés, et la zone représentée ne peut pas être vide (comme spécifié dans les définitions ci-dessus). Si la fenêtre d'affichage est vide, cela génère une erreur.

Par exemple, cette fenêtre d'affichage englobe entièrement New York:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Représentation JSON
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Champs
low

object (LatLng)

Obligatoire. Point bas de la fenêtre d'affichage.

high

object (LatLng)

Obligatoire. Point haut de la fenêtre d'affichage.