Places Autocomplete Service

Clase AutocompleteService

Clase google.maps.places.AutocompleteService

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

Para acceder, llama a const {AutocompleteService} = await google.maps.importLibrary("places"). Consulta el artículo Bibliotecas de la API de Maps JavaScript.

Constructor
AutocompleteService	AutocompleteService() Parámetros: Ninguno Crea una instancia nueva de AutocompleteService.

Métodos
getPlacePredictions	getPlacePredictions(request[, callback]) Parámetros:  request:  AutocompletionRequest Es la solicitud de autocompletado. callback:  function(Array<AutocompletePrediction> optional, PlacesServiceStatus): void optional Es una devolución de llamada que acepta un array de objetos AutocompletePrediction y un valor PlacesServiceStatus como argumento. Valor que se devuelve:  Promise<AutocompleteResponse> Recupera predicciones de Place Autocomplete basadas en la solicitud de autocompletado proporcionada.
getQueryPredictions	getQueryPredictions(request, callback) Parámetros:  request:  QueryAutocompletionRequest Es la solicitud de autocompletado de consultas. callback:  function(Array<QueryAutocompletePrediction> optional, PlacesServiceStatus): void Es una devolución de llamada que acepta un array de objetos QueryAutocompletePrediction y un valor PlacesServiceStatus como argumento. Valor que se devuelve: Ninguno Recupera predicciones de autocompletado de consultas basadas en la solicitud de autocompletado de consultas proporcionada.

AutocompletionRequest

Interfaz de google.maps.places.AutocompletionRequest

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

Propiedades
input	Tipo:  string La cadena de entrada ingresada por el usuario
bounds optional	Obsoleto: bounds dejó de estar disponible a partir de mayo de 2023. En su lugar, usa AutocompletionRequest.locationBias y AutocompletionRequest.locationRestriction. Tipo:  LatLngBounds|LatLngBoundsLiteral optional Límites para la personalización de predicción. Las predicciones se personalizarán según el bounds especificado, aunque no se restringirán a él. location y radius se ignorarán si se configura bounds.
componentRestrictions optional	Tipo:  ComponentRestrictions optional Las restricciones del componente. Las restricciones de componentes se usan para restringir las predicciones solo a aquellas que se encuentran dentro del 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 los resultados en el idioma seleccionado tengan una clasificación más alta, pero las sugerencias no se limitan a este idioma. Consulta la lista de idiomas compatibles.
location optional	Obsoleto: location dejó de estar disponible a partir de mayo de 2023. En su lugar, usa AutocompletionRequest.locationBias y AutocompletionRequest.locationRestriction. Tipo:  LatLng optional Ubicación para la personalización de predicciones. Las predicciones se personalizarán según los valores de location y radius indicados. Como alternativa, se puede usar bounds.
locationBias optional	Tipo:  LocationBias optional Un límite flexible o una pista para usar cuando se buscan lugares
locationRestriction optional	Tipo:  LocationRestriction optional Límites para restringir los resultados de la búsqueda.
offset optional	Tipo:  number optional La posición del carácter en el término de entrada en la que el servicio usa texto para predicciones (la posición del cursor en el campo de entrada).
origin optional	Tipo:  LatLng|LatLngLiteral optional Es la ubicación desde la que se calcula la métrica de AutocompletePrediction.distance_meters.
radius optional	Obsoleto: radius dejó de estar disponible a partir de mayo de 2023. En su lugar, usa AutocompletionRequest.locationBias y AutocompletionRequest.locationRestriction. Tipo:  number optional El 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 Es el código de región que se usa para dar formato a los resultados y filtrarlos. No restringe las sugerencias a 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 del "Reino Unido de Gran Bretaña e Irlanda del Norte").
sessionToken optional	Tipo:  AutocompleteSessionToken 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 conocer los tipos compatibles, consulta la guía para desarrolladores. Si no se especifican tipos, se mostrarán todos los tipos.

AutocompleteResponse

Interfaz de google.maps.places.AutocompleteResponse

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

Propiedades
predictions	Tipo:  Array<AutocompletePrediction> Es la lista de elementos AutocompletePrediction.

QueryAutocompletionRequest

Interfaz de google.maps.places.QueryAutocompletionRequest

Se enviará una solicitud QueryAutocomplete a QueryAutocompleteService.

