Interfaz AutocompleteRequest
Interfaz de google.maps.places.AutocompleteRequest
Interfaz de solicitud para AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Propiedades | |
---|---|
input |
Tipo:
string Es la cadena de texto en la que se realizará la búsqueda. |
includedPrimaryTypes optional |
Tipo:
Array<string> optional Se incluyó el tipo de lugar principal (por ejemplo, "restaurante" o "gas_station"). Solo se muestra un lugar si su tipo principal se incluye en esta lista. Se pueden especificar hasta 5 valores. Si no se especifican tipos, se muestran todos los tipos de Place. |
includedRegionCodes optional |
Tipo:
Array<string> optional Solo incluye resultados en las regiones especificadas, que se indican como hasta 15 códigos de región de dos caracteres CLDR. Un conjunto vacío no restringirá los resultados. Si se configuran locationRestriction y includedRegionCodes , los resultados se ubicarán en el área de intersección. |
inputOffset optional |
Tipo:
number optional Un desplazamiento de caracteres Unicode basado en cero de input que indica la posición del cursor en input . La posición del cursor puede influir en las predicciones que se muestran. Si no se especifica, el valor predeterminado es la longitud de input . |
language optional |
Tipo:
string optional Es el idioma en el que se mostrarán los resultados. Se establecerá de forma predeterminada en la preferencia de idioma del navegador. Los resultados pueden estar en idiomas mixtos si el idioma que se usa en input es diferente de language o si el lugar que se muestra no tiene una traducción del idioma local a language . |
locationBias optional |
Tipo:
LocationBias optional Personaliza los resultados según una ubicación específica. Se debe configurar uno de locationBias o locationRestriction como máximo. Si no se configura ninguno, los resultados se sesgarán por dirección IP, lo que significa que la dirección IP se asignará a una ubicación imprecisa y se usará como un indicador de sesgo. |
locationRestriction optional |
Tipo:
LocationRestriction optional Restringe los resultados a una ubicación especificada. Se debe configurar uno de locationBias o locationRestriction como máximo. Si no se configura ninguno, los resultados se sesgarán por dirección IP, lo que significa que la dirección IP se asignará a una ubicación imprecisa y se usará como un indicador de sesgo. |
origin optional |
Tipo:
LatLng|LatLngLiteral optional Es el punto de origen desde el que se calcula la distancia geodésica hasta el destino (se muestra como PlacePrediction.distanceMeters ). Si se omite este valor, no se mostrará la distancia geodésica. |
region optional |
Tipo:
string optional Es el código de región, especificado como un código de región de dos caracteres del CLDR. Esto afecta el formato de las direcciones, la clasificación de los resultados y puede influir en los resultados que se muestran. Esto no restringe los resultados a la región especificada. |
sessionToken optional |
Tipo:
AutocompleteSessionToken optional Es un token que identifica una sesión de Autocomplete para realizar la facturación. Genera un nuevo token de sesión a través de AutocompleteSessionToken . La sesión comienza cuando el usuario comienza a escribir una consulta y termina cuando selecciona un lugar y llama a Place.fetchFields . Cada sesión puede tener varias búsquedas, seguidas de una llamada a fetchFields . Las credenciales que se usan para cada solicitud dentro de una sesión deben pertenecer al mismo proyecto de la consola de Google Cloud. Una vez que finaliza la sesión, el token deja de ser válido. Tu app debe generar un token nuevo para cada sesión. Si se omite el parámetro sessionToken , o si reutilizas un token de sesión, la sesión se cobrará como si no se hubiera proporcionado un token de sesión (cada solicitud se factura por separado). Te recomendamos que sigas los siguientes lineamientos:
|
Clase AutocompleteSessionToken
Clase google.maps.places.AutocompleteSessionToken
Representa un token de sesión que se usa para hacer un seguimiento de una sesión de Autocomplete.
Para acceder, llama a const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
. Consulta Bibliotecas de la API de Maps JavaScript.
Constructor | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Parámetros: Ninguno
Crea una instancia nueva de AutocompleteSessionToken . |
Clase AutocompleteSuggestion
Clase google.maps.places.AutocompleteSuggestion
Un resultado de la sugerencia de Autocomplete.
Para acceder, llama a const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
. Consulta Bibliotecas de la API de Maps JavaScript.
Métodos estáticos | |
---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest) Parámetros:
Valor que se muestra:
Promise<{suggestions:Array<AutocompleteSuggestion>}> Recupera una lista de AutocompleteSuggestions. |
Propiedades | |
---|---|
placePrediction |
Tipo:
PlacePrediction optional Contiene el nombre legible por humanos del resultado que se muestra. En el caso de los resultados de establecimientos, suele ser el nombre y la dirección de la empresa. |
Clase PlacePrediction
Clase google.maps.places.PlacePrediction
Resultados de la predicción de Place Autocomplete.
Para acceder, llama a const {PlacePrediction} = await google.maps.importLibrary("places")
. Consulta Bibliotecas de la API de Maps JavaScript.
Propiedades | |
---|---|
distanceMeters |
Tipo:
number optional Es la longitud de la geodésica en metros desde origin si se especifica origin . |
mainText |
Tipo:
FormattableText optional Representa el nombre del lugar. |
placeId |
Tipo:
string Es el identificador único del lugar sugerido. Este identificador se puede usar en otras APIs que aceptan IDs de Place. |
secondaryText |
Tipo:
FormattableText optional Representa características adicionales que permiten desambiguar (como una ciudad o una región) para identificar mejor el lugar. |
text |
Tipo:
FormattableText Contiene el nombre legible por humanos del resultado que se muestra. En el caso de los resultados de establecimientos, suele ser el nombre y la dirección de la empresa. Se recomienda text para los desarrolladores que desean mostrar un solo elemento de la IU. Los desarrolladores que deseen mostrar dos elementos de IU separados, pero relacionados, pueden usar PlacePrediction.mainText y PlacePrediction.secondaryText . |
types |
Tipo:
Array<string> Es la lista de tipos que se aplican a este lugar de la tabla A o la tabla B en https://developers.google.com/maps/documentation/places/web-service/place-types. |
Métodos | |
---|---|
toPlace |
toPlace() Parámetros: Ninguno
Valor que se muestra:
Place Muestra una representación de Place de esta PlacePrediction. Se requiere una llamada posterior a Place.fetchFields para obtener los detalles completos del lugar. |
Clase StringRange
Clase google.maps.places.StringRange
Identifica una subcadena dentro de un texto determinado.
Para acceder, llama a const {StringRange} = await google.maps.importLibrary("places")
. Consulta Bibliotecas de la API de Maps JavaScript.
Propiedades | |
---|---|
endOffset |
Tipo:
number Desplazamiento a partir de cero del último carácter Unicode de la subcadena (exclusivo). |
startOffset |
Tipo:
number Es el desplazamiento basado en cero del primer carácter Unicode de la subcadena (inclusivo). |
Clase FormattableText
Clase google.maps.places.FormattableText
Es el texto que representa una predicción de Place. El texto se puede usar tal como está o con formato.
Para acceder, llama a const {FormattableText} = await google.maps.importLibrary("places")
. Consulta Bibliotecas de la API de Maps JavaScript.
Propiedades | |
---|---|
matches |
Tipo:
Array<StringRange> Es una lista de rangos de cadenas que identifican dónde coincidió la solicitud de entrada en FormattableText.text . Los rangos se pueden usar para dar formato a partes específicas de text . Es posible que las subcadenas no sean coincidencias exactas de AutocompleteRequest.input si la coincidencia se determinó por criterios distintos de la concordancia de cadenas (por ejemplo, correcciones ortográficas o transliteraciones). Estos valores son compensaciones de caracteres Unicode de FormattableText.text . Se garantiza que los rangos se ordenen en valores de desplazamiento crecientes. |
text |
Tipo:
string Es un texto que se puede usar tal como está o con formato FormattableText.matches . |