Clase AutocompleteService
Clase google.maps.places.AutocompleteService
Contiene métodos relacionados con la recuperación de predicciones de Autocomplete.
Llama al const {AutocompleteService} = await google.maps.importLibrary("places")
para acceder.
Consulta Bibliotecas en 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 de devolución:
Promise<AutocompleteResponse> Recupera predicciones de autocompletado de lugares según la solicitud de autocompletado proporcionada. |
getQueryPredictions |
getQueryPredictions(request, callback) Parámetros:
Valor de retorno: Ninguno
Recupera predicciones de autocompletar durante la búsqueda según la solicitud de autocompletar proporcionada. |
Interfaz de AutocompletionRequest
Interfaz de google.maps.places.AutocompletionRequest
Es una solicitud de autocompletado que se enviará a AutocompleteService.getPlacePredictions
.
Propiedades | |
---|---|
input |
Tipo:
string Es la cadena de entrada que ingresó el usuario. |
|
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Son los límites para el sesgo de predicción. Las predicciones se personalizarán, aunque no de manera exclusiva, conforme al bounds proporcionado. Se ignorarán location y radius si se establece bounds . |
componentRestrictions optional |
Tipo:
ComponentRestrictions optional Son las restricciones del componente. Las restricciones de componentes se usan para restringir las predicciones solo a las que se encuentran dentro del componente principal. Por ejemplo, el país. |
language optional |
Tipo:
string optional Es un identificador de idioma para el idioma en el que se deben devolver 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 Es la ubicación para la adaptación de la predicción. Las predicciones se sesgarán hacia los valores de location y radius proporcionados. 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 Son los límites para restringir los resultados de la búsqueda. |
offset optional |
Tipo:
number optional 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 sesgar la predicción. El 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 el formato y el filtrado de 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 de "El 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 Son los tipos de predicciones que se devolverán. Para conocer los tipos compatibles, consulta la guía para desarrolladores. Si no se especifican tipos, se devolverán todos los tipos. |
Interfaz de AutocompleteResponse
Interfaz de google.maps.places.AutocompleteResponse
Es una respuesta de Autocomplete que muestra la llamada a AutocompleteService.getPlacePredictions
y que contiene una lista de AutocompletePrediction
s.
Propiedades | |
---|---|
predictions |
Tipo:
Array<AutocompletePrediction> Es la lista de AutocompletePrediction s. |
Interfaz QueryAutocompletionRequest
Interfaz de google.maps.places.QueryAutocompletionRequest
Es una solicitud de QueryAutocompletion que se enviará a QueryAutocompleteService
.
Propiedades | |
---|---|
input |
Tipo:
string Es la cadena de entrada que ingresó el usuario. |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Son los límites para el sesgo de predicción. Las predicciones se personalizarán, aunque no de manera exclusiva, conforme al bounds proporcionado. Se ignorarán location y radius si se establece bounds . |
location optional |
Tipo:
LatLng optional Es la ubicación para la adaptación de la predicción. Las predicciones se sesgarán hacia los valores de location y radius proporcionados. Como alternativa, se puede usar bounds . |
offset optional |
Tipo:
number optional 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 sesgar la predicción. El radius se especifica en metros y siempre debe ir acompañado de una propiedad location . Como alternativa, se puede usar bounds . |
Interfaz de 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, no distingue mayúsculas de minúsculas). Por ejemplo, 'us' , 'br' o 'au' . Puedes proporcionar un solo valor o un array de hasta cinco cadenas de código 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 búsqueda que sugiere 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 en la entrada del usuario, adecuadas para usarse en el resaltado de 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 información estructurada sobre la descripción del lugar, dividida en un texto principal y un texto secundario, que incluye un array de subcadenas coincidentes de la entrada de autocompletado, identificadas por un desplazamiento y una longitud, expresados en caracteres Unicode. |
terms |
Tipo:
Array<PredictionTerm> Es la información sobre los términos individuales en la descripción anterior, de más a menos específicos. Por ejemplo, "Taco Bell", "Willits" y "CA". |
types |
Tipo:
Array<string> Es 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 Query Autocomplete.
Propiedades | |
---|---|
description |
Tipo:
string Esta es la versión sin formato de la búsqueda que sugiere 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 en la entrada del usuario, adecuadas para usarse en el resaltado de esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresados en caracteres Unicode. |
terms |
Tipo:
Array<PredictionTerm> Es información sobre los términos individuales de la descripción anterior. Los términos categóricos aparecen primero (por ejemplo, "restaurante"). Los términos de la dirección aparecen del más específico al menos específico. 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 de 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 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 Es el desplazamiento hacia el inicio de la subcadena dentro de la cadena de descripción. |
Interfaz de StructuredFormatting
Interfaz de google.maps.places.StructuredFormatting
Contiene información estructurada sobre la descripción del lugar, dividida en un texto principal y un texto secundario, incluido un array de subcadenas coincidentes de la entrada de autocompletado, identificadas por un desplazamiento y una longitud, expresados en caracteres Unicode.
Propiedades | |
---|---|
main_text |
Tipo:
string Es la parte principal del texto 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 en la entrada del usuario, aptas para usarse en el resaltado de esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresados en caracteres Unicode. |
secondary_text |
Tipo:
string Es la parte secundaria del texto de la descripción sin formato del lugar sugerido por el servicio de Places. Por lo general, es la ubicación del lugar. |