Lister les véhicules de livraison

Ce document explique comment lister les véhicules de livraison.

Environnements et limites

Vous pouvez répertorier les véhicules de livraison à partir d'un environnement de serveur ou de navigateur. Le SDK Driver ne permet pas de présenter des véhicules de livraison.

La liste des véhicules de livraison nécessite un accès étendu aux véhicules de livraison et est destinée uniquement aux utilisateurs de confiance. Utilisez les jetons Lecteur Fleet Engine Delivery ou Fleet Engine Delivery Admin lorsque vous envoyez des requêtes de liste des véhicules de livraison.

Les champs suivants sont masqués pour les véhicules de livraison répertoriés en raison de leur impact sur la taille des réponses:

  • CurrentRouteSegment
  • RemainingVehicleJourneySegments

Utilisation

Vous pouvez répertorier les véhicules par filtres d'attributs et limites de la fenêtre d'affichage. Si vous ne spécifiez aucun filtre ni fenêtre d'affichage, la réponse inclut tous les véhicules de livraison.

Liste avec des filtres d'attributs

Vous pouvez répertorier les véhicules de livraison par filtre à l'aide de leur propriété attributes. Par exemple, pour interroger un attribut avec la clé my_key et la valeur my_value, utilisez attributes.my_key = my_value. Pour effectuer une requête sur plusieurs attributs, joignez des requêtes à l'aide des opérateurs logiques AND et OR, comme dans attributes.key1 = value1 AND attributes.key2 = value2. Consultez la page AIP-160 pour obtenir une description complète de la syntaxe des requêtes de filtre. Si vous combinez des filtres avec des limites de vue, le filtre agit comme un opérateur AND pour la limite de vue. Pour en savoir plus, consultez Requêtes de filtrage des attributs de véhicule.

Liste avec limites de la fenêtre d'affichage

Vous pouvez filtrer les véhicules de livraison répertoriés par zone géographique à l'aide du paramètre de requête viewport. Le paramètre de requête viewport définit des vues d'ensemble à l'aide de deux coordonnées de délimitation : une paire de coordonnées de latitude et de longitude high (nord-est) et low (sud-ouest). Les requêtes sont rejetées si elles contiennent une latitude élevée géographiquement inférieure à une latitude basse.

Réponses de liste

Par défaut, les listes de véhicules de diffusion sont paginées dans une taille de page raisonnable. Si vous spécifiez une taille de page, la requête ne renvoie que le nombre de véhicules spécifié par la limite, ou moins. Si la taille de page demandée dépasse une valeur maximale interne, la valeur maximale interne est utilisée. La taille de page par défaut et maximale est de 100 véhicules.

Une liste de véhicules de livraison peut inclure un jeton pour lire la page de résultats suivante. Un jeton de page n'est présent dans une réponse que lorsque davantage de pages de véhicules de livraison sont disponibles pour la récupération. Pour récupérer la page de tâches suivante, utilisez le jeton de page avec une requête qui est par ailleurs identique à la requête précédente.

Répertorier des exemples de véhicules

Vous pouvez utiliser la bibliothèque gRPC Java gRPC ou REST pour répertorier les véhicules de livraison dans une région particulière avec un certain attribut. Une réponse réussie peut toujours être vide. Cela signifie qu'aucun véhicule avec l'attribut spécifié n'existe dans la fenêtre d'affichage spécifiée.

Java


  static final String PROJECT_ID = "my-delivery-co-gcp-project";

  DeliveryServiceBlockingStub deliveryService =
    DeliveryServiceGrpc.newBlockingStub(channel);

  // Tasks request
  String parent = "providers/" + PROJECT_ID;
  ListDeliveryVehiclesRequest listDeliveryVehiclesRequest =
    ListDeliveryVehiclesRequest.newBuilder()  // No need for the header
        .setParent(parent)
        .setViewport(
              Viewport.newBuilder()
                .setHigh(LatLng.newBuilder()
                    .setLatitude(37.45)
                    .setLongitude(-122.06)
                    .build())
                .setLow(LatLng.newBuilder()
                    .setLatitude(37.41)
                    .setLongitude(-122.11)
                    .build())
        .setFilter("attributes.my_key = my_value")
        .build();

  try {
    ListDeliveryVehiclesResponse listDeliveryVehiclesResponse =
        deliveryService.listDeliveryVehicles(listDeliveryVehiclesRequest);
  } catch (StatusRuntimeException e) {
    Status s = e.getStatus();
    switch (s.getCode()) {
        case NOT_FOUND:
            break;

        case PERMISSION_DENIED:
            break;
    }
    return;
  }

REST

  # HTTP request
  html GET https://fleetengine.googleapis.com/v1/providers/<project_id>/deliveryVehicles


  # Request with a filter
  # Request sets JWT, PROJECT_ID, and VEHICLE_ID in the local environment
  curl -H "Authorization: Bearer ${JWT}" \
    "https://fleetengine.googleapis.com/v1/providers/${PROJECT_ID}/deliveryVehicles?filter=attributes.my_key%20%3D%20my_value%20&viewport.high.latitude=37.45&viewport.high.longitude=-122.06&viewport.low.latitude=37.41&viewport.low.longitude=-122.11"

Si la recherche aboutit, le corps de la réponse contient des données présentant la structure suivante:

  // JSON representation
  {
    "deliveryVehicles": [
      {
        object (DeliveryVehicle)
      }
    ],
    "nextPageToken": string,
    "totalSize": integer
  }

Étape suivante