AutocompleteRequest
Interface google.maps.places.AutocompleteRequest
Interface de solicitação para AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Propriedades | |
---|---|
input |
Tipo:
string A string de texto na qual pesquisar. |
includedPrimaryTypes optional |
Tipo:
Array<string> optional Tipo de lugar principal incluído (por exemplo, "restaurante" ou "posto de gasolina"). Um lugar só é retornado se o tipo principal dele está incluído nessa lista. É possível especificar até cinco valores. Se nenhum tipo for especificado, todos eles vão ser retornados. |
includedRegionCodes optional |
Tipo:
Array<string> optional Inclua apenas resultados nas regiões especificadas, como até 15 códigos de região CLDR de dois caracteres. Um conjunto vazio não restringe os resultados. Se locationRestriction e includedRegionCodes forem definidos, os resultados serão localizados na área de interseção. |
inputOffset optional |
Tipo:
number optional Um deslocamento de caracteres Unicode baseado em zero de input que indica a posição do cursor em input . A posição do cursor pode influenciar quais previsões são retornadas. Se não for especificado, o padrão será o comprimento de input . |
language optional |
Tipo:
string optional O idioma no qual os resultados serão retornados. O padrão será a preferência de idioma do navegador. Os resultados podem estar em idiomas mistos se o idioma usado em input for diferente de language ou se o lugar retornado não tiver uma tradução do idioma local para language . |
locationBias optional |
Tipo:
LocationBias optional Direciona os resultados para um local específico. Defina no máximo locationBias ou locationRestriction . Se nenhum deles for definido, os resultados serão polarizados pelo endereço IP, o que significa que o endereço IP será mapeado para um local incorreto e usado como um sinal de polarização. |
locationRestriction optional |
Tipo:
LocationRestriction optional Restringir os resultados a um local específico. Defina no máximo locationBias ou locationRestriction . Se nenhum deles for definido, os resultados serão polarizados pelo endereço IP, o que significa que o endereço IP será mapeado para um local incorreto e usado como um sinal de polarização. |
origin optional |
Tipo:
LatLng|LatLngLiteral optional O ponto de origem a partir do qual calcular a distância geodésica até o destino (retornado como PlacePrediction.distanceMeters ). Se esse valor for omitido, a distância geodésica não será retornada. |
region optional |
Tipo:
string optional O código regional, especificado como um código de região CLDR de dois caracteres. Isso afeta a formatação do endereço, a classificação dos resultados e pode influenciar os resultados retornados. Isso não restringe os resultados à região especificada. |
sessionToken optional |
Tipo:
AutocompleteSessionToken optional Token que identifica uma sessão de preenchimento automático para fins de faturamento. Gere um novo token de sessão via AutocompleteSessionToken . A sessão começa quando o usuário começa a digitar uma consulta e termina quando ele seleciona um lugar e chama Place.fetchFields . Cada sessão pode ter várias consultas, seguidas por uma chamada fetchFields . As credenciais usadas para cada solicitação em uma sessão precisam pertencer ao mesmo projeto do console do Google Cloud. Após o término de uma sessão, o token não é mais válido. Seu aplicativo deve gerar um novo token para cada sessão. Se o parâmetro sessionToken for omitido ou você reutilizar um token, a sessão vai ser cobrada como se nenhum token de sessão tivesse sido fornecido (cada solicitação será faturada separadamente). Recomendamos as seguintes diretrizes:
|
AutocompleteSessionToken
Classe
google.maps.places.AutocompleteSessionToken
Representa um token de sessão usado para rastrear uma sessão de preenchimento automático.
Acesse chamando const {AutocompleteSessionToken} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Construtor | |
---|---|
AutocompleteSessionToken |
AutocompleteSessionToken() Parâmetros: nenhum
Cria uma nova instância do AutocompleteSessionToken . |
Classe AutocompleteSuggestion
Classe
google.maps.places.AutocompleteSuggestion
Um resultado de sugestão de preenchimento automático.
Acesse chamando const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Métodos estáticos | |
---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest) Parâmetros:
Valor de retorno:
Promise<{suggestions:Array<AutocompleteSuggestion>}> Busca uma lista de AutocompleteSuggestions. |
Propriedades | |
---|---|
placePrediction |
Tipo:
PlacePrediction optional Contém o nome legível do resultado retornado. Para resultados de estabelecimentos, geralmente é o nome e o endereço da empresa. |
PlacePrediction
Classe
google.maps.places.PlacePrediction
Resultados da previsão de uma previsão do Place Autocomplete.
Acesse chamando const {PlacePrediction} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
distanceMeters |
Tipo:
number optional O comprimento da geodésica em metros a partir de origin , se origin for especificado. |
mainText |
Tipo:
FormattableText optional Representa o nome do local. |
placeId |
Tipo:
string O identificador exclusivo do lugar sugerido. Esse identificador pode ser usado em outras APIs que aceitam IDs de lugar. |
secondaryText |
Tipo:
FormattableText optional Representa recursos adicionais de desambiguação (como uma cidade ou região) para identificar ainda mais o lugar. |
text |
Tipo:
FormattableText Contém o nome legível do resultado retornado. Para resultados de estabelecimentos, geralmente é o nome e o endereço da empresa. A text é recomendada para desenvolvedores que querem mostrar um único elemento da interface. Os desenvolvedores que quiserem mostrar dois elementos da interface separados, mas relacionados, podem usar PlacePrediction.mainText e PlacePrediction.secondaryText . |
types |
Tipo:
Array<string> Lista de tipos aplicáveis a esse lugar da Tabela A ou B em https://developers.google.com/maps/documentation/places/web-service/place-types. |
Métodos | |
---|---|
toPlace |
toPlace() Parâmetros: nenhum
Valor de retorno:
Place Retorna uma representação de Place desse PlacePrediction. Uma chamada subsequente para Place.fetchFields é necessária para acessar todos os detalhes do lugar. |
StringRange
Classe
google.maps.places.StringRange
Identifica uma substring em um texto específico.
Acesse chamando const {StringRange} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
endOffset |
Tipo:
number Deslocamento baseado em zero do último caractere Unicode da substring (exclusivo). |
startOffset |
Tipo:
number Deslocamento baseado em zero do primeiro caractere Unicode da substring (inclusive). |
FormattableText
Classe
google.maps.places.FormattableText
Texto que representa uma previsão de lugar. O texto pode ser usado no estado em que se encontra ou formatado.
Acesse chamando const {FormattableText} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
matches |
Tipo:
Array<StringRange> Uma lista de intervalos de strings que identificam onde a solicitação de entrada correspondeu em FormattableText.text . Os intervalos podem ser usados para formatar partes específicas de text . As substrings podem não ser correspondências exatas de AutocompleteRequest.input se a correspondência tiver sido determinada por critérios diferentes da correspondência de strings (por exemplo, correções ortográficas ou transliterações). Esses valores são deslocamentos de caracteres Unicode de FormattableText.text . Os intervalos serão ordenados em valores crescentes de deslocamento. |
text |
Tipo:
string Texto que pode ser usado no estado em que se encontra ou formatado com FormattableText.matches . |