Places Autocomplete Service

Classe AutocompleteService

Classe google.maps.places.AutocompleteService

Contém métodos relacionados à recuperação de previsões de preenchimento automático.

Acesse chamando const {AutocompleteService} = await google.maps.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.

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

Métodos
getPlacePredictions	getPlacePredictions(request[, callback]) Parâmetros:  request:  AutocompletionRequest a solicitação de preenchimento automático. callback:  function(Array<AutocompletePrediction> optional, PlacesServiceStatus): void optional um callback que aceita uma matriz de objetos AutocompletePrediction e um valor de PlacesServiceStatus como argumento. Valor de retorno:  Promise<AutocompleteResponse> Recupera previsões de preenchimento automático de local com base na solicitação de preenchimento automático fornecida.
getQueryPredictions	getQueryPredictions(request, callback) Parâmetros:  request:  QueryAutocompletionRequest a solicitação de preenchimento automático de consulta. callback:  function(Array<QueryAutocompletePrediction> optional, PlacesServiceStatus): void um callback que aceita uma matriz de objetos QueryAutocompletePrediction e um valor PlacesServiceStatus como argumento. Valor de retorno: nenhum Recupera previsões de preenchimento automático de consultas com base na solicitação de preenchimento automático de consulta fornecida.

AutocompletionRequest.

Interface google.maps.places.AutocompletionRequest

Uma solicitação de preenchimento automático a ser enviada para AutocompleteService.getPlacePredictions.