Propiedades
input	Tipo:  string La cadena de entrada ingresada por el usuario
bounds optional	Tipo:  LatLngBounds|LatLngBoundsLiteral optional Límites para la personalización de predicción. Las predicciones se personalizarán según el bounds especificado, aunque no se restringirán a él. 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 personalizarán según los valores de location y radius indicados. Como alternativa, se puede usar bounds.
offset optional	Tipo:  number optional La posición del carácter en el término de entrada en la que el servicio usa texto para predicciones (la posición del cursor en el campo de entrada).
radius optional	Tipo:  number optional El 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.

Clase 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 AutocompleteService.getPlacePredictions seguidas de una sola llamada a PlacesService.getDetails.

Para acceder, llama a const {AutocompleteSessionToken} = await google.maps.importLibrary("places"). Consulta el artículo Bibliotecas de la API de Maps JavaScript.

Constructor
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.

Propiedades
country optional	Tipo:  string|Array<string> optional Restringe las predicciones al país especificado (código de país ISO 3166-1 alfa-2, no distingue mayúsculas de minúsculas). Por ejemplo, 'us', 'br' o 'au'. Puedes proporcionar uno solo o un array de hasta cinco cadenas de códigos de país.

Interfaz de AutocompletePrediction

Interfaz de google.maps.places.AutocompletePrediction

Representa una sola predicción de autocompletado.

Propiedades
description	Tipo:  string Esta es la versión sin formato de la consulta que sugiere el servicio Places.
matched_substrings	Tipo:  Array<PredictionSubstring> Es un conjunto de subcadenas en la descripción del lugar que coinciden con los elementos de la entrada del usuario, adecuadas para resaltar esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresadas en caracteres Unicode.
place_id	Tipo:  string Es 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	Tipo:  StructuredFormatting Información estructurada sobre la descripción del lugar, dividida en texto principal y uno secundario, incluida una matriz de subcadenas coincidentes de la entrada de autocompletado, identificadas por un desplazamiento y una longitud, expresadas en caracteres Unicode.
terms	Tipo:  Array<PredictionTerm> Información sobre términos individuales en la descripción anterior, del más al menos específico. Por ejemplo, "Taco Bell", "Willitis" y "CA".
types	Tipo:  Array<string> Un array de tipos a los que pertenece la predicción, por ejemplo, 'establishment' o 'geocode'.
distance_meters optional	Tipo:  number optional La distancia en metros entre el lugar y el AutocompletionRequest.origin.

Interfaz de QueryAutocompletePrediction

Interfaz de google.maps.places.QueryAutocompletePrediction

Representa una sola predicción de autocompletado de consultas.

Propiedades
description	Tipo:  string Esta es la versión sin formato de la consulta que sugiere el servicio Places.
matched_substrings	Tipo:  Array<PredictionSubstring> Es un conjunto de subcadenas en la descripción del lugar que coinciden con los elementos de la entrada del usuario, adecuadas para resaltar esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresadas en caracteres Unicode.
terms	Tipo:  Array<PredictionTerm> Información sobre términos individuales en la descripción anterior. Los términos categóricos van primero (por ejemplo, "restaurante"). Los términos de dirección aparecen de la más a la menos específica. Por ejemplo, "San Francisco" y "CA".
place_id optional	Tipo:  string optional Solo está disponible si la predicción es un lugar. Es 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.

Propiedades
offset	Tipo:  number El desplazamiento, en caracteres Unicode, del comienzo de este término en la descripción del lugar.
value	Tipo:  string Indica el valor de este término, por ejemplo, "Taco Bell".

Interfaz de PredictionSubstring

Interfaz de google.maps.places.PredictionSubstring

Representa una subcadena de predicción.

Propiedades
length	Tipo:  number Longitud de la subcadena.
offset	Tipo:  number El desplazamiento al inicio de la substring dentro de la string de descripción.

StructuredFormatting.

Interfaz de google.maps.places.StructuredFormatting

Contiene información estructurada sobre la descripción del lugar, dividida en texto principal y uno secundario, lo que incluye un array de subcadenas coincidentes de la entrada de autocompletado, identificadas por un desplazamiento y una longitud, expresadas en caracteres Unicode.

Propiedades
main_text	Tipo:  string Esta es la parte principal del texto de la descripción sin formato del lugar que sugiere el servicio Places. Por lo general, es el nombre del lugar.
main_text_matched_substrings	Tipo:  Array<PredictionSubstring> Un conjunto de subcadenas en el texto principal que coinciden con los elementos de la entrada del usuario, adecuadas para destacarlas. Cada subcadena se identifica con un desplazamiento y una longitud, expresadas en caracteres Unicode.
secondary_text	Tipo:  string Esta es la parte de texto secundaria de la descripción sin formato del lugar que sugiere el servicio Places. Por lo general, es la ubicación del lugar.