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 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:
Valor que se muestra:
Promise<AutocompleteResponse> Recupera predicciones de Place Autocomplete según la solicitud de Autocomplete proporcionada. |
getQueryPredictions |
getQueryPredictions(request, callback) Parámetros:
Valor que se muestra: Ninguno
Recupera predicciones de autocompletar de búsquedas según la solicitud de autocompletar de búsqueda proporcionada. |
Interfaz AutocompletionRequest
Interfaz de google.maps.places.AutocompletionRequest
Una solicitud de autocompletado que se enviará a AutocompleteService.getPlacePredictions
.
Propiedades | |
---|---|
input |
Tipo:
string El usuario ingresó una cadena de entrada. |
|
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Límites para el sesgo de predicción Las predicciones se orientarán al bounds determinado, pero no se limitarán a él. Se ignorarán location y radius si se establece bounds . |
componentRestrictions optional |
Tipo:
ComponentRestrictions optional Las restricciones de componentes Las restricciones de componentes se usan para restringir las predicciones solo a aquellas 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. |
|
Tipo:
LatLng optional Ubicación para el sesgo de predicción. Las predicciones se sesgarán hacia los location y radius determinados. Como alternativa, se puede usar bounds . |
locationBias optional |
Tipo:
LocationBias optional Es un límite o una sugerencia flexible que se usa cuando se buscan lugares. |
locationRestriction optional |
Tipo:
LocationRestriction optional Límites para restringir los resultados de la búsqueda. |
offset optional |
Tipo:
number optional Es la posición del carácter en el término de entrada en la que el servicio usa texto para las 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 AutocompletePrediction.distance_meters . |
|
Tipo:
number optional Es el radio del área que se usa para el sesgo de predicción. radius se especifica en metros y siempre debe ir acompañado de una propiedad location . Como alternativa, se puede usar bounds . |
region optional |
Tipo:
string optional Es un código de región que se usa para dar formato a los resultados y para filtrar los resultados. 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 "Reino Unido de Gran Bretaña e Irlanda del Norte"). |
sessionToken optional |
Tipo:
AutocompleteSessionToken optional Es una 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. |
Interfaz AutocompleteResponse
Interfaz de google.maps.places.AutocompleteResponse
Una respuesta de Autocomplete que muestra la llamada a AutocompleteService.getPlacePredictions
y que contiene una lista de AutocompletePrediction
.
Propiedades | |
---|---|
predictions |
Tipo:
Array<AutocompletePrediction> La lista de AutocompletePrediction . |
Interfaz QueryAutocompletionRequest
Interfaz de google.maps.places.QueryAutocompletionRequest
Una solicitud de QueryAutocompletion que se enviará a QueryAutocompleteService
.
Propiedades | |
---|---|
input |
Tipo:
string El usuario ingresó una cadena de entrada. |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Límites para el sesgo de predicción Las predicciones se orientarán al bounds determinado, pero no se limitarán a él. Se ignorarán location y radius si se establece bounds . |
location optional |
Tipo:
LatLng optional Ubicación para el sesgo de predicción. Las predicciones se sesgarán hacia los location y radius determinados. Como alternativa, se puede usar bounds . |
offset optional |
Tipo:
number optional Es la posición del carácter en el término de entrada en la que el servicio usa texto para las predicciones (la posición del cursor en el campo de entrada). |
radius optional |
Tipo:
number optional Es el radio del área que se usa para el sesgo de predicción. radius se especifica en metros y siempre debe ir acompañado de una propiedad location . Como alternativa, se puede usar bounds . |
Interfaz ComponentRestrictions
Interfaz de google.maps.places.ComponentRestrictions
Define las restricciones de componentes que se pueden usar con el servicio de autocompletar.
Propiedades | |
---|---|
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 de mayúsculas o 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 autocompletar.
Propiedades | |
---|---|
description |
Tipo:
string Esta es la versión sin formato de la consulta que sugirió el servicio de 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, adecuado para destacar esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresados en caracteres Unicode. |
place_id |
Tipo:
string Es un ID de lugar que se puede usar para recuperar detalles sobre este lugar con el servicio de Place Details (consulta PlacesService.getDetails ). |
structured_formatting |
Tipo:
StructuredFormatting Es la información estructurada sobre la descripción del lugar, dividida en un texto principal y uno secundario, que incluye un array de substrings coincidentes de la entrada de autocompletado, identificado por un desplazamiento y una longitud, expresados en caracteres Unicode. |
terms |
Tipo:
Array<PredictionTerm> Información sobre los términos individuales de la descripción anterior, de la más a la menos específica. 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 Es la distancia en metros entre el lugar y el AutocompletionRequest.origin . |
Interfaz QueryAutocompletePrediction
Interfaz de google.maps.places.QueryAutocompletePrediction
Representa una sola predicción de Autocomplete de búsqueda.
Propiedades | |
---|---|
description |
Tipo:
string Esta es la versión sin formato de la consulta que sugirió el servicio de 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, adecuado para destacar esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresados en caracteres Unicode. |
terms |
Tipo:
Array<PredictionTerm> Información sobre los términos individuales de la descripción anterior. Los términos categóricos van primero (por ejemplo, "restaurante"). Los términos de la dirección aparecen de la forma más específica 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 con el servicio de Place Details (consulta PlacesService.getDetails ). |
Interfaz PredictionTerm
Interfaz de google.maps.places.PredictionTerm
Representa un término de predicción.
Propiedades | |
---|---|
offset |
Tipo:
number Es el desplazamiento, en caracteres Unicode, del inicio de este término en la descripción del lugar. |
value |
Tipo:
string Es el valor de este término, por ejemplo, "Taco Bell". |
Interfaz PredictionSubstring
Interfaz de google.maps.places.PredictionSubstring
Representa una subcadena de predicción.
Propiedades | |
---|---|
length |
Tipo:
number Es la longitud de la substring. |
offset |
Tipo:
number Es el desplazamiento al inicio de la subcadena dentro de la cadena de descripción. |
Interfaz StructuredFormatting
Interfaz de google.maps.places.StructuredFormatting
Contiene información estructurada sobre la descripción del lugar, dividida en un texto principal y uno secundario, que incluye un array de substrings 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 de texto principal de la descripción sin formato del lugar sugerido por el servicio de Places. Por lo general, es el nombre del lugar. |
main_text_matched_substrings |
Tipo:
Array<PredictionSubstring> Es un conjunto de subcadenas en el texto principal que coinciden con los elementos de la entrada del usuario, adecuado para destacar esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresados en caracteres Unicode. |
secondary_text |
Tipo:
string Es la parte de texto secundaria de la descripción sin formato del lugar sugerido por el servicio de Places. Por lo general, es la ubicación del lugar. |