Rechercher des véhicules

Dans le cadre du service de trajets à la demande Mobility, vous pouvez trouver des véhicules à proximité à l'aide de la méthode SearchVehicles.

La méthode SearchVehicles vous permet de trouver dans votre application mobile grand public les véhicules disponibles à proximité qui conviennent le mieux à une course ou à une demande de livraison spécifique. L'API SearchVehicles renvoie une liste classée des véhicules dont les attributs correspondent à ceux du trajet demandé. Le classement est effectué en fonction de votre choix : heure d'arrivée prévue, distance ou distance en ligne droite depuis le point de prise en charge.

Utiliser la méthode SearchVehicles

Pour utiliser SearchVehicles, suivez la procédure générale ci-dessous :

1. Créez une SearchVehiclesRequest en fonction du trajet à attribuer.
2. Appelez l'API SearchVehicles (vehicleService.searchVehicles) avec la requête créée.
3. Traitez la SearchVehicleResponse renvoyée par l'API.

Champs SearchVehiclesRequest

Utilisez les champs d'attributs obligatoires suivants pour créer une SearchVehiclesRequest :

Consultez la documentation de référence pour obtenir la liste complète des SearchVehicleRequest.

Scénarios SearchVehiclesRequest

Cette section présente des exemples de création d'une SearchVehiclesRequest.

Supposons, par exemple, qu'un client souhaite être pris en charge au restaurant X et que vous disposez de quatre véhicules :

• Véhicule 1 : à 3 500 m du restaurant X.
• Véhicule 2 : à 100 m du restaurant X, avec un trajet actif avec prise en charge et dépose aux points A et B.
• Véhicule 3 : à 200 m du restaurant X, avec un point de dépose restant très éloigné.
• Véhicule 4 : à 1 000 m du restaurant X.

Les requêtes suivantes sont affichées par véhicule renvoyé.

     Pickup at RestaurantX, radius = 1200m, order by PICKUP_POINT_ETA
    

     Pickup at RestaurantX, radius = 1200m, order by PICKUP_POINT_ETA, is_back_to_back enabled
    

     Pickup at RestaurantX, radius = 1200m, order by PICKUP_POINT_ETA, current_trips_present = ALL
    

Champs SearchVehiclesResponse

Une SearchVehiclesResponse est constituée d'une liste d'entités VehicleMatch, classées selon l'attribut order_by spécifié dans la SearchVehiclesRequest. Chaque entité VehicleMatch comporte les champs suivants :

Pour obtenir la liste complète des champs VehicleMatch, consultez les ressources suivantes :

• VehicleMatch message (gRPC)
• VehicleMatch resource (REST)

Utiliser des requêtes de filtre

SearchVehicles et ListVehicles acceptent le filtrage des attributs de véhicule à l'aide d'une requête de filtre.

Les requêtes de filtre ne sont compatibles qu'avec le filtrage des attributs personnalisés des véhicules et ne peuvent pas être utilisées pour d'autres champs. Lorsqu'elles sont utilisées dans une recherche qui inclut d'autres critères de champ, tels que minimum_capacity ou vehicle_types, la requête de filtre fonctionne comme une clause AND.

Par exemple, si vous recherchez un véhicule d'une capacité minimale de six personnes et que vous filtrez un attributes tel que "accepte les animaux", vos critères ne renverront que les véhicules qui acceptent les animaux et peuvent transporter au moins six passagers.

Pour connaître la syntaxe des requêtes de filtre, consultez AIP-160 pour obtenir des exemples. Pour en savoir plus sur la création d'attributs de véhicule, consultez le champ Attributs du véhicule dans le guide Mettre à jour les champs du véhicule.

Exemple SearchVehicles

L'exemple suivant montre comment utiliser l'API SearchVehicles à l'aide de la bibliothèque Java gRPC. Pour obtenir la liste complète des langues disponibles, consultez la page Bibliothèques clientes pour les services de trajets à la demande.

static final String PROJECT_ID = "project-id";

VehicleServiceBlockingStub vehicleService =
    VehicleService.newBlockingStub(channel);

String parent = "providers/" + PROJECT_ID;
SearchVehiclesRequest searchVehiclesRequest = SearchVehiclesRequest.newBuilder()
    .setParent(parent)
    .setPickupPoint( // Grand Indonesia East Mall
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder().setLatitude(-6.195139).setLongitude(106.820826)))
    .setDropoffPoint( // Balai Sidang Jkt Convention Center
        TerminalLocation.newBuilder().setPoint(
            LatLng.newBuilder().setLatitude(-6.213796).setLongitude(106.807195)))
    .setPickupRadiusMeters(2000)
    .setCount(10)
    .setMinimumCapacity(2)
    .addTripTypes(TripType.EXCLUSIVE)
    .addVehicleTypes(VehicleType.newBuilder().setCategory(Category.AUTO).build())
    .setCurrentTripsPresent(CurrentTripsPresent.ANY)
    .setFilter("attributes.on_trip=\"false\"")
    .setOrderBy(VehicleMatchOrder.PICKUP_POINT_ETA)
    .build();

try {
  SearchVehiclesResponse searchVehiclesResponse =
      vehicleService.searchVehicles(searchVehiclesRequest);
} catch (StatusRuntimeException e) {
  Status s = e.getStatus();
  switch (s.getCode()) {
    case NOT_FOUND:
      break;
    case PERMISSION_DENIED:
      break;
  }
  return;
}

List<VehicleMatch> vehicleMatches =
    searchVehicleResponse.getMatchesList();

// Each VehicleMatch contains a Vehicle entity and information about the
// distance and ETA to the pickup point and drop-off point.

Étape suivante

• DeleteVehicle