Places Autocomplete Service

Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.

Classe AutocompleteService

Classe google.maps.places.AutocompleteService

Contém métodos relacionados à recuperação de previsões do Autocomplete.

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

Ao usar v=beta, é possível chamar const {AutocompleteService} = await google.map.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.

AutocompleteService
AutocompleteService()
Parâmetros:nenhum
Cria uma nova instância de AutocompleteService.
getPlacePredictions
getPlacePredictions(request[, callback])
Parâmetros:
Valor de retorno: Promise<AutocompleteResponse>
Recupera as previsões de locais de preenchimento automático com base na solicitação de preenchimento automático fornecida.
getQueryPredictions
getQueryPredictions(request, callback)
Parâmetros:
Valor de retorno: nenhum
Recupera as previsões de preenchimento automático de consultas com base na solicitação de preenchimento automático de consulta fornecida.

Interface AutocompletionRequest

Interface google.maps.places.AutocompletionRequest

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

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

input
Tipo:string
O usuário inseriu a string de entrada.
bounds optional
Limites para a polarização de previsões. As previsões serão direcionadas, mas não restritas, ao bounds especificado. Tanto location quanto radius serão ignorados se bounds for definido.
componentRestrictions optional
Tipo: ComponentRestrictions optional
As restrições do componente. As restrições são usadas para restringir previsões apenas àquelas dentro do componente pai. Por exemplo, o país.
language optional
Tipo:string optional
Um identificador de idioma para o qual 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
Tipo:LatLng optional
Local para a polarização da previsão. As previsões serão enviesadas para os location e radius fornecidos. 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).
origin optional
Tipo: LatLng|LatLngLiteral optional
O local de onde AutocompletePrediction.distance_meters é calculado.
radius optional
Tipo: number optional
O raio da área usada para a polarização de previsões. 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 regional usado para formatar e filtrar resultados. As sugestões para este país não são restritas. O código de região aceita um valor de ccTLD ("domínio de nível superior") de dois caracteres. 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
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 retornadas. Para saber os tipos compatíveis, consulte o Guia do desenvolvedor. Se nenhum tipo for especificado, todos serão retornados.

Interface AutocompleteResponse

Interface google.maps.places.AutocompleteResponse

Uma resposta de Autocomplete retornada pela chamada para AutocompleteService.getPlacePredictions contendo uma lista de AutocompletePredictions.

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

predictions

Interface QueryAutocompletionRequest

Interface google.maps.places.QueryAutocompletionRequest

Uma solicitação QueryAutocompletion, para ser enviada ao QueryAutocompleteService.

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

input
Tipo: string
O usuário inseriu a string de entrada.
bounds optional
Limites para a polarização de previsões. As previsões serão direcionadas, mas não restritas, ao bounds especificado. Tanto location quanto radius serão ignorados se bounds for definido.
location optional
Tipo: LatLng optional
Local para a polarização da previsão. As previsões serão enviesadas para os location e radius fornecidos. 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 a polarização de previsões. O radius é especificado em metros e precisa ser sempre acompanhado por uma propriedade location. Como alternativa, bounds pode ser usado.

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.

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

Ao usar v=beta, é possível chamar const {AutocompleteSessionToken} = await google.map.importLibrary("places"). Consulte Bibliotecas na API Maps JavaScript.

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

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.

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

country optional
Tipo: string|Array<string> optional
Restringe previsões para o país especificado (código do país ISO 3166-1 Alpha-2, indiferente a maiúsculas). Por exemplo, 'us', 'br' ou 'au'. É possível fornecer apenas uma 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.

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

description
Tipo: string
Esta é a versão não formatada da consulta sugerida pelo serviço Places.
matched_substrings
Um conjunto de substrings na descrição do lugar que corresponde aos elementos na entrada do usuário, adequado para destacar essas 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
Informações estruturadas sobre a descrição do lugar, divididas em um texto principal e um texto secundário, incluindo uma matriz de substrings correspondentes da entrada de preenchimento automático, identificada por um deslocamento e um comprimento, expressos em caracteres Unicode.
terms
Informações sobre termos individuais na descrição acima, desde o mais específico até o menos específico. Por exemplo, "São Paulo", "Sérgio" e "SP".
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 da AutocompletionRequest.origin.

Interface QueryAutocompletePrediction

Interface google.maps.places.QueryAutocompletePrediction

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

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

description
Tipo: string
Esta é a versão não formatada da consulta sugerida pelo serviço Places.
matched_substrings
Um conjunto de substrings na descrição do lugar que corresponde aos elementos na entrada do usuário, adequado para destacar essas substrings. Cada substring é identificada por um deslocamento e um comprimento, expressos em caracteres Unicode.
terms
Informações sobre termos individuais na descrição acima. Os termos categóricos são os primeiros (por exemplo, "restaurante"). Os termos de endereço aparecem do mais específico para o menos específico. 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.

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

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

Interface PredictionSubstring.

Interface google.maps.places.PredictionSubstring

Representa uma substring de previsão.

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

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

interface StructuredFormat.

Interface google.maps.places.StructuredFormatting

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

Carregar usando o parâmetro de URL &libraries=places. Consulte Bibliotecas na API Maps JavaScript.

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