Places Autocomplete Service

Classe AutocompleteService

Classe google.maps.places.AutocompleteService

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

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

AutocompleteService
AutocompleteService()
Parâmetros: nenhum
Crie uma nova instância do AutocompleteService.
getPlacePredictions
getPlacePredictions(request[, callback])
Parâmetros:
Valor de retorno:Promise<AutocompleteResponse>
Recupera as 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 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 a ser enviada para AutocompleteService.getPlacePredictions.

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

input
Tipo: string
O usuário inseriu uma string de entrada.
bounds optional
Limites para o viés de previsão. As previsões são tendenciosas em relação ao bounds, mas não restritas a ele. location e radius serão ignorados se bounds for definido.
componentRestrictions optional
Tipo:ComponentRestrictions optional
As restrições dos componentes. As restrições de componentes são usadas para restringir as previsões apenas àquelas dentro do componente pai. Por exemplo, o país.
location optional
Tipo:LatLng optional
Local para viés de previsão. As previsões serão direcionadas a 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
radius optional
Tipo: number optional
O raio da área usada para polarização da previsão. A radius é especificada em metros e precisa sempre ser acompanhada por uma propriedade location. Como alternativa, bounds pode ser usado.
sessionToken optional
Referência exclusiva usada para agrupar solicitações individuais em sessões.
types optional
Tipo:Array<string> optional
Os tipos de previsão a serem retornados. Para tipos compatíveis, consulte o Guia do desenvolvedor. Se nenhum tipo for especificado, todos os tipos serão retornados.

Classe AutocompleteResponse

Classe google.maps.places.AutocompleteResponse

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

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

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

input
Tipo:string
O usuário inseriu uma string de entrada.
bounds optional
Limites para o viés de previsão. As previsões são tendenciosas em relação ao bounds, mas não restritas a ele. location e radius serão ignorados se bounds for definido.
location optional
Tipo: LatLng optional
Local para viés de previsão. As previsões serão direcionadas a 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 polarização da previsão. A radius é especificada em metros e precisa sempre ser acompanhada 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 acompanhar uma sessão de preenchimento automático, que pode ser uma série de chamadas AutocompleteService.getPlacePredictions seguidas por uma única chamada PlacesService.getDetails.

Requer o parâmetro de URL &libraries=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.

Requer 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 ISO 3166-1 Alfa-2 do país, sem distinção entre maiúsculas e minúsculas). Por exemplo, 'us', 'br' ou 'au'. Você pode fornecer 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.

Requer 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 do Places.
matched_substrings
Um conjunto de substrings na descrição do lugar que corresponde aos 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 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
Tipo:Array<PredictionTerm>
São informações sobre termos individuais na descrição acima, desde a mais específica até 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.

Interface QueryAutocompletePrediction

Interface google.maps.places.QueryAutocompletePrediction

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

Requer 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 do Places.
matched_substrings
Um conjunto de substrings na descrição do lugar que corresponde aos 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 da mais para a menos específica. 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 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.

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

Requer 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, dividida 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.

Requer 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 do Places. Geralmente o nome do lugar.
main_text_matched_substrings
Tipo: Array<PredictionSubstring>
É um conjunto de substrings no texto principal que corresponde aos 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 Places. Geralmente a localização do lugar.