Places Autocomplete Service

AutocompleteService

Clase google.maps.places.AutocompleteService

Contiene métodos relacionados con la recuperación de predicciones de Autocomplete.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.

Cuando se usa v=beta, se puede acceder a él llamando a const {AutocompleteService} = await google.map.importLibrary("places"). Consulta Bibliotecas en la API de Maps JavaScript.
AutocompleteService
AutocompleteService()
Parámetros: ninguno
Crea una instancia nueva de AutocompleteService.
getPlacePredictions
getPlacePredictions(request[, callback])
Parámetros:
Valor que se muestra: Promise<AutocompleteResponse>
Recupera predicciones de autocompletado de sitios según la solicitud suministrada de autocompletado.
getQueryPredictions
getQueryPredictions(request, callback)
Parámetros:
Valor que se muestra: Ninguno
Recupera las predicciones de autocompletado de consultas en función de la solicitud de autocompletado de consultas suministrada.

AutocompletionRequest

Interfaz de google.maps.places.AutocompletionRequest

Se enviará una solicitud de autocompletado a AutocompleteService.getPlacePredictions.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
input
Tipo: string
El usuario ingresó una string de entrada.
bounds optional
Límites de la personalización de predicciones Las predicciones se inclinarán hacia, pero no se limitarán a, el bounds dado. location y radius se ignorarán si se configura bounds.
componentRestrictions optional
Tipo: ComponentRestrictions optional
Las restricciones de los componentes. Las restricciones de componentes se usan para restringir las predicciones a solo aquellas incluidas en el componente superior. Por ejemplo, el país.
language optional
Tipo: string optional
Un identificador de idioma para el idioma en el que se deben mostrar los resultados, si es posible. Es posible que se les otorgue una clasificación más alta a los resultados en el idioma seleccionado, pero las sugerencias no se limitan a este. Consulta la lista de idiomas compatibles.
location optional
Tipo: LatLng optional
Ubicación para la personalización de predicciones. Las predicciones se inclinarán hacia las location y radius dadas. Como alternativa, se puede usar bounds.
offset optional
Tipo: number optional
La posición del carácter en el término introducido en el que el servicio utiliza texto para predicciones (la posición del cursor en el campo de entrada).
origin optional
Tipo: LatLng|LatLngLiteral optional
La ubicación desde la que se calcula AutocompletePrediction.distance_meters
radius optional
Tipo: number optional
Radio del área utilizada para la personalización de predicciones. El radius se especifica en metros y siempre debe estar acompañado de una propiedad location. Como alternativa, se puede usar bounds.
region optional
Tipo: string optional
Un código de región que se usa para el formato y el filtrado de resultados. No restringe las sugerencias para este país. El código de región acepta un valor de ccTLD ("dominio de nivel superior") de dos caracteres. La mayoría de los códigos 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 "Reino Unido de Gran Bretaña e Irlanda del Norte").
sessionToken optional
Referencia única que se usa para agrupar solicitudes individuales en sesiones.
types optional
Tipo: Array<string> optional
Los tipos de predicciones que se mostrarán. Para obtener información sobre los tipos compatibles, consulta la Guía para desarrolladores. Si no se especifican tipos, se mostrarán todos.

AutocompleteResponse

Interfaz de google.maps.places.AutocompleteResponse

Una respuesta de Autocomplete que muestra la llamada a AutocompleteService.getPlacePredictions que contiene una lista de AutocompletePrediction

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
predictions
La lista de AutocompletePrediction.

QueryAutocompletionRequest

Interfaz de google.maps.places.QueryAutocompletionRequest

Una solicitud de autocompletado de consultas que se enviará a QueryAutocompleteService.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
input
Tipo: string
El usuario ingresó una string de entrada.
bounds optional
Límites de la personalización de predicciones Las predicciones se inclinarán hacia, pero no se limitarán a, el bounds dado. location y radius se ignorarán si se configura bounds.
location optional
Tipo: LatLng optional
Ubicación para la personalización de predicciones. Las predicciones se inclinarán hacia las location y radius dadas. Como alternativa, se puede usar bounds.
offset optional
Tipo: number optional
La posición del carácter en el término introducido en el que el servicio utiliza texto para predicciones (la posición del cursor en el campo de entrada).
radius optional
Tipo: number optional
Radio del área utilizada para la personalización de predicciones. El radius se especifica en metros y siempre debe estar acompañado de una propiedad location. Como alternativa, se puede usar bounds.

AutocompleteSessionToken.

Clase google.maps.places.AutocompleteSessionToken

Representa un token de sesión que se usa para realizar el seguimiento de una sesión de autocompletado, que puede ser una serie de llamadas de AutocompleteService.getPlacePredictions seguidas de una sola llamada a PlacesService.getDetails.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.

