Se usó la API de Cloud Translation para traducir esta página.

Autocompletar (nuevo)

Selecciona la plataforma: Android iOS JavaScript Servicio web

Desarrolladores del Espacio Económico Europeo (EEE)

Autocomplete (nuevo) devuelve predicciones de lugares en respuesta a una solicitud que incluye una cadena de búsqueda de texto y límites geográficos que controlan el área de búsqueda. Autocomplete puede buscar coincidencias para palabras completas y subcadenas de la entrada, y resolver nombres de lugares, direcciones y Plus Codes. Tu aplicación puede enviar consultas a medida que el usuario escribe para proporcionar predicciones de lugares y consultas en el momento.

Por ejemplo, puedes llamar a Autocomplete con una cadena que contenga una entrada parcial del usuario, "Pizza siciliana", con el área de búsqueda limitada a San Francisco, California. Luego, la respuesta contiene una lista de predicciones de lugares que coinciden con la cadena de búsqueda y el área de búsqueda, como el restaurante llamado "Sicilian Pizza Kitchen". Las predicciones de lugares que se devuelven están diseñadas para presentarse al usuario y ayudarlo a seleccionar el lugar deseado. Puedes realizar una solicitud de Place Details (nuevo) para obtener más información sobre cualquiera de las predicciones de lugares devueltas.

Puedes integrar la funcionalidad de Autocomplete (nuevo) en tu app de dos maneras principales:

Agrega el widget de Place Autocomplete: Proporciona una experiencia de autocompletar la búsqueda lista para usar a través de la clase PlaceAutocomplete que muestra predicciones a medida que el usuario escribe.
Obtén predicciones de lugares de forma programática: Llama a la API directamente para recuperar predicciones y mostrarlas en una interfaz de usuario personalizada.

Para proporcionar con mayor facilidad una experiencia de autocompletado de lugares coherente, puedes agregar el widget de Place Autocomplete a tu app. El widget proporciona una interfaz dedicada de pantalla completa que controla la entrada del usuario y muestra predicciones de lugares al usuario, a la vez que devuelve objetos AutocompletePrediction a la app. Luego, puedes realizar una solicitud de Place Details (nuevo) para obtener información adicional sobre cualquiera de las predicciones de lugares.

Al igual que cuando obtienes predicciones de lugares de forma programática, el widget de Place Autocomplete te permite usar tokens de sesión para agrupar las solicitudes de autocompletado en sesiones a los fines de facturación. Puedes pasar un token de sesión cuando crees la intención para el widget llamando a setAutocompleteSessionToken(). Si no proporcionas un token de sesión, el widget creará uno para ti, al que podrás acceder llamando a getSessionTokenFromIntent(). Para obtener más información sobre el uso de tokens de sesión, consulta Acerca de los tokens de sesión.

Para agregar el widget de Place Autocomplete a tu app, haz lo siguiente:

(Opcional) Define un token de sesión. Si no proporcionas un token de sesión, el widget creará uno por ti.
Define un objeto autocompleteIntent con los parámetros deseados y tu token de sesión.
Define un ActivityResultLauncher para StartActivityForResult. Este objeto Launcher controlará el resultado que se muestre de la actividad de autocompletar.
Controla el resultado en la devolución de llamada de ActivityResultLauncher. Esto implica extraer AutocompletePrediction y AutocompleteSessionToken (si no proporcionaste los tuyos), controlar errores y, de manera opcional, realizar una solicitud fetchPlace() para obtener detalles adicionales sobre un lugar.
Inicia el intent con placeAutocompleteActivityResultLauncher

En los siguientes ejemplos, se muestra cómo agregar el widget de Place Autocomplete con Kotlin y Java:

Kotlin

// Provide the API key that has enabled "Places API (New)" in the Google Cloud Console.
Places.initializeWithNewPlacesApiEnabled(/* Context= */ context, /* API Key= */ key)

// Optional, create a session token for Autocomplete request and the followup FetchPlace request.
val sessionToken: AutocompleteSessionToken = AutocompleteSessionToken.newInstance()

