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,
  "pageSize": integer,
  "pageToken": string,
  "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
(deprecated)

integer

Obsoleto: use pageSize.

O número máximo de resultados por página que podem ser retornados. Se o número de resultados disponíveis for maior que maxResultCount, será retornado um nextPageToken que poderá ser transmitido para pageToken para acessar a próxima página de resultados nas solicitações subsequentes. Se 0 ou nenhum valor for fornecido, o padrão será 20. O valor máximo é 20. Valores maiores serão convertidos para 20. Valores negativos retornarão um erro INVALID_ARGUMENT.

Se maxResultCount e pageSize forem especificados, maxResultCount será ignorado.
pageSize

integer

Opcional. O número máximo de resultados por página que podem ser retornados. Se o número de resultados disponíveis for maior que pageSize, será retornado um nextPageToken que poderá ser transmitido para pageToken para acessar a próxima página de resultados nas solicitações subsequentes. Se 0 ou nenhum valor for fornecido, o padrão será 20. O valor máximo é 20. Valores acima de 20 serão definidos como 20. Valores negativos retornarão um erro INVALID_ARGUMENT.

Se maxResultCount e pageSize forem especificados, maxResultCount será ignorado.
pageToken

string

Opcional. Um token de página, recebido de uma chamada anterior da TextSearch. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os parâmetros, exceto pageToken, pageSize e maxResultCount fornecidos para o TextSearch, precisam corresponder à chamada inicial que forneceu o token de página. Caso contrário, 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)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string
}
Campos
places[]

object (Place)

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

object (ContextualContent)

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes.

Uma lista de conteúdo contextual em que cada entrada é associada ao local correspondente no mesmo índice no campo "places". O conteúdo que é relevante para textQuery na solicitação tem preferência. Se o conteúdo contextual não estiver disponível para um dos locais, ele retornará conteúdo não contextual. Ela só vai ficar vazia quando o conteúdo não estiver disponível para esse lugar. Essa lista deve ter o mesmo número de entradas que a lista de lugares, se solicitado.
nextPageToken

string

Um token que pode ser enviado como pageToken para recuperar a próxima página. Se este campo for omitido ou estiver vazio, não haverá páginas subsequentes.

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.

ContextualContent

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes.

Conteúdo contextual para a consulta de local.

Representação JSON 
{
  "reviews": [
    {
      object (Review)
    }
  ],
  "photos": [
    {
      object (Photo)
    }
  ],
  "justifications": [
    {
      object (Justification)
    }
  ]
}
Campos
reviews[]

object (Review)

Lista de avaliações sobre esse lugar, semelhantes à consulta de local.
photos[]

object (Photo)

Informações (incluindo referências) sobre fotos deste local, relacionadas à consulta de local.
justifications[]

object (Justification)

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes.

Justificativas para o lugar.

Justificativa

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes.

Justificativas para o lugar. As justificativas respondem à pergunta sobre por que um lugar poderia interessar um usuário final.

Representação JSON 
{

  // Union field justification can be only one of the following:
  "reviewJustification": {
    object (ReviewJustification)
  },
  "businessAvailabilityAttributesJustification": {
    object (BusinessAvailabilityAttributesJustification)
  }
  // End of list of possible types for union field justification.
}
Campos

Campo de união justification.

justification pode ser apenas de um dos tipos a seguir:
reviewJustification

object (ReviewJustification)

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes.
businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes.

ReviewJustification

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes.

Justificativas da avaliação do usuário. Isso destaca uma seção da avaliação que seria interessante para um usuário final. Por exemplo, se a consulta de pesquisa for "pizza de lenha", a justificativa da revisão destacará o texto relevante para a consulta.

Representação JSON 
{
  "highlightedText": {
    object (HighlightedText)
  },
  "review": {
    object (Review)
  }
}
Campos
highlightedText

object (HighlightedText)
review

object (Review)

A avaliação da qual o texto destacado é gerado.

HighlightedText

O texto destacado pela justificativa. Esse é um subconjunto da avaliação em si. A palavra exata a ser destacada é marcada pela HighlightedTextRange. Pode haver várias palavras no texto destacado.

Representação JSON 
{
  "text": string,
  "highlightedTextRanges": [
    {
      object (HighlightedTextRange)
    }
  ]
}
Campos
text

string
highlightedTextRanges[]

object (HighlightedTextRange)

A lista de intervalos do texto destacado.

HighlightedTextRange

O intervalo do texto destacado.

Representação JSON 
{
  "startIndex": integer,
  "endIndex": integer
}
Campos
startIndex

integer
endIndex

integer

BusinessAvailabilityAttributesJustification

Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes. Justificativas de BusinessAvailabilityAttributes. Isso mostra alguns atributos de uma empresa que podem interessar um usuário final.

Representação JSON 
{
  "takeout": boolean,
  "delivery": boolean,
  "dineIn": boolean
}
Campos
takeout

boolean

Se um lugar oferece opções de retirada para viagem.
delivery

boolean

Se um lugar oferece entrega.
dineIn

boolean

Se um lugar oferece refeição no local.