Autocomplete Data

Classe AutocompleteSuggestion

google.maps.places.AutocompleteSuggestion classe
biblioteca "places"

Um resultado de sugestão de preenchimento automático.

const {AutocompleteSuggestion} = await google.maps.importLibrary("places");

Métodos estáticos

fetchAutocompleteSuggestions

fetchAutocompleteSuggestions(autocompleteRequest) Parâmetros: autocompleteRequest: AutocompleteRequest 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 PlacePredictions resultantes.

Propriedades

placePrediction somente leitura

Tipo: PlacePrediction optional Contém o nome legível por humanos 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 essa 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.
futureOpeningBusinessesIncluded opcional	Tipo: boolean optional Inclua previsões de lugares para empresas que ainda não estão abertas, mas que devem abrir no futuro.
includedPrimaryTypes opcional	Tipo: Array<string> optional Tipo de lugar principal incluído (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 opcional	Tipo: Array<string> optional Inclua 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 forem definidos, os resultados vão estar na área de interseção.
inputOffset opcional	Tipo: number optional Um deslocamento de caractere Unicode baseado 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 tamanho de input.
language opcional	Tipo: string optional O idioma em que 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 opcional	Tipo: LocationBias optional Direciona os resultados para um local especificado. No máximo, um de locationBias ou locationRestriction deve ser definido. Se nenhum deles for definido, os resultados serão influenciados pelo endereço IP, o que significa que o endereço IP será mapeado para um local impreciso e usado como um indicador de influência.
locationRestriction opcional	Tipo: LocationRestriction optional Restringe os resultados a um local especificado. No máximo, um de locationBias ou locationRestriction deve ser definido. Se nenhum deles for definido, os resultados serão influenciados pelo endereço IP, o que significa que o endereço IP será mapeado para um local impreciso e usado como um indicador de influência.
origin opcional	Tipo: LatLng|LatLngLiteral optional O ponto de origem para 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.
pureServiceAreaBusinessesIncluded opcional	Tipo: boolean optional Inclui empresas de serviço local se o campo estiver definido como verdadeiro. Uma empresa de serviço local que só atende no local do cliente faz visitas ou entregas, mas não atende clientes no endereço comercial dela. Por exemplo, prestadores de serviços de limpeza ou encanadores podem não ter um endereço físico ou local no Google Maps.
region opcional	Tipo: string optional O código da região, 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 opcional	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 de fetchFields. As credenciais usadas para cada solicitação em 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 AutocompleteSuggestions resultantes. Recomendamos as seguintes diretrizes: Use tokens de sessão em todas as chamadas do Place Autocomplete. Gere um novo token para cada sessão. Transmita um token de sessão exclusivo para cada sessão nova. Se você usar o mesmo token para mais de uma sessão, cada solicitação vai ser faturada individualmente.

Classe AutocompleteSessionToken

google.maps.places.AutocompleteSessionToken classe
biblioteca "places"

Representa um token de sessão usado para rastrear uma sessão de preenchimento automático.

const {AutocompleteSessionToken} = await google.maps.importLibrary("places");

Construtor
AutocompleteSessionToken	AutocompleteSessionToken() Parâmetros: nenhum Cria uma nova instância do AutocompleteSessionToken.

Classe PlacePrediction

google.maps.places.PlacePrediction classe
biblioteca "places"

Resultados de uma previsão de preenchimento automático do Place Autocomplete.

const {PlacePrediction} = await google.maps.importLibrary("places");

Propriedades
distanceMeters somente leitura	Tipo: number optional O comprimento da geodésica em metros de origin, se origin for especificado.
mainText somente leitura	Tipo: FormattableText optional Representa o nome do lugar.
placeId somente leitura	Tipo: string O identificador exclusivo do lugar sugerido. Esse identificador pode ser usado em outras APIs que aceitam IDs de lugar.
secondaryText somente leitura	Tipo: FormattableText optional Representa outros recursos de desambiguação (como uma cidade ou região) para identificar melhor o lugar.
text somente leitura	Tipo: FormattableText Contém o nome legível por humanos do resultado retornado. Para resultados de estabelecimentos, geralmente é o nome e o endereço da empresa. text é recomendado 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 somente leitura	Tipo: Array<string> Lista de tipos que se aplicam a este lugar da Tabela A ou B em https://developers.google.com/maps/documentation/places/web-service/place-types.

Métodos
fetchAddressValidation	Aviso: disponível apenas no canal v=beta. fetchAddressValidation(request) Parâmetros: request: AddressValidationRequest Valor de retorno: Promise<AddressValidation> Envia uma solicitação de Address Validation associada a essa 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 de conveniência para ajudar no gerenciamento de sessões do Autocomplete.
toPlace	toPlace() Parâmetros: nenhum Valor de retorno: Place Retorna uma representação Place desse PlacePrediction. Uma chamada subsequente para Place.fetchFields é necessária para receber os Place Details completos. Se um AutocompleteRequest.sessionToken foi fornecido no AutocompleteRequest usado para buscar essa 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

google.maps.places.StringRange classe
biblioteca "places"

Identifica uma substring em um determinado texto.

const {StringRange} = await google.maps.importLibrary("places");

Propriedades
endOffset somente leitura	Tipo: number Deslocamento baseado em zero do último caractere Unicode da substring (exclusivo).
startOffset somente leitura	Tipo: number Deslocamento baseado em zero do primeiro caractere Unicode da substring (inclusive).

Classe FormattableText

google.maps.places.FormattableText classe
biblioteca "places"

Texto que representa uma previsão de lugar. O texto pode ser usado como está ou formatado.

const {FormattableText} = await google.maps.importLibrary("places");

Propriedades
matches somente leitura	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 strings (por exemplo, correções ortográficas ou transliterações). Esses valores são deslocamentos de caracteres Unicode de FormattableText.text. Os intervalos são garantidos como ordenados em valores de deslocamento crescentes.
text somente leitura	Tipo: string Texto que pode ser usado como está ou formatado com FormattableText.matches.