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 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 que se muestra:
Promise<AutocompleteResponse> Recupera predicciones de autocompletado de sitios según la solicitud de autocompletado proporcionada. |
getQueryPredictions |
getQueryPredictions(request, callback) Parámetros:
Valor que se muestra: Ninguno
Recupera predicciones de autocompletado de consultas según la solicitud de autocompletado de consultas proporcionada. |
Interfaz de AutocompletionRequest
Interfaz de google.maps.places.AutocompletionRequest
Una solicitud de autocompletado para enviar a AutocompleteService.getPlacePredictions
.
Propiedades | |
---|---|
input |
Tipo:
string El usuario ingresó una string de entrada. |
|
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Límites de personalización de predicciones Las predicciones estarán inclinadas a la bounds determinada, pero no se limitarán a ella. 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 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 los resultados en el idioma seleccionado tengan una clasificación más alta, pero las sugerencias no están restringidas para este idioma. Consulta la lista de idiomas compatibles. |
|
Tipo:
LatLng optional Ubicación de la personalización de predicciones Las predicciones se inclinarán hacia la location y la radius determinadas. Como alternativa, se puede usar bounds . |
locationBias optional |
Tipo:
LocationBias optional Sugerencia o límite flexible que se debe usar cuando se buscan lugares |
locationRestriction optional |
Tipo:
LocationRestriction optional Limita los resultados de la búsqueda. |
offset optional |
Tipo:
number optional La posición de caracteres en el término introducido que el servicio utiliza en el texto para las 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 . |
|
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 por 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 de resultados y el filtrado de resultados No restringe las sugerencias a este país. El código de la 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 |
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 admitidos, 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
.
Propiedades | |
---|---|
predictions |
Tipo:
Array<AutocompletePrediction> La lista de AutocompletePrediction . |
QueryAutocompletionRequest.
Interfaz de google.maps.places.QueryAutocompletionRequest
Es una solicitud de autocompletado de consultas que se enviará a QueryAutocompleteService
.
Propiedades | |
---|---|
input |
Tipo:
string El usuario ingresó una string de entrada. |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Límites de personalización de predicciones Las predicciones estarán inclinadas a la bounds determinada, pero no se limitarán a ella. location y radius se ignorarán si se configura bounds . |
location optional |
Tipo:
LatLng optional Ubicación de la personalización de predicciones Las predicciones se inclinarán hacia la location y la radius determinadas. Como alternativa, se puede usar bounds . |
offset optional |
Tipo:
number optional La posición de caracteres en el término introducido que el servicio utiliza en el texto para las 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 por 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 de PlacesService.getDetails
.
Para acceder, llama a const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
. Consulta Bibliotecas en la API de Maps JavaScript.
Constructor | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Parámetros: Ninguno
Crea una instancia nueva de AutocompleteSessionToken . |
Interfaz 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 Alpha-2, que no distingue entre mayúsculas y minúsculas). Por ejemplo, 'us' , 'br' o 'au' . Puedes proporcionar una sola string de array de hasta cinco. |
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 de Places. |
matched_substrings |
Tipo:
Array<PredictionSubstring> Un conjunto de substrings en la descripción del lugar que coincide con elementos de la entrada del usuario, adecuado para usar a fin de destacar esas substrings. Cada substring se identifica con un desplazamiento y una longitud, expresadas 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 |
Tipo:
StructuredFormatting Información estructurada sobre la descripción del lugar, dividida en un texto principal y uno secundario, como un array de substrings coincidentes de la entrada de autocompletado, identificadas con un desplazamiento y una longitud, expresadas en caracteres Unicode. |
terms |
Tipo:
Array<PredictionTerm> Incluye información sobre términos individuales en 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 array de tipos a los que pertenece la predicción, por ejemplo, 'establishment' o 'geocode' . |
distance_meters optional |
Tipo:
number optional Indica 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.
Propiedades | |
---|---|
description |
Tipo:
string Esta es la versión sin formato de la consulta que sugiere el servicio de Places. |
matched_substrings |
Tipo:
Array<PredictionSubstring> Un conjunto de substrings en la descripción del lugar que coincide con elementos de la entrada del usuario, adecuado para usar a fin de destacar esas substrings. Cada substring se identifica con un desplazamiento y una longitud, expresadas en caracteres Unicode. |
terms |
Tipo:
Array<PredictionTerm> Incluye información sobre términos individuales en la descripción anterior. Los términos categóricos van primero (por ejemplo, "restaurante"). Las condiciones de la dirección aparecen de la 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. 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 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.
Propiedades | |
---|---|
length |
Tipo:
number La longitud de la substring |
offset |
Tipo:
number El desplazamiento desde el inicio de la substring dentro de la string de descripción. |
Interfaz StructuredFormat
Interfaz de google.maps.places.StructuredFormatting
Contiene información estructurada sobre la descripción del lugar, dividida en un texto principal y uno secundario, como un array de substrings coincidentes de la entrada de autocompletado, identificadas con 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 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 substrings del texto principal que coinciden con elementos de la entrada del usuario, adecuadas para usarlas a fin de destacar esas substrings. Cada substring se identifica con un desplazamiento y una longitud, expresadas en caracteres Unicode. |
secondary_text |
Tipo:
string Esta es la parte de texto secundario de la descripción sin formato del lugar sugerido por el servicio de Places. Por lo general, es la ubicación del lugar. |