Saisie semi-automatique (nouveau)

Sélectionnez une plate-forme: Android iOS JavaScript Service Web

La saisie semi-automatique (nouveau) renvoie des prédictions de lieu en réponse à une requête qui inclut une chaîne de recherche textuelle et des limites géographiques qui contrôlent la zone de recherche. La saisie semi-automatique peut mettre en correspondance des mots complets et des sous-chaînes de l'entrée, afin de trouver des noms de lieux, des adresses et des plus codes. Votre application peut envoyer des requêtes lors de la frappe pour fournir des prédictions de lieux et de requêtes à la volée.

Par exemple, vous appelez la saisie semi-automatique en utilisant comme entrée une chaîne contenant une entrée utilisateur partielle, "Sicilian piz", avec la zone de recherche limitée à San Francisco, en Californie. La réponse contient ensuite une liste de prédictions de lieux correspondant à la chaîne de recherche et à la zone de recherche, par exemple le restaurant nommé "Sicilian Pizza Kitchen".

Les prédictions de lieu renvoyées sont conçues pour être présentées à l'utilisateur afin de l'aider à sélectionner le lieu souhaité. Vous pouvez effectuer une requête Place Details (New) pour obtenir plus d'informations sur les prédictions de lieu renvoyées.

Requêtes Autocomplete (nouvelle)

