AutocompleteService
Classe
google.maps.places.AutocompleteService
Contém métodos relacionados à recuperação de previsões do Autocomplete.
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 de AutocompleteService . |
Métodos | |
---|---|
getPlacePredictions |
getPlacePredictions(request[, callback]) Parâmetros:
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:
Valor de retorno: nenhum
Recupera as previsões de preenchimento automático de consulta com base na solicitação de preenchimento automático de consulta fornecida. |
AutocompletionRequest (em inglês)
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 digitou uma string de entrada. |
|
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Limites para a polarização da previsão. As previsões serão tendenciosas, mas não restritas, à bounds determinada. Tanto location quanto radius serão ignorados se bounds for definido. |
componentRestrictions optional |
Tipo:
ComponentRestrictions optional As restrições do componente. As restrições de componentes 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 idioma no 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. |
|
Tipo:
LatLng optional Local para a polarização da previsão. As previsões serão direcionadas aos location e radius fornecidos. Como alternativa, bounds pode ser usado. |
locationBias optional |
Tipo:
LocationBias optional Um limite flexível ou uma dica 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 inserido, 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. |
|
Tipo:
number optional O raio da área usada para polarização de previsões. O radius é especificado em metros e sempre precisa ser 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 formatação e filtragem de resultados. Isso não restringe as sugestões a este país. 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 |
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 retornadas. Para tipos suportados, 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 AutocompletePrediction
s.
Propriedades | |
---|---|
predictions |
Tipo:
Array<AutocompletePrediction> A lista de AutocompletePrediction s. |
QueryAutocompletionRequest.
Interface google.maps.places.QueryAutocompletionRequest
Uma solicitação QueryAutocompletion a ser enviada ao QueryAutocompleteService
.
Propriedades | |
---|---|
input |
Tipo:
string O usuário digitou uma string de entrada. |
bounds optional |
Tipo:
LatLngBounds|LatLngBoundsLiteral optional Limites para a polarização da previsão. As previsões serão tendenciosas, mas não restritas, à bounds determinada. 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 direcionadas aos location e radius fornecidos. Como alternativa, bounds pode ser usado. |
offset optional |
Tipo:
number optional A posição do caractere no termo inserido, 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ões. O radius é especificado em metros e sempre precisa ser 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
.
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 do componente que podem ser usadas com o serviço de preenchimento automático.
Propriedades | |
---|---|
country optional |
Tipo:
string|Array<string> optional Restringe as previsões para o país especificado (código ISO 3166-1 Alpha-2 do país, sem distinção entre maiúsculas e minúsculas). Por exemplo, 'us' , 'br' ou 'au' . Você pode fornecer um único código ou uma matriz de até cinco strings de código de país. |
AutocompletePrediction.
Interface google.maps.places.AutocompletePrediction
Representa uma única previsão de preenchimento automático.
Propriedades | |
---|---|
description |
Tipo:
string Essa é 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 corresponde a elementos na entrada do usuário, adequado para uso ao destacar essas substrings. Cada substring é identificada por um deslocamento e um comprimento, expressos em caracteres unicode. |
place_id |
Tipo:
string Um ID de local 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 local, 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 |
Tipo:
Array<PredictionTerm> Informações sobre termos individuais na descrição acima, da mais específica para a 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 a partir do AutocompletionRequest.origin . |
QueryAutocompletePrediction.
Interface google.maps.places.QueryAutocompletePrediction
Representa uma única previsão de preenchimento automático de consulta.
Propriedades | |
---|---|
description |
Tipo:
string Essa é 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 corresponde a elementos na entrada do usuário, adequado para uso ao destacar essas 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 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 Francisco" e "CA". |
place_id optional |
Tipo:
string optional Disponível apenas se a previsão for um lugar. Um ID de local que pode ser usado para recuperar detalhes sobre esse lugar usando o serviço de detalhes do lugar (consulte PlacesService.getDetails ). |
PredictionTerm.
Interface google.maps.places.PredictionTerm
Representa um termo de previsão.
Propriedades | |
---|---|
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". |
PredictionSubstring.
Interface google.maps.places.PredictionSubstring
Representa uma substring de previsão.
Propriedades | |
---|---|
length |
Tipo:
number O tamanho da substring. |
offset |
Tipo:
number O deslocamento para o início da substring dentro da string de descrição. |
StructuredFormatting.
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 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 não formatada do lugar sugerido pelo serviço Places. Normalmente é o nome do lugar. |
main_text_matched_substrings |
Tipo:
Array<PredictionSubstring> Um conjunto de substrings no texto principal que corresponde a elementos na entrada do usuário, adequado para uso ao destacar essas 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 do Google Places. Normalmente, é a localização do lugar. |