Interface AutocompleteRequest
Interface
google.maps.places.AutocompleteRequest
Interface de solicitação para AutocompleteSuggestion.fetchAutocompleteSuggestions
.
Propriedades | |
---|---|
input |
Tipo:
string A string de texto em que pesquisar. |
includedPrimaryTypes optional |
Tipo:
Array<string> optional Incluiu o tipo de lugar principal (por exemplo, "restaurante" ou "posto_de_gasolina"). Um lugar só é retornado se o tipo principal dele estiver incluído nessa lista. É possível especificar até cinco valores. Se nenhum tipo for especificado, todos os tipos de lugar serão retornados. |
includedRegionCodes optional |
Tipo:
Array<string> optional Incluir apenas resultados nas regiões especificadas, especificadas como até 15 códigos de região de dois caracteres CLDR. Um conjunto vazio não restringe os resultados. Se locationRestriction e includedRegionCodes estiverem definidos, os resultados serão localizados na área de interseção. |
inputOffset optional |
Tipo:
number optional Um deslocamento de caractere Unicode com base em zero de input indicando a posição do cursor em input . A posição do cursor pode influenciar quais previsões são retornadas. Se não for especificado, o padrão será o comprimento de input . |
language optional |
Tipo:
string optional O idioma em que os resultados serão retornados. Vai usar a preferência de idioma do navegador. Os resultados podem estar em idiomas diferentes se o idioma usado em input for diferente de language ou se o lugar retornado não tiver uma tradução do idioma local para language . |
locationBias optional |
Tipo:
LocationBias optional Direciona os resultados para um local especificado. No máximo um de locationBias ou locationRestriction precisa ser definido. Se nenhum deles estiver definido, os resultados serão enviesados pelo endereço IP, ou seja, o endereço IP será mapeado para um local impreciso e usado como um sinal enviesado. |
locationRestriction optional |
Tipo:
LocationRestriction optional Restringir os resultados a um local especificado. No máximo um de locationBias ou locationRestriction precisa ser definido. Se nenhum deles estiver definido, os resultados serão enviesados pelo endereço IP, ou seja, o endereço IP será mapeado para um local impreciso e usado como um sinal enviesado. |
origin optional |
Tipo:
LatLng|LatLngLiteral optional O ponto de origem a partir do qual a distância geodésica é calculada até o destino (retornado como PlacePrediction.distanceMeters ). Se esse valor for omitido, a distância geodésica não será retornada. |
region optional |
Tipo:
string optional O código da região, especificado como um código de região CLDR de dois caracteres. Isso afeta a formatação do endereço, a classificação dos resultados e pode influenciar quais resultados são retornados. Isso não restringe os resultados à região especificada. |
sessionToken optional |
Tipo:
AutocompleteSessionToken optional Um token que identifica uma sessão de preenchimento automático para fins de faturamento. Gere um novo token de sessão usando AutocompleteSessionToken . A sessão começa quando o usuário começa a digitar uma consulta e termina quando ele seleciona um lugar e chama Place.fetchFields . Cada sessão pode ter várias consultas, seguidas por uma chamada fetchFields . As credenciais usadas para cada solicitação em uma sessão precisam pertencer ao mesmo projeto do console do Google Cloud. Após a conclusão de uma sessão, o token perde a validade. Seu app precisa gerar um novo token para cada sessão. Se o parâmetro sessionToken for omitido ou você reutilizar um token, a sessão vai ser cobrada como se nenhum token de sessão tivesse sido fornecido e cada solicitação será faturada separadamente. Recomendamos as seguintes diretrizes:
|
Classe AutocompleteSessionToken
Classe
google.maps.places.AutocompleteSessionToken
Representa um token de sessão usado para rastrear uma sessão de preenchimento automático.
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 . |
Classe AutocompleteSuggestion
Classe
google.maps.places.AutocompleteSuggestion
Um resultado de sugestão de preenchimento automático.
Acesse chamando const {AutocompleteSuggestion} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Métodos estáticos | |
---|---|
fetchAutocompleteSuggestions |
fetchAutocompleteSuggestions(autocompleteRequest) Parâmetros:
Valor de retorno:
Promise<{suggestions:Array<AutocompleteSuggestion>}> Busca uma lista de sugestões de preenchimento automático. |
Propriedades | |
---|---|
placePrediction |
Tipo:
PlacePrediction optional Contém o nome legível para o resultado retornado. Para resultados de estabelecimentos, geralmente é o nome e o endereço da empresa. |
Classe PlacePrediction
Classe
google.maps.places.PlacePrediction
Resultados da previsão de um lugar do Place Autocomplete.
Acesse chamando const {PlacePrediction} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
distanceMeters |
Tipo:
number optional O comprimento da geodésica em metros a partir de origin , se origin for especificado. |
mainText |
Tipo:
FormattableText optional Representa o nome do lugar. |
placeId |
Tipo:
string O identificador exclusivo do lugar sugerido. Esse identificador pode ser usado em outras APIs que aceitam IDs de lugar. |
secondaryText |
Tipo:
FormattableText optional Representa outros recursos de eliminação de ambiguidade (como uma cidade ou região) para identificar melhor o lugar. |
text |
Tipo:
FormattableText Contém o nome legível para o resultado retornado. Para resultados de estabelecimentos, geralmente é o nome e o endereço da empresa. text é recomendado para desenvolvedores que querem mostrar um único elemento da interface. Os desenvolvedores que querem mostrar dois elementos de interface separados, mas relacionados, podem usar PlacePrediction.mainText e PlacePrediction.secondaryText . |
types |
Tipo:
Array<string> Lista de tipos que se aplicam a esse lugar da Tabela A ou da Tabela B em https://developers.google.com/maps/documentation/places/web-service/place-types. |
Métodos | |
---|---|
toPlace |
toPlace() Parâmetros:nenhum
Valor de retorno:
Place Retorna uma representação do lugar dessa PlacePrediction. Uma chamada subsequente para Place.fetchFields é necessária para receber todos os detalhes do lugar. |
Classe StringRange
Classe
google.maps.places.StringRange
Identifica uma substring em um determinado texto.
Acesse chamando const {StringRange} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
endOffset |
Tipo:
number Deslocamento baseado em zero do último caractere Unicode da substring (exclusivo). |
startOffset |
Tipo:
number Deslocamento com base em zero do primeiro caractere Unicode da substring (inclusivo). |
Classe FormattableText
Classe
google.maps.places.FormattableText
Texto que representa uma previsão de lugar. O texto pode ser usado como está ou formatado.
Acesse chamando const {FormattableText} = await google.maps.importLibrary("places")
. Consulte Bibliotecas na API Maps JavaScript.
Propriedades | |
---|---|
matches |
Tipo:
Array<StringRange> Uma lista de intervalos de string que identificam onde a solicitação de entrada correspondeu a FormattableText.text . Os intervalos podem ser usados para formatar partes específicas de text . As subcadeias podem não ser correspondências exatas de AutocompleteRequest.input se a correspondência foi determinada por outros critérios além da correspondência de string (por exemplo, correções ortográficas ou transliterações). Esses valores são deslocamentos de caracteres Unicode de FormattableText.text . Os intervalos são ordenados em valores de deslocamento crescentes. |
text |
Tipo:
string Texto que pode ser usado como está ou formatado com FormattableText.matches . |