Method: places.searchText

Pesquisa de local baseada em consulta de texto.

Solicitação HTTP

POST https://places.googleapis.com/v1/places:searchText

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 
{
  "textQuery": string,
  "languageCode": string,
  "regionCode": string,
  "rankPreference": enum (RankPreference),
  "includedType": string,
  "openNow": boolean,
  "minRating": number,
  "maxResultCount": integer,
  "priceLevels": [
    enum (PriceLevel)
  ],
  "strictTypeFiltering": boolean,
  "locationBias": {
    object (LocationBias)
  },
  "locationRestriction": {
    object (LocationRestriction)
  },
  "evOptions": {
    object (EVOptions)
  }
}
Campos
textQuery

string

Obrigatório. A consulta de texto para pesquisa textual.
languageCode

string

Os detalhes do lugar serão exibidos com o idioma preferido, se disponível. Se o código do idioma não for especificado ou não for reconhecido, detalhes do lugar de qualquer idioma podem ser retornados, com preferência pelo inglês, se esses detalhes existirem.

Lista atual de idiomas compatíveis: https://developers.google.com/maps/faq#languagesupport.
regionCode

string

O código de país/região Unicode (CLDR) do local de origem da solicitação. Esse parâmetro é usado para exibir os detalhes do lugar, como o nome específico da região, se disponíveis. O parâmetro pode afetar os resultados com base na legislação aplicável.

Para mais informações, consulte https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

No momento, não é possível usar códigos de região com três dígitos.
rankPreference

enum (RankPreference)

Como os resultados serão classificados na resposta.
includedType

string

O tipo de lugar solicitado. Lista completa dos tipos compatíveis: https://developers.google.com/maps/documentation/places/web-service/place-types. Suporte apenas a um tipo incluído.
openNow

boolean

Usado para restringir a pesquisa a lugares que estão abertos no momento. O valor padrão é falso.
minRating

number

Filtre resultados cuja avaliação média de usuários seja estritamente menor que esse limite. Um valor válido precisa ser uma flutuação entre 0 e 5 (inclusive) em uma cadência de 0,5, ou seja, [0, 0,5, 1,0, ... , 5,0]. A classificação de entrada será arredondada para o 0,5(teto) mais próximo. Por exemplo, uma classificação de 0,6 eliminará todos os resultados com uma classificação inferior a 1,0.
maxResultCount

integer

Número máximo de resultados a serem retornados. Esse valor precisa estar entre 1 e 20, inclusive. O padrão é 20. Se o número não for definido, ele voltará para o limite superior. Se o número for definido como negativo ou exceder o limite superior, um erro INVALID_ARGUMENT será retornado.
priceLevels[]

enum (PriceLevel)

Usado para restringir a pesquisa a lugares marcados como determinados níveis de preço. Os usuários podem escolher qualquer combinação de níveis de preço. O padrão é selecionar todos os níveis de preço.
strictTypeFiltering

boolean

Usado para definir a filtragem de tipo restrito para includeType. Se definido como verdadeiro, apenas resultados do mesmo tipo serão retornados. O padrão é "false".
locationBias

object (LocationBias)

A região a ser pesquisada. Esse local serve como um viés, o que significa que os resultados relacionados a uma determinada localização podem ser retornados. Não pode ser definido com locationRestriction.
locationRestriction

object (LocationRestriction)

A região a ser pesquisada. Esse local serve como uma restrição, o que significa que resultados fora do local fornecido não serão retornados. Não pode ser definido com locationBias.
evOptions

object (EVOptions)

Opcional. Defina as opções de VE pesquisáveis de uma solicitação de pesquisa de lugar.

Corpo da resposta

Protocolo de resposta para places.searchText.

Se bem-sucedido, o corpo da resposta incluirá dados com a estrutura a seguir:

Representação JSON 
{
  "places": [
    {
      object (Place)
    }
  ]
}
Campos
places[]

object (Place)

Uma lista de lugares que atendem aos critérios de pesquisa de texto do usuário.

RankPreference

Como os resultados serão classificados na resposta.

Enums
RANK_PREFERENCE_UNSPECIFIED Para uma consulta categórica como "Restaurantes em Nova York", RELEVANCE é o padrão. Para consultas não categóricas, como "Mountain View, CA", recomendamos que você deixe RankPreference não definido.
DISTANCE Classifica os resultados por distância.
RELEVANCE Classifica os resultados por relevância. Ordem de classificação determinada pela pilha de classificação normal.

LocationBias

A região a ser pesquisada. Esse local serve como um viés, o que significa que os resultados relacionados a uma determinada localização podem ser retornados.

Representação JSON 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  },
  "circle": {
    object (Circle)
  }
  // End of list of possible types for union field type.
}
Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
rectangle

object (Viewport)

Uma caixa retangular definida pelos cantos nordeste e sudoeste. rectangle.high() precisa ser o ponto nordeste da janela de visualização retangular. rectangle.low() precisa ser o ponto sudoeste da janela de visualização retangular. rectangle.low().latitude() não pode ser maior que rectangle.high().latitude(). Isso resultará em um intervalo de latitude vazio. A largura de uma janela de visualização retangular não pode ultrapassar 180 graus.
circle

object (Circle)

Um círculo definido por um ponto central e um raio.

LocationRestriction

A região a ser pesquisada. Esse local serve como uma restrição, o que significa que resultados fora do local fornecido não serão retornados.

Representação JSON 
{

  // Union field type can be only one of the following:
  "rectangle": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Campos

Campo de união type.

type pode ser apenas de um dos tipos a seguir:
rectangle

object (Viewport)

Uma caixa retangular definida pelos cantos nordeste e sudoeste. rectangle.high() precisa ser o ponto nordeste da janela de visualização retangular. rectangle.low() precisa ser o ponto sudoeste da janela de visualização retangular. rectangle.low().latitude() não pode ser maior que rectangle.high().latitude(). Isso resultará em um intervalo de latitude vazio. A largura de uma janela de visualização retangular não pode ultrapassar 180 graus.

EVOptions

Opções de VE pesquisáveis de uma solicitação de pesquisa de lugar.

Representação JSON 
{
  "minimumChargingRateKw": number,
  "connectorTypes": [
    enum (EVConnectorType)
  ]
}
Campos
minimumChargingRateKw

number

Opcional. Taxa de carregamento mínima necessária em quilowatts. Um lugar com uma taxa de carregamento menor que a taxa especificada é filtrado.
connectorTypes[]

enum (EVConnectorType)

Opcional. A lista de tipos de conectores de VE preferidos. Um local que não suporta nenhum dos tipos de conector listados é filtrado.