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. Exemple : sample-cloud-project.

Paramètres de requête

Paramètres
header

object (DeliveryRequestHeader)

Facultatif. En-tête de requête de l'API Delivery standard.
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 l'indiquer 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 filtre à appliquer lors de la création de la liste des véhicules de livraison. Consultez http://aip.dev/160 pour obtenir des exemples de syntaxe de filtrage. 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 de 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. Les seules comparaisons avec des attributs sont donc 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, attributes.<key> = "10" ou attributes.<key> = "true").

Le nombre maximal de restrictions autorisées dans une requête de filtre est de 50. Une restriction est une partie de la requête sous la forme attribute.<KEY> <COMPARATOR> <VALUE>. Par exemple, attributes.foo = bar est 1 restriction.
viewport

object (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

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 de véhicules de livraison répondant 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 positive peut également être vide. Une réponse vide indique qu'aucun véhicule de livraison ne correspond aux critères de filtre demandés.
nextPageToken

string

Vous pouvez transmettre ce jeton dans ListDeliveryVehiclesRequest pour continuer à répertorier les résultats. Lorsque tous les résultats sont renvoyés, ce champ ne figure pas dans la réponse ou prend la forme 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 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 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 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 (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.