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 PlacesServiceStatus como argumento. Valor de retorno:Promise<AutocompleteResponse> Recupera previsões de preenchimento automático de lugares 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 da 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 consultas fornecida.

Interface AutocompletionRequest

Interface google.maps.places.AutocompletionRequest

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

Propriedades
input	Tipo:string O usuário inseriu a string de entrada.
bounds optional	Descontinuado:o bounds foi descontinuado em maio de 2023. Use AutocompletionRequest.locationBias e AutocompletionRequest.locationRestriction. Tipo:LatLngBounds|LatLngBoundsLiteral optional Limites para viés de previsão. As previsões serão direcionadas, mas não restritas, ao bounds fornecido. location e radius serão ignorados se bounds estiver definido.
componentRestrictions optional	Tipo:ComponentRestrictions optional As restrições do componente. As restrições de componente são usadas para restringir as previsões apenas às que estão no componente pai. Por exemplo, o país.
language optional	Tipo:string optional Um identificador de idioma para o idioma em que os resultados precisam ser retornados, se possível. Os resultados no idioma selecionado podem ter 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:o location foi descontinuado em maio de 2023. Use AutocompletionRequest.locationBias e AutocompletionRequest.locationRestriction. Tipo:LatLng optional Local para enviesar a previsão. As previsões serão tendenciosas em relação aos location e radius fornecidos. Como alternativa, é possível usar bounds.
locationBias optional	Tipo:LocationBias optional Um limite flexível ou sugestão a ser usado 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 origem de AutocompletePrediction.distance_meters.
radius optional	Descontinuado:o radius foi descontinuado em maio de 2023. Use AutocompletionRequest.locationBias e AutocompletionRequest.locationRestriction. Tipo:number optional O raio da área usada para enviesar a previsão. O radius é especificado em metros e precisa sempre ser acompanhado por uma propriedade location. Como alternativa, é possível usar bounds.
region optional	Tipo:string optional Um código de região usado para formatar e filtrar resultados. Ele não restringe as sugestões a esse país. O código regional aceita um valor de dois caracteres de 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), e 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 que serão retornados. Para saber quais tipos são aceitos, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos eles vão ser trazidos.

Interface 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.

Interface QueryAutocompletionRequest

Interface google.maps.places.QueryAutocompletionRequest

Uma solicitação de QueryAutocompletion a ser enviada para o QueryAutocompleteService.

Propriedades
input	Tipo:string O usuário inseriu a string de entrada.
bounds optional	Tipo:LatLngBounds|LatLngBoundsLiteral optional Limites para viés de previsão. As previsões serão direcionadas, mas não restritas, ao bounds fornecido. location e radius serão ignorados se bounds estiver definido.
location optional	Tipo:LatLng optional Local para enviesar a previsão. As previsões serão tendenciosas em relação aos location e radius fornecidos. Como alternativa, é possível usar bounds.
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 enviesar a previsão. O radius é especificado em metros e precisa sempre ser acompanhado por uma propriedade location. Como alternativa, é possível usar bounds.

Interface 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 de país ISO 3166-1 Alfa-2, sem distinção entre maiúsculas e minúsculas). Por exemplo, 'us', 'br' ou 'au'. Você pode fornecer uma única string 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 sem formatação da consulta sugerida pelo serviço Places.
matched_substrings	Tipo:Array<PredictionSubstring> Um conjunto de substrings na descrição do lugar 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 lugar usando o serviço de detalhes do lugar (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 de 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, da mais à menos específica. 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 em relação ao AutocompletionRequest.origin.

Interface QueryAutocompletePrediction

Interface google.maps.places.QueryAutocompletePrediction

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

Propriedades
description	Tipo:string Esta é a versão sem formatação da consulta sugerida pelo serviço Places.
matched_substrings	Tipo:Array<PredictionSubstring> Um conjunto de substrings na descrição do lugar 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. Os termos categóricos vêm primeiro (por exemplo, "restaurante"). Os termos de endereço aparecem da mais para a menos específica. Por exemplo, "São Paulo" e "SP".
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 lugar usando o serviço de detalhes do lugar (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 desse termo na descrição do lugar.
value	Tipo:string O valor desse termo, por exemplo, "Taco Bell".

Interface 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 na string de descrição.

Interface StructuredFormatting

Interface google.maps.places.StructuredFormatting

Contém 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 de preenchimento automático, identificadas por um deslocamento e um comprimento, expressos em caracteres Unicode.

Propriedades
main_text	Tipo:string Essa é a parte principal do texto da descrição sem formatação 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 Essa é a parte secundária da descrição sem formatação do lugar sugerido pelo serviço Places. Geralmente, o local do lugar.