Method: providers.deliveryVehicles.list

Récupère tous les DeliveryVehicle qui répondent aux critères de filtrage spécifiés.

Requête HTTP

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

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}. provider doit être l'ID du projet Google Cloud. Par exemple, sample-cloud-project.

Paramètres de requête

Paramètres
header

object (DeliveryRequestHeader)

Facultatif. En-tête de requête standard de l'API Delivery.
pageSize

integer

Facultatif. Nombre maximal de véhicules à renvoyer. Le service peut renvoyer un nombre inférieur à ce nombre. Si vous ne spécifiez pas ce nombre, le serveur détermine le nombre de résultats à renvoyer.
pageToken

string

Facultatif. Jeton de page reçu d'un appel deliveryVehicles.list précédent. Vous devez le fournir pour récupérer la page suivante.

Lors de la pagination, tous les autres paramètres fournis à deliveryVehicles.list doivent correspondre à l'appel ayant fourni le jeton de page.
filter

string

Facultatif. Requête de filtrage à appliquer lors de la liste des véhicules de livraison. Pour obtenir des exemples de syntaxe de filtre, consultez http://aip.dev/160. Si vous ne spécifiez pas de valeur ou si vous spécifiez une chaîne vide pour le filtre, tous les véhicules de livraison sont renvoyés.

Notez que les seules requêtes acceptées pour deliveryVehicles.list concernent les attributs du véhicule (par exemple, attributes.<key> = <value> ou attributes.<key1> = <value1> AND attributes.<key2> = <value2>). De plus, tous les attributs sont stockés sous forme de chaînes. Par conséquent, les seules comparaisons acceptées pour les 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").

Le nombre maximal de restrictions autorisé dans une requête de filtrage est de 50. Une restriction fait partie de la requête au format attribute.<KEY> <COMPARATOR> <VALUE>. Par exemple, attributes.foo = bar correspond à une restriction.
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

Le message de réponse deliveryVehicles.list

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

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

object (DeliveryVehicle)

Ensemble des véhicules de livraison qui répondent aux critères de filtrage demandés. Si aucun filtre n'est spécifié, la requête renvoie tous les véhicules de livraison. Une réponse réussie peut également être vide. Une réponse vide indique qu'aucun véhicule de livraison ne correspond aux critères de filtrage demandés.
nextPageToken

string

Vous pouvez transmettre ce jeton dans ListDeliveryVehiclesRequest pour continuer à afficher les résultats. Lorsque tous les résultats sont renvoyés, ce champ n'est pas inclus dans la réponse ou il s'agit d'une chaîne vide.
totalSize

string (int64 format)

Nombre total de véhicules de livraison 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 diagonalement opposés. 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 quelques exemples :

  • Si low = high, la fenêtre d'affichage ne comprend qu'un seul point.

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

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

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

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

low et high doivent être renseignés, et la zone représentée ne doit pas être vide (comme indiqué dans les définitions ci-dessus). Un viewport vide entraînera une erreur.

Par exemple, ce viewport englobe entièrement la ville de 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.