Introducción
Autocomplete (nuevo) es un servicio web que devuelve predicciones de lugares y predicciones de búsquedas en respuesta a una solicitud HTTP. En la solicitud, especifica una cadena de búsqueda de texto y límites geográficos que controlen el área de búsqueda.
Autocomplete (nuevo) puede buscar coincidencias para palabras completas y subcadenas de la entrada, y resolver nombres de lugares, direcciones y Plus Codes. Así, las aplicaciones pueden enviar búsquedas a medida que el usuario escribe para proporcionar predicciones de lugares y búsquedas en el momento.
La respuesta de Autocomplete (nuevo) puede contener dos tipos de predicciones:
- Predicciones de lugares: Lugares, como empresas, direcciones y lugares de interés, según la cadena de texto de entrada y el área de búsqueda especificadas. Las predicciones de lugares se muestran de forma predeterminada.
- Predicciones de búsquedas: Cadenas de búsqueda que coinciden con la cadena de texto de entrada y el área de búsqueda. Las predicciones de búsqueda no se muestran de forma predeterminada. Usa el parámetro de solicitud
includeQueryPredictionspara agregar predicciones de búsqueda a la respuesta.
Por ejemplo, llamas a Autocomplete (nuevo) con una cadena que contiene una entrada parcial del usuario, "Pizza siciliana", y el área de búsqueda se limita 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", junto con detalles sobre el lugar.
Las predicciones de lugares que se muestran 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.
La respuesta también puede contener una lista de predicciones de búsqueda que coinciden con la cadena de búsqueda y el área de búsqueda, como "Pizza y pasta siciliana". Cada predicción de búsqueda en la respuesta incluye el campo text que contiene una cadena de búsqueda de texto recomendada. Usa esa cadena como entrada para Text Search (nuevo) y realiza una búsqueda más detallada.
El Explorador de APIs te permite realizar solicitudes en vivo para que te familiarices con la API y sus opciones:
Solicitudes a Autocomplete (nuevo)
Una solicitud de Autocomplete (nuevo) es una solicitud HTTP POST a una URL con el siguiente formato:
https://places.googleapis.com/v1/places:autocomplete
Pasa todos los parámetros en el cuerpo de la solicitud JSON o en los encabezados como parte de la solicitud POST. Por ejemplo:
curl -X POST -d '{
"input": "pizza",
"locationBias": {
"circle": {
"center": {
"latitude": 37.7937,
"longitude": -122.3965
},
"radius": 500.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
Parámetros admitidos
Parámetro |
Descripción |
|---|---|
Cadena de texto en la que se realizará la búsqueda (palabras completas, subcadenas, nombres de lugares, direcciones y Plus Codes). |
|
|
Lista separada por comas que especifica qué campos se deben devolver en la respuesta. |
Restringe los resultados a los lugares que coinciden con uno de los cinco tipos principales especificados como máximo. |
|
Si es verdadero, incluye las empresas sin una ubicación física (empresas de servicio en el área). La configuración predeterminada es "false". |
|
Si es verdadero, incluye predicciones de lugares y de búsquedas en la respuesta. La configuración predeterminada es "false". |
|
Es un array de hasta 15 códigos de país de dos caracteres para restringir los resultados. |
|
Es el desplazamiento de caracteres Unicode basado en cero de la posición del cursor dentro de la cadena de entrada, lo que influye en las predicciones. El valor predeterminado es la longitud de la entrada. |
|
Idioma preferido (código IETF BCP-47) para los resultados. El valor predeterminado es el encabezado Accept-Language o "en". |
|
Especifica un área (círculo o rectángulo) para sesgar los resultados de la búsqueda, lo que permite que se muestren resultados fuera del área. No se puede usar con locationRestriction. |
|
Especifica un área (círculo o rectángulo) para restringir los resultados de la búsqueda. Se excluyen los resultados fuera de esta área. No se puede usar con locationBias. |
|
Es el punto de origen (latitud y longitud) que se usa para calcular la distancia en línea recta (distanceMeters) a los destinos previstos. |
|
Código de región que se usa para dar formato a la respuesta y sesgar las sugerencias (p.ej., 'uk', 'fr'). |
|
Es una cadena generada por el usuario para agrupar las llamadas a Autocomplete en una sesión a los fines de facturación. |
Acerca de la respuesta
Autocomplete (nuevo) devuelve un objeto JSON como respuesta. En la respuesta, figura lo siguiente:
- El array
suggestionscontiene todos los lugares y las búsquedas predichos en orden según su relevancia percibida. Cada lugar se representa con un campoplacePredictiony cada búsqueda con un campoqueryPrediction. - Un campo
placePredictioncontiene información detallada sobre una sola predicción de lugar, incluido el ID de lugar y la descripción de texto. - Un campo
queryPredictioncontiene información detallada sobre una sola predicción de búsqueda.
El objeto JSON completo tiene el siguiente formato:
{
"suggestions": [
{
"placePrediction": {
"place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko",
"placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko",
"text": {
"text": "Amoeba Music, Haight Street, San Francisco, CA, USA",
"matches": [
{
"endOffset": 6
}]
},
...
},
{
"queryPrediction": {
"text": {
"text": "Amoeba Music",
"matches": [
{
"endOffset": 6
}]
},
...
}
...]
}Parámetros obligatorios
-
entrada
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.
Parámetros opcionales
-
FieldMask
Especifica la lista de campos que se devolverán en la respuesta creando una máscara de campo de respuesta. Pasa la máscara de campo de respuesta al método usando el encabezado HTTP
X-Goog-FieldMask.Especifica una lista de campos de sugerencia separados por comas que se devolverán. Por ejemplo, para recuperar
suggestions.placePrediction.text.textysuggestions.queryPrediction.text.textde la sugerencia.X-Goog-FieldMask: suggestions.placePrediction.text.text,suggestions.queryPrediction.text.text
Usa
*para recuperar todos los campos.X-Goog-FieldMask: *
-
includedPrimaryTypes
Un lugar solo puede tener un tipo principal único de los tipos que se enumeran en la Tabla A o la Tabla B. Por ejemplo, el tipo principal podría ser
"mexican_restaurant"o"steak_house".De forma predeterminada, la API devuelve todos los lugares según el parámetro
input, independientemente del valor del tipo principal asociado al lugar. Restringe los resultados a un determinado tipo principal o tipos principales pasando el parámetroincludedPrimaryTypes.Usa este parámetro para especificar hasta cinco valores de tipo de la Tabla A o la Tabla B. Un lugar debe coincidir con uno de los valores de tipo principal especificados para incluirse en la respuesta.
Este parámetro también puede incluir, en su lugar, uno de los valores
(regions)o(cities). Son los filtros de recopilación de tipo(regions)para áreas o divisiones, como vecindarios y códigos postales. La colección de tipos(cities)filtra los lugares que Google identifica como ciudades.La solicitud se rechaza con un error
INVALID_REQUESTen los siguientes casos:- Se especifican más de cinco tipos.
- Se especifica cualquier tipo además de
(cities)o(regions). - Se especifican los tipos no reconocidos.
-
includePureServiceAreaBusinesses
Si se configura como
true, la respuesta incluye las empresas que visitan a los clientes o les entregan sus productos directamente, pero que no tienen una ubicación comercial física. Si se configura comofalse, la API solo devuelve las empresas con una ubicación física. -
includeQueryPredictions
Si es
true, la respuesta incluye predicciones de lugares y de búsquedas. El valor predeterminado esfalse, lo que significa que la respuesta solo incluye predicciones de lugares. -
includedRegionCodes
Solo incluye resultados de la lista de regiones especificadas, que se indican como un array de hasta 15 valores de ccTLD ("dominio de nivel superior") de dos caracteres. Si se omite, no se aplican restricciones a la respuesta. Por ejemplo, para limitar las regiones a Alemania y Francia, haz lo siguiente:
"includedRegionCodes": ["de", "fr"]
Si especificas
locationRestrictionyincludedRegionCodes, los resultados se ubicarán en el área de intersección de ambos parámetros de configuración. -
inputOffset
Desplazamiento del carácter Unicode basado en cero que indica la posición del cursor en
input. La posición del cursor puede influir en las predicciones que se muestran. Si está vacío, el valor predeterminado es la longitud deinput. -
languageCode
Es el idioma preferido en el que se devuelven los resultados. Los resultados pueden estar en varios idiomas si el idioma que se usa en
inputes diferente del valor especificado porlanguageCodeo si el lugar que se muestra no tiene una traducción del idioma local alanguageCode.- Debes usar códigos de idioma IETF BCP-47 para especificar el idioma preferido.
-
Si no se proporciona
languageCode, la API usa el valor especificado en el encabezadoAccept-Language. Si no se especifica ninguno, el valor predeterminado esen. Si especificas un código de idioma no válido, la API devuelve un errorINVALID_ARGUMENT. - El idioma preferido tiene una pequeña influencia en el conjunto de resultados que la API elige devolver y en el orden en que se devuelven. Esto también afecta la capacidad de la API para corregir errores ortográficos.
-
La API intenta proporcionar una dirección de la calle que sea legible para el usuario y la población local, y, al mismo tiempo, reflejar la entrada del usuario. Las predicciones de lugares tienen un formato diferente según la entrada del usuario en cada solicitud.
-
Primero se eligen los términos coincidentes en el parámetro
input, con nombres alineados con la preferencia de idioma indicada por el parámetrolanguageCodecuando está disponible. De lo contrario, se usan los nombres que mejor coinciden con la entrada del usuario. -
Las direcciones se formatean en el idioma local, en una escritura legible para el usuario
cuando es posible, solo después de que se seleccionan los términos coincidentes para que coincidan con los términos del
parámetro
input. -
Todas las demás direcciones se devuelven en el idioma preferido, después de que se eligen los términos coincidentes para que coincidan con los términos del parámetro
input. Si no hay un nombre disponible en el idioma preferido, la API usa la coincidencia más cercana.
-
Primero se eligen los términos coincidentes en el parámetro
locationBias o locationRestriction
Puedes especificar
locationBiasolocationRestriction, pero no ambos, para definir el área de búsqueda. Piensa enlocationRestrictioncomo la especificación de la región dentro de la cual deben estar los resultados y enlocationBiascomo la especificación de la región cerca de la cual deben estar los resultados, pero pueden estar fuera del área.locationBias
Especifica un área para la búsqueda. Esta ubicación sirve como sesgo, lo que significa que se pueden devolver resultados alrededor de la ubicación especificada, incluidos los resultados fuera del área especificada.
locationRestriction
Especifica un área para la búsqueda. No se muestran los resultados fuera del área especificada.
Especifica la región
locationBiasolocationRestrictioncomo 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. Para
locationRestriction, debes establecer el radio en un valor mayor que 0.0. De lo contrario, la solicitud no devolverá ningún resultado.Por ejemplo:
"locationBias": { "circle": { "center": { "latitude": 37.7937, "longitude": -122.3965 }, "radius": 500.0 } }
Un rectángulo es una ventana gráfica de latitud y longitud, representada como dos puntos
lowy puntos altos diagonalmente opuestos. 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:- 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 yhigh.longitude= 180 grados, la ventana gráfica incluye todas las longitudes. - Si
low.longitude= 180 grados yhigh.longitude= -180 grados, el rango de longitud está vacío.
Se deben completar
lowyhigh, y el cuadro representado no puede estar vacío. Un viewport vacío genera un error.Por ejemplo, este viewport encierra completamente la ciudad de Nueva York:
"locationBias": { "rectangle": { "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } } }
- Si
-
origin
Es el punto de origen desde el que se calcula la distancia en línea recta hasta el destino (se muestra como
distanceMeters). Si se omite este valor, no se mostrará la distancia en línea recta. Se deben especificar como coordenadas de latitud y longitud:"origin": { "latitude": 40.477398, "longitude": -74.259087 }
-
regionCode
Es el código de región que se usa para dar formato a la respuesta, 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").
Las sugerencias también se sesgan según los códigos de región. Google recomienda configurar
regionCodesegún la preferencia regional del usuario.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. -
sessionToken
Los tokens de sesión son cadenas generadas por el usuario que hacen un seguimiento de las llamadas a Autocomplete (nuevo) como "sesiones". Autocomplete (nuevo) usa tokens de sesión para agrupar las fases de consulta y selección de una búsqueda con autocompletado del usuario en una sesión discreta para fines de facturación. Para obtener más información, consulta Tokens de sesión.
Elige parámetros para sesgar los resultados
Los parámetros de Autocompletar (nuevo) pueden influir en los resultados de la búsqueda de diferentes maneras. En la siguiente tabla, se proporcionan recomendaciones para el uso de parámetros según el resultado deseado.| Parámetro | Recomendación de uso |
|---|---|
regionCode |
Se establece según la preferencia regional del usuario. |
includedRegionCodes |
Se establece para limitar los resultados a la lista de regiones especificadas. |
locationBias |
Se usa cuando se prefieren los resultados en una región o cerca de ella. Si corresponde, define la región como el viewport del mapa que está viendo el usuario. |
locationRestriction |
Usa solo cuando no se deban mostrar resultados fuera de una región. |
origin |
Se usa cuando se pretende una distancia en línea recta para cada predicción. |
Ejemplos de Autocomplete (nuevo)
Cómo restringir la búsqueda a un área con locationRestriction
locationRestriction especifica el área de búsqueda. No se devuelven resultados fuera del área especificada. En el siguiente ejemplo, se usa locationRestriction para limitar la solicitud a un círculo de 5,000 metros de radio centrado en San Francisco:
curl -X POST -d '{
"input": "Art museum",
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 5000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
Todos los resultados de las áreas especificadas se encuentran en el array suggestions:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJkQQVTZqAhYARHxPt2iJkm1Q", "placeId": "ChIJkQQVTZqAhYARHxPt2iJkm1Q", "text": { "text": "Asian Art Museum, Larkin Street, San Francisco, CA, USA", "matches": [ { "startOffset": 6, "endOffset": 16 } ] }, "structuredFormat": { "mainText": { "text": "Asian Art Museum", "matches": [ { "startOffset": 6, "endOffset": 16 } ] }, "secondaryText": { "text": "Larkin Street, San Francisco, CA, USA" } }, "types": [ "establishment", "museum", "point_of_interest" ] } }, { "placePrediction": { "place": "places/ChIJI7NivpmAhYARSuRPlbbn_2w", "placeId": "ChIJI7NivpmAhYARSuRPlbbn_2w", "text": { "text": "de Young Museum, Hagiwara Tea Garden Drive, San Francisco, CA, USA", "matches": [ { "endOffset": 15 } ] }, "structuredFormat": { "mainText": { "text": "de Young Museum", "matches": [ { "endOffset": 15 } ] }, "secondaryText": { "text": "Hagiwara Tea Garden Drive, San Francisco, CA, USA" } }, "types": [ "establishment", "point_of_interest", "tourist_attraction", "museum" ] } }, /.../ ] }
También puedes usar locationRestriction para restringir las búsquedas a una ventana gráfica rectangular. En el siguiente ejemplo, se limita la solicitud al centro de San Francisco:
curl -X POST -d '{
"input": "Art museum",
"locationRestriction": {
"rectangle": {
"low": {
"latitude": 37.7751,
"longitude": -122.4219
},
"high": {
"latitude": 37.7955,
"longitude": -122.3937
}
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
Los resultados se encuentran en el array suggestions:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJkQQVTZqAhYARHxPt2iJkm1Q", "placeId": "ChIJkQQVTZqAhYARHxPt2iJkm1Q", "text": { "text": "Asian Art Museum, Larkin Street, San Francisco, CA, USA", "matches": [ { "startOffset": 6, "endOffset": 16 } ] }, "structuredFormat": { "mainText": { "text": "Asian Art Museum", "matches": [ { "startOffset": 6, "endOffset": 16 } ] }, "secondaryText": { "text": "Larkin Street, San Francisco, CA, USA" } }, "types": [ "point_of_interest", "museum", "establishment" ] } }, { "placePrediction": { "place": "places/ChIJyQNK-4SAhYARO2DZaJleWRc", "placeId": "ChIJyQNK-4SAhYARO2DZaJleWRc", "text": { "text": "International Art Museum of America, Market Street, San Francisco, CA, USA", "matches": [ { "startOffset": 14, "endOffset": 24 } ] }, "structuredFormat": { "mainText": { "text": "International Art Museum of America", "matches": [ { "startOffset": 14, "endOffset": 24 } ] }, "secondaryText": { "text": "Market Street, San Francisco, CA, USA" } }, "types": [ "museum", "point_of_interest", "tourist_attraction", "art_gallery", "establishment" ] } } ] }
Cómo personalizar la búsqueda para un área con locationBias
Con locationBias, la ubicación sirve como sesgo, lo que significa que se pueden mostrar resultados alrededor de la ubicación especificada, incluidos los resultados fuera del área especificada. En el siguiente ejemplo, sesgas la solicitud hacia el centro de San Francisco:
curl -X POST -d '{
"input": "Amoeba",
"locationBias": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 5000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
Ahora los resultados contienen muchos más elementos, incluidos los que se encuentran fuera del radio de 5,000 metros:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko", "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko", "text": { "text": "Amoeba Music, Haight Street, San Francisco, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Haight Street, San Francisco, CA, USA" } }, "types": [ "electronics_store", "point_of_interest", "store", "establishment", "home_goods_store" ] } }, { "placePrediction": { "place": "places/ChIJr7uwwy58hYARBY-e7-QVwqw", "placeId": "ChIJr7uwwy58hYARBY-e7-QVwqw", "text": { "text": "Amoeba Music, Telegraph Avenue, Berkeley, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Telegraph Avenue, Berkeley, CA, USA" } }, "types": [ "electronics_store", "point_of_interest", "establishment", "home_goods_store", "store" ] } }, ... ] }
También puedes usar locationBias para sesgar las búsquedas hacia una ventana gráfica rectangular. En el siguiente ejemplo, se limita la solicitud al centro de San Francisco:
curl -X POST -d '{
"input": "Amoeba",
"locationBias": {
"rectangle": {
"low": {
"latitude": 37.7751,
"longitude": -122.4219
},
"high": {
"latitude": 37.7955,
"longitude": -122.3937
}
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
Aunque en la respuesta aparecen los resultados de la búsqueda dentro del viewport rectangular, algunos resultados están fuera de los límites definidos debido a la personalización. Los resultados también se incluyen en el array suggestions:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko", "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko", "text": { "text": "Amoeba Music, Haight Street, San Francisco, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Haight Street, San Francisco, CA, USA" } }, "types": [ "point_of_interest", "store", "establishment" ] } }, { "placePrediction": { "place": "places/ChIJr7uwwy58hYARBY-e7-QVwqw", "placeId": "ChIJr7uwwy58hYARBY-e7-QVwqw", "text": { "text": "Amoeba Music, Telegraph Avenue, Berkeley, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Telegraph Avenue, Berkeley, CA, USA" } }, "types": [ "point_of_interest", "store", "establishment" ] } }, { "placePrediction": { "place": "places/ChIJRdmfADq_woARYaVhnfQSUTI", "placeId": "ChIJRdmfADq_woARYaVhnfQSUTI", "text": { "text": "Amoeba Music, Hollywood Boulevard, Los Angeles, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Hollywood Boulevard, Los Angeles, CA, USA" } }, "types": [ "point_of_interest", "store", "establishment" ] } }, /.../ ] }
Usa includedPrimaryTypes
Usa el parámetro includedPrimaryTypes para especificar hasta cinco valores de tipo de la Tabla A, la Tabla B, o solo (regions) o solo (cities). Un lugar debe coincidir con uno de los valores de tipo principal especificados para incluirse en la respuesta.
En el siguiente ejemplo, se especifica una cadena input de "Fútbol" y se usa el parámetro includedPrimaryTypes para restringir los resultados a establecimientos del tipo "sporting_goods_store":
curl -X POST -d '{
"input": "Soccer",
"includedPrimaryTypes": ["sporting_goods_store"],
"locationBias": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 500.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
Si omites el parámetro includedPrimaryTypes, los resultados pueden incluir establecimientos de un tipo que no deseas, como "athletic_field".
Solicita predicciones de consultas
Las predicciones de búsqueda no se muestran de forma predeterminada. Usa el parámetro de solicitud includeQueryPredictions para agregar predicciones de búsqueda a la respuesta. Por ejemplo:
curl -X POST -d '{
"input": "Amoeba",
"includeQueryPredictions": true,
"locationBias": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 5000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
El array suggestions ahora contiene predicciones de lugares y de búsquedas, como se muestra arriba en Acerca de la respuesta. Cada predicción de búsqueda incluye el campo text que contiene una cadena de búsqueda de texto recomendada. Puedes realizar una solicitud de Text Search (nuevo) para obtener más información sobre cualquiera de las predicciones de búsqueda devueltas.
Usar origen
En este ejemplo, incluye origin en la solicitud como coordenadas de latitud y longitud. Cuando incluyes origin, Autocomplete (nuevo) incluye el campo distanceMeters en la respuesta, que contiene la distancia en línea recta desde origin hasta el destino. En este ejemplo, se establece el origen en el centro de San Francisco:
curl -X POST -d '{
"input": "Amoeba",
"origin": {
"latitude": 37.7749,
"longitude": -122.4194
},
"locationRestriction": {
"circle": {
"center": {
"latitude": 37.7749,
"longitude": -122.4194
},
"radius": 5000.0
}
}
}' \
-H 'Content-Type: application/json' -H "X-Goog-Api-Key: API_KEY" \
https://places.googleapis.com/v1/places:autocomplete
La respuesta ahora incluye distanceMeters:
{ "suggestions": [ { "placePrediction": { "place": "places/ChIJ5YQQf1GHhYARPKG7WLIaOko", "placeId": "ChIJ5YQQf1GHhYARPKG7WLIaOko", "text": { "text": "Amoeba Music, Haight Street, San Francisco, CA, USA", "matches": [ { "endOffset": 6 } ] }, "structuredFormat": { "mainText": { "text": "Amoeba Music", "matches": [ { "endOffset": 6 } ] }, "secondaryText": { "text": "Haight Street, San Francisco, CA, USA" } }, "types": [ "home_goods_store", "establishment", "point_of_interest", "store", "electronics_store" ], "distanceMeters": 3012 } } ] }
Falta la distancia en la respuesta
En algunos casos, falta distanceMeters en el cuerpo de la respuesta, incluso cuando origin se incluye en la solicitud. Esto puede suceder en las siguientes situaciones:
distanceMetersno se incluye en las predicciones deroute.distanceMetersno se incluye cuando su valor es0, que es el caso de las predicciones que se encuentran a menos de 1 metro de la ubicaciónoriginproporcionada.
Las bibliotecas cliente que intenten leer el campo distanceMeters de un objeto analizado devolverán un campo con el valor 0.
Para evitar engañar a los usuarios, no muestres una distancia de cero.
Optimización de Autocomplete (nuevo)
En esta sección, se describen algunas prácticas recomendadas que te ayudarán a aprovechar al máximo el servicio Autocomplete (nuevo).
A continuación, se indican algunos lineamientos generales:
- La forma más rápida de desarrollar una interfaz de usuario funcional es usar el widget de Autocomplete (nuevo) de la API de Maps JavaScript, el widget de Autocomplete (nuevo) del SDK de Places para Android o el widget de Autocomplete (nuevo) del SDK de Places para iOS.
- Comprende los campos de datos esenciales de Autocomplete (nuevo) desde el principio.
- Los campos de restricción y personalización de la ubicación son opcionales, pero pueden afectar significativamente el rendimiento del autocompletado.
- Usa el procedimiento de manejo de errores para asegurarte de que tu app administre el problema de forma adecuada si la API muestra un error.
- Asegúrate de que tu app gestione correctamente los problemas cuando no haya selección y ofrezca a los usuarios una manera de continuar.
Prácticas recomendadas para la optimización de los costos
Optimización básica de los costos
Para optimizar el costo de usar el servicio Autocomplete (nuevo), usa máscaras de campo en los widgets de Place Details (nuevo) y Autocomplete (nuevo) para mostrar solo los campos de datos de Autocomplete (nuevo) que necesitas.
Optimización avanzada de los costos
Considera utilizar la implementación programática de Autocomplete (nuevo) para acceder a los SKU: precios de solicitudes de Autocomplete y solicitar resultados de la API de Geocoding sobre el lugar seleccionado en lugar de utilizar Place Details (nuevo). Los precios por solicitud asociados con la API de Geocoding son más rentables que los precios por sesión (basados en sesión) si se cumplen las siguientes condiciones:
- Si solo necesitas las coordenadas de latitud y longitud, o la dirección del lugar seleccionado por el usuario, la API de Geocoding proporciona esta información de manera más fácil que una llamada a Place Details (nuevo).
- Si los usuarios seleccionan una predicción de autocompletar con un promedio de cuatro solicitudes o menos, el precio por solicitud puede ser más rentable que el precio por sesión.
¿Tu aplicación requiere algún dato diferente de la dirección y las coordenadas de latitud o longitud de la predicción seleccionada?
Sí, necesita más detalles
Usa Autocomplete basado en sesiones (nuevo) con Place Details (nuevo).
Dado que tu aplicación requiere Place Details (nuevo), como el nombre del lugar, el estado comercial o el horario de atención, tu implementación de Autocomplete (nuevo) debe usar un token de sesión
(de forma programática o integrado en los widgets de
JavaScript,
Android
o iOS)
por sesión, además de los SKU de Places aplicables,
según los campos de datos de lugares que solicites.1
Implementación de widgets
La administración de sesiones está integrada automáticamente en los widgets de
JavaScript,
Android,
o iOS. Esto incluye las solicitudes de Autocomplete (nuevo) y Place Details (nuevo) en la predicción seleccionada. Asegúrate de especificar el parámetro fields para asegurarte de solicitar únicamente los campos de datos de Autocomplete (nuevo) que necesitas.
Implementación programática
Usa un
token de sesión
con tus solicitudes de Autocomplete (nuevo). Cuando solicites Place Details (nuevo) sobre la predicción seleccionada, incluye los siguientes parámetros:
- El ID de lugar de la respuesta de Autocomplete (nuevo)
- Es el token de sesión que se usó en la solicitud de Autocomplete (nuevo).
- El parámetro
fieldsque especifica los campos de datos de Autocomplete (nuevo) que necesitas
No, solo requiere la dirección y la ubicación
La API de Geocoding podría ser una opción más rentable que Place Details (nuevo) para tu aplicación, según el rendimiento de tu uso de Autocomplete (nuevo). La eficiencia de Autocomplete (nuevo) de cada aplicación varía según las búsquedas que ingresan los usuarios, dónde se usa la aplicación y si se siguen las prácticas recomendadas de optimización del rendimiento.
Para responder la siguiente pregunta, analiza cuántos caracteres escribe un usuario en promedio antes de seleccionar una predicción de Autocomplete (nuevo) en tu aplicación.
¿Tus usuarios seleccionan, en promedio, una predicción de Autocomplete (nuevo) cada cuatro solicitudes o menos?
Sí
Implementa Autocomplete (nuevo) de manera programática sin tokens de sesión y llama a la API de Geocoding en la predicción de lugar seleccionada.
La API de Geocoding proporciona direcciones y coordenadas de latitud y longitud.
Realizar cuatro solicitudes de Autocomplete más una llamada a la API de Geocoding sobre la predicción de lugar seleccionada cuesta menos que el costo por sesión de Autocomplete (nuevo).1
Considera aplicar las prácticas recomendadas de rendimiento para ayudar a los usuarios a obtener la predicción que buscan con menos caracteres.
No
Usa Autocomplete basado en sesiones (nuevo) con Place Details (nuevo).
Dado que la cantidad promedio de solicitudes que esperas realizar antes de que un usuario seleccione una
predicción de Autocomplete (nuevo) supera el costo del precio por sesión, tu implementación
de Autocomplete (nuevo) debe usar un token de sesión para las solicitudes de Autocomplete (nuevo)
y la solicitud asociada de Place Details (nuevo)
por sesión.
1
Implementación de widgets
La administración de sesiones está integrada automáticamente en los widgets de
JavaScript,
Android,
o iOS. Esto incluye las solicitudes de Autocomplete (nuevo) y la solicitud de Place Details (nuevo) en la predicción seleccionada. Asegúrate de especificar el parámetro fields
para asegurarte de solicitar únicamente los campos que necesitas.
Implementación programática
Usa un
token de sesión
con tus solicitudes de Autocomplete (nuevo).
Cuando solicites Place Details (nuevo) sobre la predicción seleccionada, incluye los siguientes parámetros:
- El ID de lugar de la respuesta de Autocomplete (nuevo)
- Es el token de sesión que se usó en la solicitud de Autocomplete (nuevo).
- El parámetro
fieldsque especifica campos como la dirección y la geometría
Considera retrasar las solicitudes de Autocomplete (nuevo)
Puedes emplear estrategias como demorar una solicitud de Autocomplete (nuevo) hasta que el usuario escriba los primeros tres o cuatro caracteres para que tu aplicación realice menos solicitudes. Por ejemplo, realizar solicitudes de Autocomplete (nuevo) para cada carácter después de que el usuario haya escrito el tercer carácter significa que, si el usuario escribe siete caracteres y, luego, selecciona una predicción para la que realizas una solicitud a la API de Geocoding, el costo total sería el de 4 solicitudes de Autocomplete (nuevo) por solicitud más Geocoding.1
Si retrasar las solicitudes puede hacer que tu solicitud programática promedio sea inferior a cuatro, puedes seguir las instrucciones para implementar Autocomplete (nuevo) con la API de Geocoding y obtener un rendimiento optimizado. Ten en cuenta que demorar las solicitudes puede percibirse como latencia por parte del usuario, que tal vez espere ver predicciones con cada letra que ingresa.
Considera seguir las prácticas recomendadas de rendimiento para ayudar a los usuarios a obtener la predicción que buscan con menos caracteres.
-
Para conocer los costos, consulta las listas de precios de Google Maps Platform.
Prácticas recomendadas para el rendimiento
Los siguientes lineamientos describen maneras de optimizar el rendimiento de Autocomplete (nuevo):
- Agrega restricciones por país, personalización de la ubicación y, en el caso de las implementaciones programáticas, la preferencia de idioma a la implementación de Autocomplete (nuevo). La preferencia de idioma no es necesaria para los widgets, dado que toman esta información del navegador o el dispositivo móvil del usuario.
- Si Autocomplete (nuevo) cuenta con un mapa, puedes personalizar la ubicación según su viewport.
- En las situaciones en que un usuario no elige una de las predicciones de Autocomplete (nuevo), generalmente, porque ninguna de ellas indica la dirección del resultado deseado, puedes reutilizar la entrada original del usuario para tratar de obtener resultados más relevantes:
- Si esperas que el usuario ingrese solo información de la dirección, reutiliza la entrada original del usuario en una llamada a la API de Geocoding.
- Si esperas que el usuario ingrese búsquedas para un lugar específico por nombre o dirección, usa una solicitud de Place Details (nuevo). Si se espera que los resultados pertenezcan únicamente a una región específica, usa la restricción de ubicación.
- Usuarios que ingresan direcciones de subinstalaciones, como direcciones de unidades o apartamentos específicos dentro de un edificio Por ejemplo, la dirección checa "Stroupežnického 3191/17, Praha" genera una predicción parcial en Autocomplete (nuevo).
- Usuarios que ingresan direcciones con prefijos de tramo de ruta, como "23-30 29th St, Queens" en la ciudad de Nueva York o "47-380 Kamehameha Hwy, Kaneohe" en la isla de Kauai en Hawái
Ajuste de la ubicación
Personaliza los resultados para un área específica pasando un parámetro location y un parámetro radius. Esto indica a Autocomplete (nuevo) que prefiera mostrar resultados dentro del área definida. Es posible que también se muestren resultados externos al área definida. Puedes usar el parámetro components para filtrar los resultados y mostrar solo los lugares dentro de un país especificado.
Restricción de ubicación
Restringe los resultados a un área específica pasando un parámetro locationRestriction.
También puedes restringir los resultados a la región definida por location y un parámetro radius agregando el parámetro locationRestriction. Esto indica a Autocomplete (nuevo) que muestre solo resultados dentro de esa región.
Pruébalo
El Explorador de APIs te permite realizar solicitudes de ejemplo para que te familiarices con la API y sus opciones.
Selecciona el ícono de la API api en el lado derecho de la página.
De manera opcional, edita los parámetros de la solicitud.
Selecciona el botón Ejecutar. En el diálogo, elige la cuenta que deseas usar para realizar la solicitud.
En el panel del Explorador de APIs, selecciona el ícono de pantalla completa fullscreen para expandir la ventana del Explorador de APIs.