- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- LocationBias
- LocationRestriction
- Sugestão
- PlacePrediction
- FormattableText
- StringRange
- StructuredFormat
- QueryPrediction
Retorna previsões para a entrada especificada.
Solicitação HTTP
POST https://places.googleapis.com/v1/places:autocomplete
O URL usa a sintaxe de transcodificação gRPC.
Corpo da solicitação
O corpo da solicitação contém dados com a seguinte estrutura:
Representação JSON |
---|
{ "input": string, "locationBias": { object ( |
Campos | |
---|---|
input |
Obrigatório. A string de texto na qual pesquisar. |
locationBias |
Opcional. Direciona os resultados para um local específico. Defina no máximo |
locationRestriction |
Opcional. Restringir os resultados a um local específico. Defina no máximo |
includedPrimaryTypes[] |
Opcional. Inclusão do tipo de lugar principal (por exemplo, "restaurante" ou "posto de gasolina") da Tabela A ou B nos Tipos de lugar (https://developers.google.com/maps/documentation/places/web-service/place-types), ou apenas (regiões) ou apenas (cidades). Um lugar só é retornado se seu tipo principal está incluído nessa lista. É possível especificar até cinco valores. Se nenhum tipo for especificado, todos eles vão ser retornados. |
includedRegionCodes[] |
Opcional. Inclua apenas resultados nas regiões especificadas, como até 15 códigos de região CLDR de dois caracteres. Um conjunto vazio não restringe os resultados. Se |
languageCode |
Opcional. O idioma no qual os resultados serão retornados. O padrão é "en-US". Os resultados podem estar em idiomas mistos se o idioma usado em |
regionCode |
Opcional. O código regional, 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 os resultados retornados. Isso não restringe os resultados à região especificada. Para restringir os resultados a uma região, use |
origin |
Opcional. O ponto de origem a partir do qual calcular a distância geodésica até o destino (retornado como |
inputOffset |
Opcional. Um deslocamento de caracteres Unicode baseado em zero de Se estiver vazio, o padrão será o comprimento de |
includeQueryPredictions |
Opcional. Se for "true", a resposta vai incluir previsões de Place e Query. Caso contrário, a resposta retornará apenas previsões de lugares. |
sessionToken |
Opcional. String que identifica uma sessão de preenchimento automático para fins de faturamento. Precisa ser uma string base64 segura para URL e nome de arquivo com no máximo 36 caracteres ASCII. Caso contrário, será retornado um erro INVALID_MCC. A sessão começa quando o usuário começa a digitar uma consulta e termina quando ele seleciona um lugar e uma chamada para Place Details ou Address Validation é feita. Cada sessão pode ter várias consultas, seguidas por uma solicitação de Place Details ou Address Validation. 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 aplicativo precisa gerar um novo token para cada sessão. Se o parâmetro Recomendamos as seguintes diretrizes:
|
Corpo da resposta
Proto de resposta para places.Autocomplete.
Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:
Representação JSON |
---|
{
"suggestions": [
{
object ( |
Campos | |
---|---|
suggestions[] |
Contém uma lista de sugestões, ordenadas em ordem decrescente de relevância. |
LocationBias
A região a ser pesquisada. Os resultados podem ser polarizados em torno da região especificada.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
rectangle |
Uma janela de visualização definida pelos cantos nordeste e sudoeste. |
circle |
Um círculo definido por um ponto central e um raio. |
LocationRestriction
A região a ser pesquisada. Os resultados serão restritos à região especificada.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
rectangle |
Uma janela de visualização definida pelos cantos nordeste e sudoeste. |
circle |
Um círculo definido por um ponto central e um raio. |
Sugestão
Um resultado de sugestão de preenchimento automático.
Representação JSON |
---|
{ // Union field |
Campos | |
---|---|
Campo de união
|
|
placePrediction |
Uma previsão para um lugar. |
queryPrediction |
Uma previsão para uma consulta. |
PlacePrediction
Resultados da previsão de uma previsão do Place Autocomplete.
Representação JSON |
---|
{ "place": string, "placeId": string, "text": { object ( |
Campos | |
---|---|
place |
O nome do recurso do lugar sugerido. Esse nome pode ser usado em outras APIs que aceitam nomes de lugares. |
placeId |
O identificador exclusivo do lugar sugerido. Esse identificador pode ser usado em outras APIs que aceitam IDs de lugar. |
text |
Contém o nome legível do resultado retornado. Para resultados de estabelecimentos, geralmente é o nome e o endereço da empresa. A Esse texto pode ser diferente do Pode estar em idiomas mistos se a solicitação |
structuredFormat |
Um detalhamento da previsão do lugar em texto principal contendo o nome do lugar e texto secundário contendo outros recursos de desambiguação (como uma cidade ou região). O |
types[] |
Lista de tipos aplicáveis a esse lugar da Tabela A ou B em https://developers.google.com/maps/documentation/places/web-service/place-types. Um tipo é uma categorização de um lugar. Os lugares com tipos compartilhados têm características parecidas. |
distanceMeters |
O comprimento da geodésica em metros a partir de |
FormattableText
Texto que representa um lugar ou previsão de consulta. O texto pode ser usado no estado em que se encontra ou formatado.
Representação JSON |
---|
{
"text": string,
"matches": [
{
object ( |
Campos | |
---|---|
text |
Texto que pode ser usado no estado em que se encontra ou formatado com |
matches[] |
Uma lista de intervalos de strings que identificam onde a solicitação de entrada correspondeu em Esses valores são deslocamentos de caracteres Unicode de |
StringRange
Identifica uma substring em um texto específico.
Representação JSON |
---|
{ "startOffset": integer, "endOffset": integer } |
Campos | |
---|---|
startOffset |
Deslocamento baseado em zero do primeiro caractere Unicode da string (inclusive). |
endOffset |
Deslocamento baseado em zero do último caractere Unicode (exclusivo). |
StructuredFormat
Contém um detalhamento de um lugar ou previsão de consulta em texto principal e secundário.
Para previsões de lugar, o texto principal contém o nome específico do lugar. Para previsões de consulta, o texto principal contém a consulta.
O texto secundário contém outros recursos de desambiguação (como cidade ou região) para identificar melhor o lugar ou refinar a consulta.
Representação JSON |
---|
{ "mainText": { object ( |
Campos | |
---|---|
mainText |
Representa o nome do local ou da consulta. |
secondaryText |
Representa recursos adicionais de desambiguação (como uma cidade ou região) para identificar melhor o lugar ou refinar a consulta. |
QueryPrediction
Resultados da previsão de uma previsão do Query Autocomplete.
Representação JSON |
---|
{ "text": { object ( |
Campos | |
---|---|
text |
O texto previsto. Esse texto não representa um lugar, mas sim uma consulta de texto que pode ser usada em um endpoint de pesquisa (por exemplo, Text Search). A Pode estar em idiomas mistos se as solicitações |
structuredFormat |
Um detalhamento da previsão da consulta no texto principal contendo a consulta e o texto secundário com outros recursos que podem não ser ambíguos (como uma cidade ou região). O |