val autocompleteIntent: Intent =
    PlaceAutocomplete.createIntent(this) {
        // ... provide input params for origin, countries, types filter ...
        setAutocompleteSessionToken(sessionToken)
    }

val placeAutocompleteActivityResultLauncher: ActivityResultLauncher<Intent> =
    registerForActivityResult(ActivityResultContracts.StartActivityForResult()) { result: ActivityResult ->
        val intent = result.data
        if (intent != null && result.resultCode == PlaceAutocompleteActivity.RESULT_OK) {
            // get prediction object
            val prediction: AutocompletePrediction? =
                PlaceAutocomplete.getPredictionFromIntent(intent!!)

            // get session token
            val sessionToken: AutocompleteSessionToken? =
                PlaceAutocomplete.getSessionTokenFromIntent(intent!!)

            // create PlacesClient to make FetchPlace request (optional)
            val placesClient: PlacesClient = Places.createClient(this)
            val response =
                placesClient.awaitFetchPlace(prediction.placeId, Field.DISPLAY_NAME)
                {
                    sessionToken = sessionToken // optional
                }
        }
    }

// Launch Activity
placeAutocompleteActivityResultLauncher.launch(autocompleteIntent)

Java

// Provide the API key that has enabled "Places API (New)" in the Google Cloud Console.
Places.initializeWithNewPlacesApiEnabled(/* Context= */ context, /* API Key= */ key);

// Optional, create a session token for Autocomplete request and the followup FetchPlace request
AutocompleteSessionToken sessionToken = AutocompleteSessionToken.newInstance();

Intent autocompleteIntent =
    new PlaceAutocomplete.IntentBuilder()
        // ... set input params for origin, countries, types filter ...
        .setSessionToken(sessionToken) // optional
        .build(this);

ActivityResultLauncher<Intent> placeAutocompleteActivityResultLauncher =
    registerForActivityResult(
        new ActivityResultContracts.StartActivityForResult(),
        new ActivityResultCallback<ActivityResult>() {
            @Override
            public void onActivityResult(ActivityResult result) {
                Intent intent = result.getData();
                if (result.getResultCode() == PlaceAutocompleteActivity.RESULT_OK) {
                    // get prediction object
                    AutocompletePrediction prediction =
                        PlaceAutocomplete.getPredictionFromIntent(
                            Preconditions.checkNotNull(intent));

                    // get session token
                    AutocompleteSessionToken sessionToken =
                        PlaceAutocomplete.getSessionTokenFromIntent(
                            Preconditions.checkNotNull(intent));

                    // create PlacesClient to make FetchPlace request (optional)
                    PlacesClient placesClient = Places.createClient(this);
                    FetchPlaceRequest request =
                        FetchPlaceRequest.builder(prediction.getPlaceId(),
                            Arrays.asList(Field.DISPLAY_NAME))
                            .setSessionToken(sessionToken).build();
                    Task<FetchPlaceResponse> task = placesClient.fetchPlace(request);
                }
            }
        }
    );

// Launch Activity
placeAutocompleteActivityResultLauncher.launch(autocompleteIntent);

Obtén predicciones de lugares de forma programática

Tu app puede obtener una lista de nombres o direcciones de lugares predichos desde la API de Autocomplete llamando a PlacesClient.findAutocompletePredictions() y pasando un objeto FindAutocompletePredictionsRequest. En el siguiente ejemplo, se muestra una llamada completa a 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());
        })
    );

Nota: Para obtener más información sobre cómo inicializar PlacesClient, consulta Inicializa el cliente de la API de Places.

Respuestas de Autocomplete (nuevo)

La API devuelve un FindAutocompletePredictionsResponse en un Task. El objeto FindAutocompletePredictionsResponse contiene una lista de hasta cinco objetos AutocompletePrediction que representan lugares predichos. La lista puede estar vacía si no hay ningún lugar conocido que corresponda a la búsqueda y a los criterios de filtro.