Votre application peut obtenir une liste de noms et/ou d'adresses prédits de lieux à partir de l'API de saisie semi-automatique en appelant PlacesClient.findAutocompletePredictions() et en transmettant un objet FindAutocompletePredictionsRequest. L'exemple ci-dessous montre un appel complet à PlacesClient.findAutocompletePredictions().

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();
LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);
final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Sicilian piz")
            .setRegionCode("ES")
            .setLocationRestriction(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Réponses de la saisie semi-automatique (nouvelle version)

L'API renvoie un FindAutocompletePredictionsResponse dans un Task. Le FindAutocompletePredictionsResponse contient une liste de cinq objets AutocompletePrediction maximum représentant les lieux prédits. La liste peut être vide s'il n'existe aucun lieu connu correspondant à la requête et aux critères de filtre.

Pour chaque lieu prédit, vous pouvez appeler les méthodes suivantes afin de récupérer des détails sur le lieu:

  • getFullText(CharacterStyle) renvoie le texte complet de la description d'un lieu. Il s'agit d'une combinaison du texte principal et secondaire. Exemple: "Tour Eiffel, Avenue Anatole France, Paris, France". De plus, cette méthode vous permet de mettre en surbrillance les sections de la description qui correspondent à la recherche avec le style de votre choix à l'aide de CharacterStyle. Le paramètre CharacterStyle est facultatif. Définissez-le sur "null" si vous n'avez pas besoin de la mise en surbrillance.
  • getPrimaryText(CharacterStyle) renvoie le texte principal décrivant un lieu. Il s'agit généralement du nom du lieu. Exemples: "Tour Eiffel" et "123 Pitt Street".
  • getSecondaryText(CharacterStyle) renvoie le texte annexe d'une description de lieu. Cette valeur est utile, par exemple, comme deuxième ligne lors de l'affichage des prédictions de saisie semi-automatique. Exemples : "Avenue Anatole France, Paris, France" et "Sydney, Nouvelle-Galles du Sud".
  • getPlaceId() renvoie l'ID de lieu du lieu prédit. Un ID de lieu est un identifiant textuel qui identifie un lieu de manière unique. Vous pouvez l'utiliser pour récupérer ultérieurement l'objet Place. Pour en savoir plus sur les ID de lieu dans Autocomplete, consultez Place Details (New). Pour obtenir des informations générales sur les ID de lieu, consultez la présentation des ID de lieu.
  • getTypes() renvoie la liste des types de lieux associés à ce lieu.
  • getDistanceMeters() renvoie la distance en ligne droite, exprimée en mètres, entre ce lieu et le point de départ spécifié dans la requête.

Paramètres obligatoires

  • Requête

    Chaîne de texte dans laquelle effectuer la recherche. Spécifiez des mots complets et des sous-chaînes, des noms de lieux, des adresses et des plus codes. Le service de saisie semi-automatique (nouveau) renvoie les résultats correspondant à cette chaîne et les classe en fonction de leur pertinence estimée.

    Pour définir le paramètre de requête, appelez la méthode setQuery() lors de la création de l'objet FindAutocompletePredictionsRequest.

Paramètres facultatifs

  • Types principaux

    Une liste comportant jusqu'à cinq valeurs de type issues des types du tableau A ou du tableau B, utilisée pour filtrer les lieux renvoyés dans la réponse. Un lieu doit correspondre à l'une des valeurs de type principal spécifiées pour être inclus dans la réponse.

    Un lieu ne peut avoir qu'un seul type principal parmi les types du Tableau A ou du Tableau B. Par exemple, le type principal peut être "mexican_restaurant" ou "steak_house".

    La requête est rejetée avec une erreur INVALID_REQUEST dans les cas suivants:

    • Plus de cinq types sont spécifiés.
    • Tous les types non reconnus sont spécifiés.

    Pour définir le paramètre des types principaux, appelez la méthode setTypesFilter() lors de la création de l'objet FindAutocompletePredictionsRequest.

  • Pays

    N'incluez que les résultats de la liste des pays spécifiés, sous la forme d'une liste comportant jusqu'à 15 valeurs ccTLD ("domaine de premier niveau") à deux caractères. Si cette valeur est omise, aucune restriction n'est appliquée à la réponse. Par exemple, pour limiter les régions à l'Allemagne et à la France:

    Si vous spécifiez à la fois locationRestriction et includedRegionCodes, les résultats sont situés dans la zone d'intersection des deux paramètres.

    Pour définir le paramètre de pays, appelez la méthode setCountries() lors de la création de l'objet FindAutocompletePredictionsRequest.

  • Décalage d'entrée

    Décalage du caractère Unicode de base zéro indiquant la position du curseur dans la requête. La position du curseur peut influencer les prédictions renvoyées. Si ce champ n'est pas renseigné, la longueur de la requête est définie par défaut.

    Pour définir le paramètre de décalage d'entrée, appelez la méthode setInputOffset() lors de la création de l'objet FindAutocompletePredictionsRequest.

  • Biais ou restriction de localisation

    Vous pouvez spécifier un biais ou une restriction de lieu, mais pas les deux, pour définir la zone de recherche. Considérez la restriction d'emplacement comme la spécification de la région dans laquelle les résultats doivent se trouver, et la pondération de la localisation comme la spécification de la région à laquelle les résultats doivent se trouver. La principale différence est qu'avec un biais d'emplacement, des résultats situés en dehors de la région spécifiée peuvent tout de même être renvoyés.

    • Biais de localisation

      Spécifie une zone de recherche. Cet emplacement sert de biais, et non de restriction. Par conséquent, des résultats situés en dehors de la zone spécifiée peuvent toujours être renvoyés.

      Pour définir le paramètre de biais de localisation, appelez la méthode setLocationBias() lors de la création de l'objet FindAutocompletePredictionsRequest.

    • Restriction géographique

      Spécifie une zone de recherche. Les résultats situés en dehors de la zone spécifiée ne sont pas renvoyés.

      Pour définir le paramètre de restriction d'emplacement, appelez la méthode setLocationRestriction() lors de la création de l'objet FindAutocompletePredictionsRequest.

    Spécifiez la zone de pondération ou de restriction de localisation sous forme de fenêtre d'affichage rectangulaire ou de cercle.

    • Un cercle est défini par le point central et le rayon en mètres. Le rayon doit être compris entre 0,0 et 50 000,0 inclus. La valeur par défaut est 0.0. Pour les restrictions géographiques, vous devez définir le rayon sur une valeur supérieure à 0,0. Sinon, la requête ne renvoie aucun résultat.

    • Un rectangle est une fenêtre d'affichage en fonction de la latitude et de la 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, ce qui signifie qu'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:

      • Si low = high, la fenêtre d'affichage est constituée de ce seul point.
      • 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 longitudes est vide.

      Les champs low et high doivent tous les deux être renseignés, et la zone représentée ne peut pas être vide. Une fenêtre d'affichage vide entraîne une erreur.

  • Provenance

    Point de départ à partir duquel calculer la distance en ligne droite jusqu'à la destination (accessible à l'aide de getDistanceMeters()). Si cette valeur est omise, la distance en ligne droite n'est pas renvoyée. Doit être spécifié en tant que coordonnées de latitude et de longitude:

    Pour définir le paramètre d'origine, appelez la méthode setOrigin() lors de la création de l'objet FindAutocompletePredictionsRequest.

  • Code régional

    Code régional utilisé pour mettre en forme la réponse, y compris le format d'adresse, spécifié sous la forme d'une valeur à deux caractères ccTLD ("domaine de premier niveau"). La plupart des codes ccTLD sont identiques aux codes ISO 3166-1, à quelques exceptions près. Par exemple, le ccTLD du Royaume-Uni est "uk" (.co.uk), tandis que son code ISO 3166-1 est "gb" (techniquement pour l'entité "Royaume-Uni de Grande-Bretagne et d'Irlande du Nord").

    Si vous spécifiez un code de région non valide, l'API renvoie une erreur INVALID_ARGUMENT. Ce paramètre peut avoir un impact sur les résultats en fonction du droit applicable.

    Pour définir le paramètre de code régional, appelez la méthode setRegionCode() lors de la création de l'objet FindAutocompletePredictionsRequest.

  • Jeton de session

    Les jetons de session sont des chaînes générées par l'utilisateur qui suivent les appels de la saisie semi-automatique (nouveau) comme des "sessions". La saisie semi-automatique utilise des jetons de session pour regrouper les phases de requête et de sélection d'une recherche avec saisie semi-automatique d'un utilisateur dans une session distincte à des fins de facturation. La session commence lorsque l'utilisateur commence à saisir une requête et se termine lorsqu'il sélectionne un lieu. Chaque session peut comporter plusieurs requêtes, suivies d'une sélection de lieux. Une fois la session terminée, le jeton n'est plus valide. Votre application doit générer un nouveau jeton pour chaque session. Nous vous recommandons d'utiliser des jetons de session pour toutes les sessions de saisie semi-automatique programmatique (l'API s'en charge automatiquement lorsque vous intégrez un fragment ou lancez la saisie semi-automatique à l'aide d'un intent).

    La saisie semi-automatique utilise un AutocompleteSessionToken pour identifier chaque session. Votre application doit transmettre un nouveau jeton de session au début de chaque nouvelle session, puis ce même jeton, ainsi qu'un ID de lieu, lors de l'appel suivant à fetchPlace() afin de récupérer Place Details pour le lieu sélectionné par l'utilisateur.

    Pour définir le paramètre de jeton de session, appelez la méthode setSessionToken() lors de la création de l'objet FindAutocompletePredictionsRequest.

    Pour en savoir plus, consultez la section Jetons de session.

Exemples de saisie semi-automatique (nouveau)

Utiliser la restriction d'emplacement et le biais de localisation

La saisie semi-automatique (nouvelle version) utilise par défaut la pondération de l'adresse IP pour contrôler la zone de recherche. Avec la pondération de l'adresse IP, l'API utilise l'adresse IP de l'appareil pour pondérer les résultats. Vous pouvez éventuellement utiliser une restriction de zone géographique ou un biais de zone géographique, mais pas les deux, pour spécifier une zone à rechercher.

Une restriction géographique permet de spécifier la zone dans laquelle effectuer la recherche. Les résultats situés en dehors de la zone spécifiée ne sont pas renvoyés. L'exemple suivant utilise une restriction d'emplacement pour limiter la requête à une restriction d'emplacement circulaire avec un rayon de 5 000 mètres centré sur San Francisco:

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();

LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);

