Clase AutocompleteSuggestion
Clase google.maps.places.AutocompleteSuggestion
Es el resultado de una sugerencia de autocompletar.
Llama al const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Métodos estáticos | |
---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest) Parámetros:
Valor de devolución:
Promise<{suggestions:Array<AutocompleteSuggestion>}> Recupera una lista de AutocompleteSuggestions. Si se proporciona un AutocompleteRequest.sessionToken en la solicitud, ese token de sesión se incluirá automáticamente cuando se llame a Place.fetchFields por primera vez, en cada Place que devuelva PlacePrediction.toPlace en los PlacePrediction s resultantes. |
Propiedades | |
---|---|
placePrediction |
Tipo:
PlacePrediction optional Contiene el nombre legible del resultado devuelto. En el caso de los resultados de establecimientos, suele ser el nombre y la dirección de la empresa. Si se proporcionó un AutocompleteRequest.sessionToken en el AutocompleteRequest que se usó para recuperar este AutocompleteSuggestion, el mismo token se incluirá automáticamente cuando se llame a Place.fetchFields por primera vez en el Place que muestra una llamada a PlacePrediction.toPlace . |
Interfaz de AutocompleteRequest
Interfaz de google.maps.places.AutocompleteRequest
Es la 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 Es el Tipo de lugar principal incluido (por ejemplo, "restaurant" o "gas_station"). Solo se devuelve un lugar si su tipo principal se incluye en esta lista. Se pueden especificar hasta 5 valores. Si no se especifican tipos, se devuelven todos los tipos de Place. |
includedRegionCodes optional |
Tipo:
Array<string> optional Solo se incluyen los resultados de las regiones especificadas, que se indican con hasta 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 Es 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 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 varios idiomas si el idioma que se usa en input es diferente de language o si el lugar devuelto no tiene una traducción del idioma local a language . |
locationBias optional |
Tipo:
LocationBias optional Personaliza los resultados según una ubicación especificada. Se debe establecer como máximo uno de los parámetros locationBias o locationRestriction . Si no se configura ninguno de los dos, los resultados se personalizarán según la 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 personalización. |
locationRestriction optional |
Tipo:
LocationRestriction optional Restringe los resultados a una ubicación especificada. Se debe establecer como máximo uno de los parámetros locationBias o locationRestriction . Si no se configura ninguno de los dos, los resultados se personalizarán según la 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 personalización. |
origin optional |
Tipo:
LatLng|LatLngLiteral optional Es el punto de origen desde el que se calcula la distancia geodésica hasta el destino (se devuelve como PlacePrediction.distanceMeters ). Si se omite este valor, no se devolverá 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, 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 fines de facturación. Genera un token de sesión nuevo a través de AutocompleteSessionToken . La sesión comienza cuando el usuario comienza a escribir una búsqueda 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 Google Cloud Console. 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). Cuando se proporciona un token de sesión en la solicitud a AutocompleteSuggestion.fetchAutocompleteSuggestions , el mismo token se incluirá automáticamente en la primera llamada a fetchFields en un Place que se devuelva llamando a PlacePrediction.toPlace en uno de los AutocompleteSuggestion s resultantes. Recomendamos 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 autocompletado.
Llama al const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Constructor | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Parámetros: Ninguno
Crea una instancia nueva de AutocompleteSessionToken . |
Clase PlacePrediction
Clase google.maps.places.PlacePrediction
Son los resultados de la predicción de Place Autocomplete.
Llama al const {PlacePrediction} = await google.maps.importLibrary("places")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
distanceMeters |
Tipo:
number optional 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 acepten IDs de lugar. |
secondaryText |
Tipo:
FormattableText optional Representa características adicionales de desambiguación (como una ciudad o una región) para identificar aún más el lugar. |
text |
Tipo:
FormattableText Contiene el nombre legible del resultado devuelto. 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 la IU separados, pero relacionados, pueden usar PlacePrediction.mainText y PlacePrediction.secondaryText en su lugar. |
types |
Tipo:
Array<string> Es la lista de tipos que se aplican a este lugar, según la tabla A o la tabla B en https://developers.google.com/maps/documentation/places/web-service/place-types. |
Métodos | |
---|---|
|
fetchAddressValidation(request) Parámetros:
Valor de devolución:
Promise<AddressValidation> Envía una solicitud de Address Validation asociada a esta sesión de Autocomplete (internamente, completa la solicitud con el token de sesión de Autocomplete). No se incluye automáticamente información de lugares de PlacePrediction. Este es un método conveniente para ayudar con la administración de sesiones de Autocomplete. |
toPlace |
toPlace() Parámetros: Ninguno
Valor de devolución:
Place Devuelve una representación de Place de este PlacePrediction. Se requiere una llamada posterior a Place.fetchFields para obtener los detalles completos del lugar. Si se proporcionó un AutocompleteRequest.sessionToken en el AutocompleteRequest que se usó para recuperar este PlacePrediction, se incluirá automáticamente el mismo token cuando se llame a fetchFields. Como alternativa, cuando se usa PlaceAutocompleteElement , la primera llamada a Place.fetchFields en un Place que devuelve PlacePrediction.toPlace incluirá automáticamente el token de sesión. |
Clase StringRange
Clase google.maps.places.StringRange
Identifica una subcadena dentro de un texto determinado.
Llama al const {StringRange} = await google.maps.importLibrary("places")
para acceder.
Consulta Bibliotecas en la API de Maps JavaScript.
Propiedades | |
---|---|
endOffset |
Tipo:
number Es el desplazamiento basado en 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 substring (inclusive). |
Clase FormattableText
Clase google.maps.places.FormattableText
Es el texto que representa una predicción de lugar. El texto se puede usar tal como está o con formato.
Llama al const {FormattableText} = await google.maps.importLibrary("places")
para acceder.
Consulta Bibliotecas en 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 formatear partes específicas de text . Es posible que las subcadenas no coincidan exactamente con AutocompleteRequest.input si la coincidencia se determinó según 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 se ordenan en valores de desplazamiento crecientes. |
text |
Tipo:
string Texto que se puede usar tal como está o con formato FormattableText.matches . |