Para cada lugar predicho, puedes llamar a los siguientes métodos para recuperar los detalles del lugar:

getFullText(CharacterStyle) devuelve el texto completo de la descripción de un lugar. Es una combinación del texto principal y el secundario. Ejemplo: "Torre Eiffel, Avenue Anatole France, París, Francia". Además, este método te permite destacar las secciones de la descripción que coinciden con la búsqueda con un estilo de tu elección, usando CharacterStyle. El parámetro CharacterStyle es opcional. Establécelo como nulo si no necesitas ningún destacado.
getPrimaryText(CharacterStyle) devuelve el texto principal que describe un lugar. Por lo general, es el nombre del lugar. Ejemplos: "Torre Eiffel" y "123 Pitt Street".
getSecondaryText(CharacterStyle) devuelve el texto secundario de la descripción de un lugar. Esto es útil, por ejemplo, como segunda línea cuando se muestran predicciones de autocompletado. Ejemplos: "Avenue Anatole France, Paris, France" y "Sydney, New South Wales".
getPlaceId() devuelve el ID del lugar predicho. Un ID de lugar es un identificador textual que identifica un lugar de forma única y que puedes usar para recuperar el objeto Place más adelante. Para obtener más información sobre los IDs de lugar en Autocomplete, consulta Place Details (nuevo). Para obtener información general sobre los IDs de lugar, consulta la descripción general de los IDs de lugar.
getTypes() muestra la lista de tipos de lugar asociados con este lugar.
getDistanceMeters() devuelve la distancia en línea recta en metros entre este lugar y el origen especificado en la solicitud.

Parámetros obligatorios

Consulta

Es la cadena de texto en la que se realizará la búsqueda. Especifica palabras completas y subcadenas, nombres de lugares, direcciones y Plus Codes. El servicio Autocomplete (nuevo) devuelve posibles coincidencias en función de esta cadena y ordena los resultados según su relevancia percibida.

Para configurar el parámetro de consulta, llama al método setQuery() cuando compiles el objeto FindAutocompletePredictionsRequest.

Parámetros opcionales

Tipos principales

Es una lista de hasta cinco valores de tipo de lugar de los tipos de la Tabla A o la Tabla B que se usan para filtrar los lugares que se muestran en la respuesta. Un lugar debe coincidir con uno de los valores de tipo principal especificados para incluirse en la respuesta.

Un lugar solo puede tener un tipo principal de los tipos de la Tabla A o la Tabla B asociados con él. Por ejemplo, el tipo principal podría ser "mexican_restaurant" o "steak_house".

La solicitud se rechaza con un error INVALID_REQUEST en los siguientes casos:
- Se especifican más de cinco tipos.
- Se especifican los tipos no reconocidos.
Para establecer el parámetro de tipos principales, llama al método setTypesFilter() cuando compiles el objeto FindAutocompletePredictionsRequest.
Países

Solo se incluyen los resultados de la lista de países especificados, que se indican como una lista de hasta 15 valores de dos caracteres del ccTLD ("dominio de nivel superior"). Si se omite, no se aplican restricciones a la respuesta. Por ejemplo, para limitar las regiones a Alemania y Francia, haz lo siguiente:

Si especificas locationRestriction y includedRegionCodes, los resultados se ubicarán en el área de intersección de ambos parámetros de configuración.

Para establecer el parámetro countries, llama al método setCountries() cuando compiles el objeto FindAutocompletePredictionsRequest.
Desplazamiento de entrada

Es el desplazamiento del carácter Unicode basado en cero que indica la posición del cursor en la búsqueda. La posición del cursor puede influir en las predicciones que se muestran. Si está vacío, el valor predeterminado es la longitud de la consulta.

Para establecer el parámetro de desplazamiento de entrada, llama al método setInputOffset() cuando compiles el objeto FindAutocompletePredictionsRequest.
Sesgo o restricción de ubicación

