Clase AutocompleteService
clase
google.maps.places.AutocompleteService
biblioteca "places"
Contiene métodos relacionados con la recuperación de predicciones de Autocomplete.
const {AutocompleteService} = await google.maps.importLibrary("places");
Constructor | |
|---|---|
AutocompleteService |
AutocompleteService()Parámetros: Ninguno
Crea una instancia nueva de AutocompleteService. |
Métodos | |
|---|---|
getPlacePredictions |
getPlacePredictions(request[, callback])Parámetros:
Valor de retorno:
Promise<AutocompleteResponse>Recupera predicciones de Place Autocomplete según la solicitud de autocompletar proporcionada. |
getQueryPredictions |
getQueryPredictions(request, callback)Parámetros:
Valor de retorno: Ninguno
Recupera predicciones de autocompletar de búsqueda según la solicitud de autocompletar de búsqueda proporcionada. |
Interfaz AutocompletionRequest
interfaz
google.maps.places.AutocompletionRequest
Es una solicitud de autocompletado que se enviará a AutocompleteService.getPlacePredictions.
Propiedades | |
|---|---|
input |
Tipo:
stringEs la cadena de entrada que ingresó el usuario. |
opcional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optionalLímites para el sesgo de predicción. Las predicciones tendrán un sesgo hacia el bounds proporcionado, aunque no se restringirán a él. Se ignorarán location y radius si se establece bounds. |
componentRestrictions
opcional |
Tipo:
ComponentRestrictions optionalLas restricciones de los componentes. Las restricciones de componentes se usan para limitar las predicciones solo a aquellas que se encuentran dentro del componente superior. Por ejemplo, el país. |
language
opcional |
Tipo:
string optionalEs un identificador del 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 restringen a este idioma. Consulta la lista de idiomas compatibles. |
opcional |
Tipo:
LatLng optionalEs la ubicación para el sesgo de predicción. Las predicciones se sesgarán hacia los valores de location y radius proporcionados. Como alternativa, se puede usar bounds. |
locationBias
opcional |
Tipo:
LocationBias optionalEs un límite o una sugerencia flexible que se usa cuando se buscan lugares. |
locationRestriction
opcional |
Tipo:
LocationRestriction optionalSon los límites para restringir los resultados de la búsqueda. |
offset
opcional |
Tipo:
number optionalEs la posición del carácter en el término de entrada en el que el servicio usa texto para las predicciones (la posición del cursor en el campo de entrada). |
origin
opcional |
Tipo:
LatLng|LatLngLiteral optionalEs la ubicación desde la que se calcula AutocompletePrediction.distance_meters. |
opcional |
Tipo:
number optionalEs el radio del área que se usa para el sesgo de 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
opcional |
Tipo:
string optionalEs un 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 dos caracteres de ccTLD ("dominio de nivel superior"). 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
opcional |
Tipo:
AutocompleteSessionToken optionalEs una referencia única que se usa para agrupar solicitudes individuales en sesiones. |
types
opcional |
Tipo:
Array<string> optionalSon los tipos de predicciones que se devolverán. Para conocer los tipos compatibles, consulta la guía para desarrolladores. Si no se especifica ningún tipo, se devolverán todos los tipos. |
Interfaz AutocompleteResponse
interfaz
google.maps.places.AutocompleteResponse
Es una respuesta de Autocomplete que devuelve la llamada a AutocompleteService.getPlacePredictions y que contiene una lista de AutocompletePrediction.
Propiedades | |
|---|---|
predictions |
Tipo:
Array<AutocompletePrediction>Es la lista de AutocompletePrediction. |
Interfaz QueryAutocompletionRequest
interfaz
google.maps.places.QueryAutocompletionRequest
Es una solicitud de QueryAutocompletion que se enviará a QueryAutocompleteService.
Propiedades | |
|---|---|
input |
Tipo:
stringEs la cadena de entrada que ingresó el usuario. |
bounds
opcional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optionalLímites para el sesgo de predicción. Las predicciones tendrán un sesgo hacia el bounds proporcionado, aunque no se restringirán a él. Se ignorarán location y radius si se establece bounds. |
location
opcional |
Tipo:
LatLng optionalEs la ubicación para el sesgo de predicción. Las predicciones se sesgarán hacia los valores de location y radius proporcionados. Como alternativa, se puede usar bounds. |
offset
opcional |
Tipo:
number optionalEs la posición del carácter en el término de entrada en el que el servicio usa texto para las predicciones (la posición del cursor en el campo de entrada). |
radius
opcional |
Tipo:
number optionalEs el radio del área que se usa para el sesgo de 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 ComponentRestrictions
interfaz
google.maps.places.ComponentRestrictions
Define las restricciones de componentes que se pueden usar con el servicio de autocompletado.
Propiedades | |
|---|---|
country
opcional |
Tipo:
string|Array<string> optionalRestringe las predicciones al país especificado (código de país ISO 3166-1 Alpha-2, que no distingue mayúsculas de minúsculas). Por ejemplo, 'us', 'br' o 'au'. Puedes proporcionar un solo código o un array de hasta cinco cadenas de códigos de país. |
Interfaz AutocompletePrediction
interfaz
google.maps.places.AutocompletePrediction
Representa una sola predicción de autocompletar.
Propiedades | |
|---|---|
description |
Tipo:
stringEsta 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 de la entrada del usuario, adecuadas para destacar esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresados en caracteres Unicode. |
place_id |
Tipo:
stringUn 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:
StructuredFormattingInformación estructurada sobre la descripción del lugar, dividida en un texto principal y un texto secundario, incluido un array de substrings coincidentes de la entrada de autocompletado, identificadas 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 los más específicos a los menos específicos. 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
opcional |
Tipo:
number optionalEs la distancia en metros entre el lugar y el AutocompletionRequest.origin. |
Interfaz QueryAutocompletePrediction
interfaz
google.maps.places.QueryAutocompletePrediction
Representa una sola predicción de autocompletar de consulta.
Propiedades | |
|---|---|
description |
Tipo:
stringEsta 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 de la entrada del usuario, adecuadas 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 aparecen primero (por ejemplo, "restaurante"). Los términos de la dirección aparecen de mayor a menor especificidad. Por ejemplo, "San Francisco" y "CA". |
place_id
opcional |
Tipo:
string optionalSolo está disponible si la predicción es un lugar. 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
google.maps.places.PredictionTerm
Representa un término de predicción.
Propiedades | |
|---|---|
offset |
Tipo:
numberEs el desplazamiento, en caracteres Unicode, del comienzo de este término en la descripción del lugar. |
value |
Tipo:
stringEs el valor de este término, por ejemplo, "Taco Bell". |
Interfaz PredictionSubstring
interfaz
google.maps.places.PredictionSubstring
Representa una subcadena de predicción.
Propiedades | |
|---|---|
length |
Tipo:
numberEs la longitud de la substring. |
offset |
Tipo:
numberEs el desplazamiento hasta el inicio de la subcadena dentro de la cadena de descripción. |
Interfaz StructuredFormatting
interfaz
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 substrings coincidentes de la entrada de autocompletado, identificadas por un desplazamiento y una longitud, expresados en caracteres Unicode.
Propiedades | |
|---|---|
main_text |
Tipo:
stringEsta es la parte principal del texto de la descripción sin formato del lugar que sugiere 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, adecuadas para destacar esas subcadenas. Cada subcadena se identifica con un desplazamiento y una longitud, expresados en caracteres Unicode. |
secondary_text |
Tipo:
stringEsta es la parte de texto secundaria de la descripción sin formato del lugar que sugiere el servicio de Places. Por lo general, es la ubicación del lugar. |