Cuando se usa v=beta, se puede acceder a él llamando a const {AutocompleteSessionToken} = await google.map.importLibrary("places"). Consulta Bibliotecas en la API de Maps JavaScript.
AutocompleteSessionToken
AutocompleteSessionToken()
Parámetros: ninguno
Crea una instancia nueva de AutocompleteSessionToken.

ComponentRestrictions

Interfaz de google.maps.places.ComponentRestrictions

Define las restricciones de los componentes que se pueden usar con el servicio de autocompletado.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
country optional
Tipo: string|Array<string> optional
Restringe las predicciones al país especificado (código de país ISO 3166-1 Alpha-2, sin distinción entre mayúsculas y minúsculas). Por ejemplo, 'us', 'br' o 'au'. Puedes proporcionar un único arreglo o hasta cinco strings de código de país.

AutocompletePrediction

Interfaz de google.maps.places.AutocompletePrediction

Representa una sola predicción de autocompletado.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
description
Tipo: string
Esta es la versión sin formato de la consulta sugerida por el servicio de Places.
matched_substrings
Un conjunto de substrings en la descripción del lugar que coinciden con elementos de la entrada del usuario, adecuados para destacar esas substrings. Cada substring se identifica mediante un desplazamiento y una longitud, que se expresan en caracteres Unicode.
place_id
Tipo: string
Un ID de lugar que se puede usar para recuperar detalles sobre este lugar mediante el servicio de detalles del lugar (consulta PlacesService.getDetails).
structured_formatting
Información estructurada sobre la descripción del lugar, dividida en un texto principal y otro secundario, que incluye un arreglo de substrings coincidentes de la entrada de autocompletado, identificadas por un desplazamiento y una longitud, expresadas en caracteres Unicode.
terms
Información sobre términos individuales de la descripción anterior, de la más específica a la menos específica. Por ejemplo, "Taco Bell", "Willitis" y "CA".
types
Tipo: Array<string>
Un arreglo de tipos a los que pertenece la predicción, por ejemplo, 'establishment' o 'geocode'
distance_meters optional
Tipo: number optional
La distancia en metros del lugar desde AutocompletionRequest.origin.

QueryAutocompletePrediction

Interfaz de google.maps.places.QueryAutocompletePrediction

Representa una sola predicción de autocompletado de consultas.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
description
Tipo: string
Esta es la versión sin formato de la consulta sugerida por el servicio de Places.
matched_substrings
Un conjunto de substrings en la descripción del lugar que coinciden con elementos de la entrada del usuario, adecuados para destacar esas substrings. Cada substring se identifica mediante un desplazamiento y una longitud, que se expresan en caracteres Unicode.
terms
Información sobre los términos individuales en la descripción anterior. Los términos categóricos van primero (por ejemplo, "restaurante"). Los términos de la dirección aparecen de más a menos específicos. Por ejemplo, “San Francisco” y “CA”.
place_id optional
Tipo: string optional
Solo está disponible si la predicción es un lugar. Un ID de lugar que se puede usar para recuperar detalles sobre este lugar mediante el servicio de detalles del lugar (consulta PlacesService.getDetails).

PredictionTerm

Interfaz de google.maps.places.PredictionTerm

Representa un término de predicción.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
offset
Tipo: number
El desplazamiento, en caracteres Unicode, del inicio de este término en la descripción del lugar.
value
Tipo: string
El valor de este término, por ejemplo, "Taco Bell".

PredictionSubstring

Interfaz de google.maps.places.PredictionSubstring

Representa una substring de predicción.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
length
Tipo: number
La longitud de la substring.
offset
Tipo: number
El desplazamiento del inicio de la substring dentro de la string de descripción

StructuredFormat

Interfaz de google.maps.places.StructuredFormatting

Contiene información estructurada sobre la descripción del lugar, dividida en un texto principal y otro secundario, que incluye un arreglo de substrings coincidentes de la entrada de autocompletado, identificadas por un desplazamiento y una longitud, expresados en caracteres Unicode.

Carga con el parámetro de URL &libraries=places. Consulta Bibliotecas en la API de Maps JavaScript.
main_text
Tipo: string
Esta es la parte de texto principal de la descripción sin formato del sitio sugerido por el servicio de Places. Por lo general, es el nombre del lugar.
main_text_matched_substrings
Un conjunto de substrings en el texto principal que coinciden con elementos de la entrada del usuario, adecuadas para destacar esas substrings. Cada substring se identifica mediante un desplazamiento y una longitud, que se expresan en caracteres Unicode.
secondary_text
Tipo: string
Esta es la parte de texto secundaria de la descripción sin formato del sitio sugerido por el servicio de Places. Por lo general, la ubicación del lugar.