- Requête HTTP
- Paramètres de chemin d'accès
- Paramètres de requête
- Corps de la requête
- Corps de la réponse
- Fenêtre d'affichage
Affiche une liste paginée des véhicules associés à un fournisseur qui correspond 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 |
Obligatoire. Doit se présenter sous la forme |
Paramètres de requête
Paramètres | |
---|---|
header |
En-tête de requête Fleet Engine standard. |
pageSize |
Nombre maximal de véhicules à renvoyer. Valeur par défaut: 100. |
pageToken |
Valeur de |
minimumCapacity |
Indique la capacité minimale requise pour le véhicule. Tous les véhicules renvoyés auront un |
tripTypes[] |
Limite la réponse aux véhicules qui prennent en charge au moins l'un des types de trajets spécifiés. |
maximumStaleness |
Limite la réponse aux véhicules ayant envoyé des mises à jour de position à Fleet Engine pendant la durée spécifiée. Les véhicules à l'arrêt qui transmettent leur position ne sont pas considérés comme obsolètes. Si cet attribut 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 " |
vehicleTypeCategories[] |
Obligatoire. Limite la réponse aux véhicules appartenant à l'une des catégories de type spécifiées. |
requiredAttributes[] |
Les appelants peuvent former des opérations logiques complexes en utilisant n'importe quelle combinaison des champs
Limite la réponse aux véhicules avec les attributs spécifiés. Ce champ est une opération de conjonction/ET. Un maximum de 50 obligatoireAttributes est autorisé. Ce nombre correspond au nombre maximal d'attributs autorisés sur un véhicule. Chaque chaîne répétée doit être au format "clé:valeur". |
requiredOneOfAttributes[] |
Limite la réponse aux véhicules avec au moins l'un des attributs spécifiés dans chaque |
requiredOneOfAttributeSets[] |
À l'instar de
Limite la réponse aux véhicules correspondant à tous les attributs d'un |
vehicleState |
Limite la réponse aux véhicules présentant cet état. |
onTripOnly |
Ne renvoyez que les véhicules associés à des trajets en cours. |
filter |
Facultatif. Requête de filtre à appliquer lors de la création de listes de véhicules. Consultez http://aip.dev/160 pour obtenir des exemples de syntaxe de filtrage. Ce champ est conçu pour remplacer les champs Ce filtre fonctionne comme une clause ET avec d'autres contraintes, telles que Notez que les seules requêtes acceptées concernent les attributs de véhicule (par exemple, De plus, tous les attributs sont stockés sous forme de chaînes. Par conséquent, les seules comparaisons par rapport aux attributs acceptées sont des comparaisons de chaînes. Pour être comparées aux valeurs numériques ou booléennes, les valeurs doivent être entre guillemets explicites pour être traitées comme des chaînes (par exemple, |
viewport |
Facultatif. Un 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 ( |
Champs | |
---|---|
vehicles[] |
Véhicules correspondant aux critères de la demande. Le nombre maximal de véhicules renvoyés est déterminé par le champ |
nextPageToken |
Jeton permettant de récupérer la page de véhicules suivante, ou vide si plus aucun véhicule ne répond aux critères de la requête. |
totalSize |
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, c'est-à-dire qu'elle inclut ses limites. Les limites de latitude doivent être comprises entre -90 et 90 degrés inclus, et les limites de longitude doivent être comprises entre -180 et 180 degrés inclus. Différents cas sont possibles:
Si
low
=high
, la fenêtre d'affichage est constituée de ce point unique.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 ethigh.longitude
= 180 degrés, la fenêtre d'affichage inclut toutes les longitudes.Si
low.longitude
= 180 degrés ethigh.longitude
= -180 degrés, la plage de longitude est vide.Si
low.latitude
>high.latitude
, la plage de latitudes est vide.
Les champs low
et high
doivent être renseignés, et la zone représentée ne peut pas être vide (comme indiqué dans les définitions ci-dessus). Si la fenêtre d'affichage est vide, une erreur se produit.
Par exemple, cette fenêtre d'affichage affiche entièrement New York:
{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }
Représentation JSON |
---|
{ "low": { object ( |
Champs | |
---|---|
low |
Obligatoire. Point bas de la fenêtre d'affichage. |
high |
Obligatoire. Point haut de la fenêtre d'affichage. |