Classe AutocompleteSuggestion
Classe
google.maps.places.AutocompleteSuggestion
Um resultado de sugestão de preenchimento automático.
Acesse ligando para 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. Se um AutocompleteRequest.sessionToken for fornecido na solicitação, esse token de sessão será incluído automaticamente ao chamar Place.fetchFields pela primeira vez, em cada Place retornado por PlacePrediction.toPlace nos PlacePrediction s resultantes. |
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. Se um AutocompleteRequest.sessionToken foi fornecido no AutocompleteRequest usado para buscar esse AutocompleteSuggestion, o mesmo token será incluído automaticamente ao chamar Place.fetchFields pela primeira vez no Place retornado por uma chamada para PlacePrediction.toPlace . |
Interface AutocompleteRequest
Interface google.maps.places.AutocompleteRequest
Interface de solicitação para AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Propriedades | |
---|---|
input |
Tipo:
string A string de texto em que a pesquisa será feita. |
includedPrimaryTypes optional |
Tipo:
Array<string> optional Incluído o Tipo de lugar principal (por exemplo, "restaurant" ou "gas_station"). Um lugar só será retornado se o tipo principal dele estiver incluído nessa lista. É possível especificar até cinco valores. Se nenhum tipo for especificado, todos os tipos de lugar serão retornados. |
includedRegionCodes optional |
Tipo:
Array<string> optional Inclui apenas resultados nas regiões especificadas, que podem ser até 15 códigos de região de dois caracteres do CLDR. Um conjunto vazio não restringe os resultados. Se locationRestriction e includedRegionCodes estiverem definidos, os resultados vão estar na área de interseção. |
inputOffset optional |
Tipo:
number optional Um deslocamento de caractere Unicode com base em zero de input que indica a posição do cursor em input . A posição do cursor pode influenciar as previsões retornadas. Se não for especificado, o padrão será o comprimento de input . |
language optional |
Tipo:
string optional O idioma em que os resultados serão retornados. A configuração padrão é 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 Direcionamento dos resultados para um local especificado. No máximo um de locationBias ou locationRestriction deve ser definido. Se nenhum dos dois estiver definido, os resultados serão influenciados pelo endereço IP, ou seja, o endereço IP será mapeado para um local impreciso e usado como um indicador de viés. |
locationRestriction optional |
Tipo:
LocationRestriction optional Restringe os resultados a um local especificado. No máximo um de locationBias ou locationRestriction deve ser definido. Se nenhum dos dois estiver definido, os resultados serão influenciados pelo endereço IP, ou seja, o endereço IP será mapeado para um local impreciso e usado como um indicador de viés. |
origin optional |
Tipo:
LatLng|LatLngLiteral optional O ponto de origem de onde 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 da região, especificado como um código regional CLDR de dois caracteres. Isso afeta a formatação de endereços, a classificação dos resultados e pode influenciar quais resultados são retornados. Isso não restringe os resultados à região especificada. |
sessionToken optional |
Tipo:
AutocompleteSessionToken optional Um token que identifica uma sessão do Autocomplete para fins de faturamento. Gere um novo token de sessão usando 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 em cada solicitação dentro de uma sessão precisam pertencer ao mesmo projeto do Console do Google Cloud. Após a conclusão de uma sessão, o token perde a validade. Seu app precisa 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 e cada solicitação será faturada separadamente. Quando um token de sessão é fornecido na solicitação para AutocompleteSuggestion.fetchAutocompleteSuggestions , o mesmo token é incluído automaticamente na primeira chamada para fetchFields em um Place retornado ao chamar PlacePrediction.toPlace em um dos AutocompleteSuggestion s resultantes. Recomendamos as seguintes diretrizes:
|
Classe AutocompleteSessionToken
Classe
google.maps.places.AutocompleteSessionToken
Representa um token de sessão usado para rastrear uma sessão de preenchimento automático.
Acesse ligando para 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 PlacePrediction
Classe
google.maps.places.PlacePrediction
Resultados da previsão para uma previsão de preenchimento automático de lugares.
Acesse ligando para 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 de origin se origin for especificado. |
mainText |
Tipo:
FormattableText optional Representa o nome do lugar. |
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 outros recursos 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. O text é recomendado para desenvolvedores que querem mostrar um único elemento da interface. Os desenvolvedores que quiserem mostrar dois elementos de interface separados, mas relacionados, podem usar PlacePrediction.mainText e PlacePrediction.secondaryText . |
types |
Tipo:
Array<string> Lista de tipos que se aplicam a este lugar da Tabela A ou Tabela B em https://developers.google.com/maps/documentation/places/web-service/place-types. |
Métodos | |
---|---|
|
fetchAddressValidation(request) Parâmetros:
Valor de retorno:nenhum
Envia uma solicitação de Address Validation associada a esta sessão de preenchimento automático (preenchendo internamente a solicitação com o token de sessão de preenchimento automático). Nenhuma informação de lugar do PlacePrediction é incluída automaticamente. Esse é um método conveniente para ajudar no gerenciamento de sessões do Autocomplete. |
toPlace |
toPlace() Parâmetros:nenhum
Valor de retorno:
Place Retorna uma representação Place deste PlacePrediction. Uma chamada subsequente para Place.fetchFields é necessária para receber os detalhes completos do lugar. Se um AutocompleteRequest.sessionToken foi fornecido no AutocompleteRequest usado para buscar esse PlacePrediction, o mesmo token será incluído automaticamente ao chamar fetchFields. Como alternativa, ao usar PlaceAutocompleteElement , a primeira chamada para Place.fetchFields em um Place retornado por PlacePrediction.toPlace vai incluir automaticamente o token de sessão. |
Classe StringRange
Classe
google.maps.places.StringRange
Identifica uma substring em um determinado texto.
Acesse ligando para const {StringRange} = await google.maps.importLibrary("places")
.
Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
endOffset |
Tipo:
number Deslocamento de base zero do último caractere Unicode da substring (exclusivo). |
startOffset |
Tipo:
number Deslocamento com base em zero do primeiro caractere Unicode da substring (inclusive). |
Classe FormattableText
Classe
google.maps.places.FormattableText
Texto que representa uma previsão de lugar. O texto pode ser usado como está ou formatado.
Acesse ligando para 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 foi determinada por critérios diferentes da correspondência de string (por exemplo, correções ortográficas ou transliterações). Esses valores são deslocamentos de caracteres Unicode de FormattableText.text . Os intervalos são ordenados em valores de deslocamento crescente. |
text |
Tipo:
string Texto que pode ser usado como está ou formatado com FormattableText.matches . |