Puedes especificar una restricción o una preferencia de ubicación, pero no ambas, para definir el área de búsqueda. Piensa en la restricción de ubicación como la especificación de la región dentro de la cual deben estar los resultados, y en el sesgo de ubicación como la especificación de la región cerca de la cual deben estar los resultados. La diferencia clave es que, con el sesgo de ubicación, es posible que se sigan devolviendo resultados fuera de la región especificada.
- Sesgo de ubicación
  
  Especifica un área para la búsqueda. Esta ubicación sirve como sesgo, no como restricción, por lo que es posible que se devuelvan resultados fuera del área especificada.
  
  Para establecer el parámetro de sesgo de ubicación, llama al método setLocationBias() cuando compiles el objeto FindAutocompletePredictionsRequest.
- Restricción de ubicación
  
  Especifica un área para la búsqueda. No se muestran los resultados fuera del área especificada.
  
  Para establecer el parámetro de restricción de ubicación, llama al método setLocationRestriction() cuando compiles el objeto FindAutocompletePredictionsRequest.
Especifica la región de restricción o sesgo de ubicación como un viewport rectangular o como un círculo.
- Un círculo se define por un punto central y un radio en metros. El radio debe estar entre 0.0 y 50000.0, ambos incluidos. El valor predeterminado es 0.0. En el caso de la restricción de ubicación, debes establecer el radio en un valor mayor que 0.0. De lo contrario, la solicitud no devolverá ningún resultado.
- Un rectángulo es un viewport de latitud y longitud, representado como dos puntos low y high opuestos diagonalmente. Un viewport se considera una región cerrada, lo que significa que incluye su límite. Los límites de latitud deben estar entre -90 y 90 grados inclusive, y los límites de longitud deben estar entre -180 y 180 grados inclusive:
  
  Nota: Los tipos de sesgo admitidos varían según la versión del SDK que uses. CircularBounds solo está disponible en Autocomplete (nuevo).
  - Si low = high, el viewport consta de ese único punto.
  - Si low.longitude > high.longitude, el rango de longitud se invierte (el viewport cruza la línea de longitud de 180 grados).
  - Si low.longitude = -180 grados y high.longitude = 180 grados, la ventana gráfica incluye todas las longitudes.
  - Si low.longitude = 180 grados y high.longitude = -180 grados, el rango de longitud está vacío.
  Se deben completar low y high, y el cuadro representado no puede estar vacío. Un viewport vacío genera un error.
Origen

Es el punto de origen desde el que se calcula la distancia en línea recta hasta el destino (se accede con getDistanceMeters()). Si se omite este valor, no se devolverá la distancia en línea recta. Se deben especificar como coordenadas de latitud y longitud:

Para establecer el parámetro de origen, llama al método setOrigin() cuando compiles el objeto FindAutocompletePredictionsRequest.
Código de la región

Es el código de región que se usa para dar formato a la respuesta, incluido el formato de la dirección, especificado como un valor de dos caracteres del ccTLD ("dominio de nivel superior"). La mayoría de los códigos de ccTLD son idénticos a los códigos ISO 3166-1, con algunas excepciones notables. Por ejemplo, el ccTLD del Reino Unido es "uk" (.co.uk), mientras que su código ISO 3166-1 es "gb" (técnicamente para la entidad de "El Reino Unido de Gran Bretaña e Irlanda del Norte").

Nota: El código de región está diseñado para representar la región desde la que se origina la solicitud, no necesariamente la región objetivo de la búsqueda.

Si especificas un código de región no válido, la API devuelve un error INVALID_ARGUMENT. El parámetro puede afectar los resultados según la legislación aplicable.

Para configurar el parámetro del código de región, llama al método setRegionCode() cuando compiles el objeto FindAutocompletePredictionsRequest.
Token de sesión

