AutocompleteRequest.
Interfaz google.maps.places.AutocompleteRequest
Interfaz de solicitud para AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Propiedades | |
---|---|
input |
Tipo:
string Cadena de texto en la que se realiza la búsqueda |
includedPrimaryTypes optional |
Tipo:
Array<string> optional Tipo de lugar principal incluido (por ejemplo, "restaurante" o "gas_station"). Un lugar solo se muestra 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 lugar. |
includedRegionCodes optional |
Tipo:
Array<string> optional Solo incluye resultados en las regiones especificadas, con un máximo de 15 códigos de región CLDR de dos caracteres. 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 El idioma en el que se mostrarán los resultados. Se establecerá la preferencia de idioma del navegador de forma predeterminada. Los resultados pueden estar en varios idiomas si el idioma utilizado en input es diferente de language o si el lugar que se muestra no tiene una traducción del idioma local al language . |
locationBias optional |
Tipo:
LocationBias optional Personalizar resultados en función de una ubicación específica Se debe establecer locationBias o locationRestriction como máximo. Si no se establece ninguna, los resultados se personalizarán según la dirección IP. Esto significa que la dirección IP se asignará a una ubicación imprecisa y se utilizará como señal de personalización. |
locationRestriction optional |
Tipo:
LocationRestriction optional Restringe los resultados a una ubicación específica. Se debe establecer locationBias o locationRestriction como máximo. Si no se establece ninguna, los resultados se personalizarán según la dirección IP. Esto significa que la dirección IP se asignará a una ubicación imprecisa y se utilizará como señal de personalización. |
origin optional |
Tipo:
LatLng|LatLngLiteral optional 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 CLDR de dos caracteres. Esto afecta el formato de la dirección y 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 Un token que identifica una sesión de Autocomplete con fines de facturación. Genera un token de sesión nuevo mediante AutocompleteSessionToken . La sesión se inicia cuando el usuario comienza a escribir una consulta y finaliza cuando selecciona un lugar y llama a Place.fetchFields . Cada sesión puede tener varias consultas, 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 los siguientes lineamientos:
|
AutocompleteSessionToken
Clase google.maps.places.AutocompleteSessionToken
Representa un token de sesión que se usa para hacer el seguimiento de una sesión de Autocomplete.
Para acceder, llama a const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
. Consulta el artículo 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 sugerencia de Autocomplete.
Para acceder, llama a const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
. Consulta el artículo 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 del resultado que se muestra. Para los resultados de establecimientos, suele incluir el nombre y la dirección de la empresa. |
PlacePrediction
Clase google.maps.places.PlacePrediction
Resultados de predicciones de Place Autocomplete.
Para acceder, llama a const {PlacePrediction} = await google.maps.importLibrary("places")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Propiedades | |
---|---|
distanceMeters |
Tipo:
number optional La longitud de la línea 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 lugar. |
secondaryText |
Tipo:
FormattableText optional Representa características adicionales que desambiguan (como una ciudad o región) para identificar mejor el lugar. |
text |
Tipo:
FormattableText Contiene el nombre legible del resultado que se muestra. Para los resultados de establecimientos, suele incluir el nombre y la dirección de la empresa. Se recomienda usar text para los desarrolladores que deseen mostrar un solo elemento de la IU. Es posible que los desarrolladores que deseen mostrar dos elementos de la IU separados, pero relacionados, quieran usar PlacePrediction.mainText y PlacePrediction.secondaryText en su lugar. |
types |
Tipo:
Array<string> Lista de los tipos que se aplican a este lugar de la Tabla A o de 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 lugar de esta PlacePrediction. Se requiere una llamada posterior a Place.fetchFields para obtener todos los detalles de Place. |
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 el artículo Bibliotecas de la API de Maps JavaScript.
Propiedades | |
---|---|
endOffset |
Tipo:
number Desplazamiento basado en cero del último carácter Unicode de la subcadena (exclusivo). |
startOffset |
Tipo:
number Desplazamiento basado en cero del primer carácter Unicode de la subcadena (inclusiva). |
FormattableText
Clase google.maps.places.FormattableText
Texto que representa una predicción de lugar. El texto se puede utilizar tal como está o con formato.
Para acceder, llama a const {FormattableText} = await google.maps.importLibrary("places")
. Consulta el artículo Bibliotecas de la API de Maps JavaScript.
Propiedades | |
---|---|
matches |
Tipo:
Array<StringRange> Una lista de rangos de cadenas que identifican el lugar en el que la solicitud de entrada coincidió en FormattableText.text . Los rangos se pueden usar para dar formato a partes específicas de text . Es posible que las substrings no sean coincidencias exactas de AutocompleteRequest.input si la coincidencia se determinó mediante criterios distintos de la coincidencia de cadenas (por ejemplo, correcciones ortográficas o transliteraciones). Estos valores son desplazamientos de caracteres Unicode de FormattableText.text . Se garantiza que los rangos están ordenados en valores de desplazamiento crecientes. |
text |
Tipo:
string Texto que se puede utilizar tal como está o que se puede utilizar con el formato FormattableText.matches . |