Places Autocomplete Service (deprecated)

Classe AutocompleteService

classe google.maps.places.AutocompleteService
biblioteca "places"

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

const {AutocompleteService} = await google.maps.importLibrary("places");
AutocompleteService
AutocompleteService()
Parâmetros: nenhum
Cria uma nova instância de AutocompleteService.
getPlacePredictions
getPlacePredictions(request[, callback])
Parâmetros:
Valor de retorno: Promise<AutocompleteResponse>
Recupera previsões de preenchimento automático de lugares com base na solicitação fornecida.
getQueryPredictions
getQueryPredictions(request, callback)
Parâmetros:
Valor de retorno: nenhum
Recupera previsões de preenchimento automático de consulta com base na solicitação fornecida.

Interface AutocompletionRequest

interface google.maps.places.AutocompletionRequest

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

input
Tipo: string
A string de entrada inserida pelo usuário.
bounds
opcional
Limites para o 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
opcional
Tipo: ComponentRestrictions optional
As restrições do componente. As restrições de componente são usadas para limitar as previsões apenas àquelas dentro do componente pai. Por exemplo, o país.
language
opcional
Tipo: string optional
Um identificador do 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
opcional
Tipo: LatLng optional
Local para viés de previsão. As previsões serão tendenciosas em relação ao location e ao radius fornecidos. Como alternativa, é possível usar bounds.
locationBias
opcional
Tipo: LocationBias optional
Um limite flexível ou uma dica para usar ao pesquisar lugares.
locationRestriction
opcional
Tipo: LocationRestriction optional
Limites para restringir os resultados da pesquisa.
offset
opcional
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
opcional
Tipo: LatLng|LatLngLiteral optional
O local de onde AutocompletePrediction.distance_meters é calculado.
radius
opcional
Tipo: number optional
O raio da área usada para o viés de previsão. O radius é especificado em metros e precisa sempre ser acompanhado por uma propriedade location. Como alternativa, é possível usar bounds.
region
opcional
Tipo: string optional
Um código de região usado para formatação e filtragem de resultados. Ele não restringe as sugestões a esse país. O código de região 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), enquanto o código ISO 3166-1 é "gb" (tecnicamente para a entidade "Reino Unido da Grã-Bretanha e Irlanda do Norte").
sessionToken
opcional
Referência exclusiva usada para agrupar solicitações individuais em sessões.
types
opcional
Tipo: Array<string> optional
Os tipos de previsões que serão retornados. Para ver os tipos compatíveis, consulte o guia do desenvolvedor. Se nenhum tipo for especificado, todos os tipos serão retornados.

Interface AutocompleteResponse

interface google.maps.places.AutocompleteResponse

Uma resposta do Autocomplete retornada pela chamada para AutocompleteService.getPlacePredictions que contém uma lista de AutocompletePredictions.

predictions

Interface QueryAutocompletionRequest

interface google.maps.places.QueryAutocompletionRequest

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

input
Tipo: string
A string de entrada inserida pelo usuário.
bounds
opcional
Limites para o 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
opcional
Tipo: LatLng optional
Local para viés de previsão. As previsões serão tendenciosas em relação ao location e ao radius fornecidos. Como alternativa, é possível usar bounds.
offset
opcional
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
opcional
Tipo: number optional
O raio da área usada para o viés de 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.

country
opcional
Tipo: string|Array<string> optional
Restringe as previsões ao país especificado (código de país ISO 3166-1 Alpha-2, sem diferenciação de maiúsculas e minúsculas). Por exemplo, 'us', 'br' ou 'au'. É possível 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.

description
Tipo: string
É 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 correspondem 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.
place_id
Tipo: string
Um ID de lugar que pode ser usado para recuperar detalhes sobre esse lugar usando o serviço Place Details (consulte PlacesService.getDetails).
structured_formatting
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
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
opcional
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.

description
Tipo: string
É 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 correspondem 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.
terms
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 do mais específico para o menos específico. Por exemplo, "San Francisco" e "CA".
place_id
opcional
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 Place Details (consulte PlacesService.getDetails).

Interface PredictionTerm

interface google.maps.places.PredictionTerm

Representa um termo de previsão.

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.

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.

main_text
Tipo: string
É 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
Um conjunto de substrings no texto principal que correspondem a elementos na entrada do usuário, adequadas para destacar essas substrings. Cada substring é identificada por um deslocamento e um comprimento, expressos em caracteres Unicode.
secondary_text
Tipo: string
É a parte de texto secundária da descrição não formatada do lugar sugerido pelo serviço do Places. Geralmente, o local do lugar.