Los tokens de sesión son cadenas generadas por el usuario que hacen un seguimiento de las llamadas a Autocomplete (nuevo), tanto las que se realizan a través del widget como las programáticas, como "sesiones". Autocomplete usa tokens de sesión para agrupar las fases de consulta y selección de la búsqueda con autocompletado de un usuario en una sesión discreta para realizar la facturación correspondiente. La sesión comienza cuando el usuario comienza a escribir una búsqueda y termina cuando selecciona un lugar. Cada sesión puede tener varias búsquedas, seguidas de una selección de lugar. Una vez que finaliza la sesión, el token deja de ser válido. Tu app debe generar un token nuevo para cada sesión. Recomendamos usar tokens de sesión para todas las sesiones de autocompletado programáticas (cuando incorporas un fragmento o inicias el autocompletado con una intención, la API se encarga de esto automáticamente).

El autocompletado usa un AutocompleteSessionToken para identificar cada sesión. Tu app debe pasar un token de sesión nuevo al comenzar cada sesión nueva y, luego, pasar ese mismo token, junto con un ID de lugar, en la llamada posterior a fetchPlace() para recuperar los detalles del lugar que seleccionó el usuario.

Para configurar el parámetro del token de sesión, llama al método setSessionToken() cuando compiles el objeto FindAutocompletePredictionsRequest.

Para obtener más información, consulta Tokens de sesión.

Ejemplos de Autocomplete (nuevo)

Usa la restricción y la preferencia de ubicación

De forma predeterminada, Autocomplete (nuevo) usa la adaptación de IP para controlar el área de búsqueda. Con el sesgo de IP, la API usa la dirección IP del dispositivo para sesgar los resultados. De manera opcional, puedes usar la restricción de ubicación o el sesgo de ubicación, pero no ambos, para especificar un área de búsqueda.

La restricción de ubicación especifica el área de búsqueda. No se devuelven resultados fuera del área especificada. En el siguiente ejemplo, se usa la restricción de ubicación para limitar la solicitud a una restricción de ubicación circular con un radio de 5,000 metros centrada en 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());
        })
    );

Con la personalización según la ubicación, esta sirve como sesgo, lo que significa que se pueden mostrar resultados alrededor de la ubicación especificada, incluidos los que se encuentran fuera del área especificada. En el siguiente ejemplo, se cambia la solicitud anterior para usar la preferencia de ubicación:

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());
        })
    );

Usa tipos primarios

Usa el parámetro primary types para restringir los resultados de una solicitud a un tipo determinado, como se indica en la Tabla A y la Tabla B. Puedes especificar un array de hasta cinco valores. Si se omite, se devuelven todos los tipos.

En el siguiente ejemplo, se especifica una cadena de búsqueda de "Fútbol" y se usa el parámetro primarytypes para restringir los resultados a establecimientos del tipo "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 omites el parámetro de tipos principales, los resultados pueden incluir establecimientos de un tipo que tal vez no desees, como "athletic_field".

Usar origen

Cuando incluyes el parámetro origin en la solicitud, especificado como coordenadas de latitud y longitud, la API incluye la distancia en línea recta desde el origen hasta el destino en la respuesta (se accede a ella con getDistanceMeters()). Este ejemplo establece el origen en el centro 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());
        })
    );

Atribuciones

Puedes usar Autocomplete (nuevo) incluso sin un mapa. Si muestras un mapa, debe ser de Google Maps. Cuando muestres predicciones del servicio Autocomplete (nuevo) sin un mapa, debes incluir el logotipo de Google intercalado con el campo o los resultados de la búsqueda. Para obtener más información, consulta Cómo mostrar el logotipo y las atribuciones de Google.

Autocompletar (nuevo) Organiza tus páginas con colecciones Guarda y categoriza el contenido según tus preferencias.

Agrega el widget de Place Autocomplete

Kotlin

Java

Obtén predicciones de lugares de forma programática

Respuestas de Autocomplete (nuevo)

Parámetros obligatorios

Consulta

Parámetros opcionales

Tipos principales

Países

Desplazamiento de entrada

Sesgo o restricción de ubicación

Sesgo de ubicación

Restricción de ubicación

Origen

Código de la región

Token de sesión