final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Amoeba")
            .setLocationRestriction(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Le biais de localisation sert de biais, c'est-à-dire que des résultats situés autour du lieu spécifié peuvent être renvoyés, y compris des résultats situés en dehors de celle-ci. L'exemple suivant modifie la requête précédente pour utiliser un biais de localisation:

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();

LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);

final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Amoeba")
            .setLocationBias(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Utiliser des types principaux

Utilisez le paramètre de types principaux pour limiter les résultats d'une requête à un certain type, comme indiqué dans les tableaux A et Tableau B. Vous pouvez spécifier un tableau contenant jusqu'à cinq valeurs. Si cette valeur est omise, tous les types sont renvoyés.

L'exemple suivant spécifie une chaîne de requête "Soccer" et utilise le paramètre principal de types pour limiter les résultats aux établissements de type "sporting_goods_store":

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();

final List<Place.Field> primaryTypes = Arrays.asList("sporting_goods_store");

LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);

final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Soccer")
            .setIncludedPrimaryTypes(primaryTypes)
            .setLocationBias(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Si vous omettez le paramètre de types principaux, les résultats peuvent inclure des établissements d'un type dont vous n'avez peut-être pas besoin, comme "athletic_field".

Utiliser l'origine

Lorsque vous incluez le paramètre origin dans la requête, spécifié en tant que coordonnées de latitude et de longitude, l'API inclut la distance en ligne droite entre le point de départ et la destination dans la réponse (accessible à l'aide de getDistanceMeters()). Cet exemple définit le point de départ sur le centre de San Francisco:

Places.initializeWithNewPlacesApiEnabled(context, apiKey);
final List<Field> placeFields = getPlaceFields();

LatLng center = new LatLng(37.7749, -122.4194);
CircularBounds circle = CircularBounds.newInstance(center, /* radius = */ 5000);

final FindAutocompletePredictionsRequest autocompletePlacesRequest =
    FindAutocompletePredictionsRequest.builder()
            .setQuery("Amoeba")
            .setOrigin(center)
            .setLocationRestriction(circle)
            .build());
placesClient.findAutocompletePredictions(autoCompletePlacesRequest)
    .addOnSuccessListener(
        (response) -> {
            List<AutocompletePrediction> predictions = response.getResult().getAutocompletePredictions();
          }
    ).addOnFailureListener(
        exception -> {
            Log.e(TAG, "some exception happened" + exception.getMessage());
        })
    );

Attributions

Vous pouvez utiliser la saisie semi-automatique (nouvelle version) même sans carte. Si vous affichez une carte, il doit s'agir d'une carte Google. Lorsque vous affichez les prédictions du service de saisie semi-automatique (nouveau) sans carte, vous devez inclure le logo Google affiché dans le champ ou les résultats de recherche. Pour en savoir plus, consultez Afficher le logo Google et les mentions légales.