Propriedades
input	Tipo:  string O usuário inseriu uma string de entrada.
bounds optional	Descontinuado:bounds foi descontinuado em maio de 2023. Use AutocompletionRequest.locationBias e AutocompletionRequest.locationRestriction. Tipo:  LatLngBounds|LatLngBoundsLiteral optional Limites para polarização de previsões. As previsões serão direcionadas, mas não restritas, à bounds especificada. Tanto location quanto radius serão ignorados se bounds estiver definido.
componentRestrictions optional	Tipo:  ComponentRestrictions optional Restrições de componentes. As restrições de componentes são usadas para restringir as previsões somente àquelas dentro do componente pai. Por exemplo, o país.
language optional	Tipo:  string optional Um identificador de idioma para o idioma em que os resultados devem ser retornados, se possível. Os resultados no idioma selecionado podem receber uma classificação mais alta, mas as sugestões não são restritas a esse idioma. Consulte a lista de idiomas compatíveis.
location optional	Descontinuado:location foi descontinuado em maio de 2023. Use AutocompletionRequest.locationBias e AutocompletionRequest.locationRestriction. Tipo:  LatLng optional Local para polarização de previsões. As previsões serão direcionadas para o location e o radius especificados. Como alternativa, bounds pode ser usado.
locationBias optional	Tipo:  LocationBias optional Um limite ou dica suave para usar ao pesquisar lugares.
locationRestriction optional	Tipo:  LocationRestriction optional Limites para restringir os resultados da pesquisa.
offset optional	Tipo:  number optional A posição do caractere no termo de entrada em que o serviço usa texto para previsões (a posição do cursor no campo de entrada).
origin optional	Tipo:  LatLng|LatLngLiteral optional O local de onde AutocompletePrediction.distance_meters é calculado.
radius optional	Descontinuado:radius foi descontinuado em maio de 2023. Use AutocompletionRequest.locationBias e AutocompletionRequest.locationRestriction. Tipo:  number optional O raio da área usada para polarização de previsão. O radius é especificado em metros e precisa ser sempre acompanhado por uma propriedade location. Como alternativa, bounds pode ser usado.
region optional	Tipo:  string optional Um código de região que é usado para formatar os resultados e filtrar os resultados. Ele não restringe as sugestões para este país. O código regional aceita um valor de dois caracteres ccTLD ("domínio de nível superior"). A maioria dos códigos ccTLD é idêntica aos códigos ISO 3166-1, com algumas exceções notáveis. Por exemplo, o ccTLD do Reino Unido é "uk" (.co.uk), enquanto o código ISO 3166-1 é "gb" (tecnicamente para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte").
sessionToken optional	Tipo:  AutocompleteSessionToken optional Referência exclusiva usada para agrupar solicitações individuais em sessões.
types optional	Tipo:  Array<string> optional Os tipos de previsões a serem retornados. Para os tipos compatíveis, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos os tipos serão retornados.

AutocompleteResponse

Interface google.maps.places.AutocompleteResponse

Uma resposta de preenchimento automático retornada pela chamada para AutocompleteService.getPlacePredictions contendo uma lista de AutocompletePredictions.

Propriedades
predictions	Tipo:  Array<AutocompletePrediction> A lista de AutocompletePredictions.

QueryAutocompletionRequest

Interface google.maps.places.QueryAutocompletionRequest

Uma solicitação QueryAutocompletion a ser enviada ao QueryAutocompleteService.

Propriedades
input	Tipo:  string O usuário inseriu uma string de entrada.
bounds optional	Tipo:  LatLngBounds|LatLngBoundsLiteral optional Limites para polarização de previsões. As previsões serão direcionadas, mas não restritas, à bounds especificada. Tanto location quanto radius serão ignorados se bounds estiver definido.
location optional	Tipo:  LatLng optional Local para polarização de previsões. As previsões serão direcionadas para o location e o radius especificados. Como alternativa, bounds pode ser usado.
offset optional	Tipo:  number optional A posição do caractere no termo de entrada em que o serviço usa texto para previsões (a posição do cursor no campo de entrada).
radius optional	Tipo:  number optional O raio da área usada para polarização de previsão. O radius é especificado em metros e precisa ser sempre acompanhado por uma propriedade location. Como alternativa, bounds pode ser usado.

Classe AutocompleteSessionToken

Classe google.maps.places.AutocompleteSessionToken

Representa um token de sessão usado para rastrear uma sessão de preenchimento automático, que pode ser uma série de chamadas AutocompleteService.getPlacePredictions seguidas por uma única chamada PlacesService.getDetails.

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.

ComponentRestrictions

Interface google.maps.places.ComponentRestrictions

Define as restrições de componentes que podem ser usadas com o serviço de preenchimento automático.

Propriedades
country optional	Tipo:  string|Array<string> optional Restringe as previsões ao país especificado (código do país ISO 3166-1 Alfa-2, indiferente a maiúsculas). Por exemplo, 'us', 'br' ou 'au'. Forneça um único código ou uma matriz de até cinco strings de código de país.

Interface AutocompletePrediction

Interface google.maps.places.AutocompletePrediction

Representa uma única previsão de preenchimento automático.

Propriedades
description	Tipo:  string Esta é a versão não formatada da consulta sugerida pelo serviço Places.
matched_substrings	Tipo:  Array<PredictionSubstring> Um conjunto de substrings na descrição do local que correspondem a elementos na entrada do usuário, adequado para uso no destaque dessas substrings. Cada substring é identificada por um deslocamento e um comprimento, expressos em caracteres Unicode.
place_id	Tipo:  string Um ID de lugar que pode ser usado para recuperar detalhes sobre esse local usando o serviço Place Details (consulte PlacesService.getDetails).
structured_formatting	Tipo:  StructuredFormatting Informações estruturadas sobre a descrição do lugar, divididas em um texto principal e um secundário, incluindo uma matriz de substrings correspondentes da entrada do preenchimento automático, identificadas por um deslocamento e um comprimento, expressos em caracteres Unicode.
terms	Tipo:  Array<PredictionTerm> Informações sobre termos individuais na descrição acima, do mais ao menos específico. Por exemplo, "Taco Bell", "Willitis" e "CA".
types	Tipo:  Array<string> Uma matriz de tipos a que a previsão pertence, por exemplo, 'establishment' ou 'geocode'.
distance_meters optional	Tipo:  number optional A distância em metros do lugar a partir do AutocompletionRequest.origin.

Interface QueryAutocompletePrediction

Interface google.maps.places.QueryAutocompletePrediction

Representa uma única previsão do Query Autocomplete.

Propriedades
description	Tipo:  string Esta é a versão não formatada da consulta sugerida pelo serviço Places.
matched_substrings	Tipo:  Array<PredictionSubstring> Um conjunto de substrings na descrição do local que correspondem a elementos na entrada do usuário, adequado para uso no destaque dessas substrings. Cada substring é identificada por um deslocamento e um comprimento, expressos em caracteres unicode.
terms	Tipo:  Array<PredictionTerm> Informações sobre termos individuais na descrição acima. Termos categóricos vêm primeiro (por exemplo, "restaurante"). Os termos de endereço aparecem do mais para o menos específico. Por exemplo, "São Francisco" e "CA".
place_id optional	Tipo:  string optional Disponível apenas se a previsão for um lugar. Um ID de lugar que pode ser usado para recuperar detalhes sobre esse local usando o serviço Place Details (consulte PlacesService.getDetails).

Interface PredictionTerm.

Interface google.maps.places.PredictionTerm

Representa um termo de previsão.

Propriedades
offset	Tipo:  number O deslocamento, em caracteres Unicode, do início do termo na descrição do local.
value	Tipo:  string O valor desse termo, por exemplo, "Taco Bell".

PredictionSubstring

Interface google.maps.places.PredictionSubstring

Representa uma substring de previsão.

Propriedades
length	Tipo:  number O comprimento da substring.
offset	Tipo:  number O deslocamento para o início da substring dentro da string de descrição.

Interface de StructuredFormatting (em inglês)

Interface google.maps.places.StructuredFormatting

Contém informações estruturadas sobre a descrição do local, divididas em um texto principal e um secundário, incluindo uma matriz de substrings correspondentes da entrada do preenchimento automático, identificadas por um deslocamento e um comprimento, expressos em caracteres Unicode.

Propriedades
main_text	Tipo:  string Esta é a parte principal do texto da descrição não formatada do lugar sugerido pelo serviço Places. Geralmente, o nome do lugar.
main_text_matched_substrings	Tipo:  Array<PredictionSubstring> Um conjunto de substrings no texto principal que correspondem a elementos na entrada do usuário, adequado para uso no destaque dessas substrings. Cada substring é identificada por um deslocamento e um comprimento, expressos em caracteres Unicode.
secondary_text	Tipo:  string Esta é a parte de texto secundária da descrição não formatada do lugar sugerido pelo serviço Places. Geralmente, a localização do lugar.