Method: places.searchText

Pesquisa de lugar com base 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)
  },
  "routingParameters": {
    object (RoutingParameters)
  },
  "searchAlongRouteParameters": {
    object (SearchAlongRouteParameters)
  },
  "includePureServiceAreaBusinesses": boolean
}
Campos
textQuery

string

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

string

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

Lista atual de idiomas disponí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 mostrar os detalhes do lugar, como o nome específico da região, se disponível. 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 há suporte para códigos de região de três dígitos.
rankPreference

enum (RankPreference)

Como os resultados serão classificados na resposta.
includedType

string

O tipo de lugar solicitado. Lista completa de tipos aceitos: https://developers.google.com/maps/documentation/places/web-service/place-types. Só é possível usar 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

Filtra resultados cuja classificação média do usuário é estritamente menor que esse limite. Um valor válido precisa ser um número de ponto flutuante entre 0 e 5 (inclusive) em uma cadência de 0,5, ou seja, [0, 0,5, 1,0, ..., 5,0], inclusive. A classificação de entrada será arredondada para o 0,5 mais próximo(teto). Por exemplo, uma classificação de 0,6 elimina todos os resultados com uma classificação inferior a 1,0.
maxResultCount
(deprecated)

integer

Descontinuado: 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, um nextPageToken será retornado e poderá ser transmitido para pageToken para receber a próxima página de resultados em solicitações subsequentes. Se 0 ou nenhum valor for fornecido, o padrão 20 será usado. O valor máximo é 20. Valores acima disso serão convertidos para 20. Valores negativos retornam 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, um nextPageToken será retornado e poderá ser transmitido para pageToken para receber a próxima página de resultados em solicitações subsequentes. Se 0 ou nenhum valor for fornecido, o padrão 20 será usado. O valor máximo é 20. Valores acima de 20 serão definidos como 20. Valores negativos retornam 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 TextSearch anterior. Forneça isso para recuperar a página subsequente.

Ao paginar, todos os parâmetros fornecidos para TextSearch, exceto pageToken, pageSize e maxResultCount, precisam corresponder à chamada inicial que forneceu o token da página. Caso contrário, um erro INVALID_ARGUMENT será retornado.
priceLevels[]

enum (PriceLevel)

Usado para restringir a pesquisa a lugares marcados com 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 estrita para "includedType". Se definido como "true", 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 uma tendência, o que significa que resultados próximos ao local especificado 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 dele não serão retornados. Não pode ser definido com "locationBias".
evOptions

object (EVOptions)

Opcional. Define as opções de EV pesquisáveis de uma solicitação de pesquisa de lugar.
routingParameters

object (RoutingParameters)

Opcional. Parâmetros adicionais para roteamento de resultados.
searchAlongRouteParameters

object (SearchAlongRouteParameters)

Opcional. Proto de parâmetros adicionais para pesquisar ao longo de uma rota.
includePureServiceAreaBusinesses

boolean

Opcional. Inclua empresas de serviço local se o campo estiver definido como "true". Uma empresa de serviço local faz visitas ou entregas, mas não atende clientes no endereço comercial dela. Por exemplo, prestadores de serviços de limpeza ou encanadores. Essas empresas não têm um endereço físico ou local no Google Maps. O Places não vai retornar campos como location, plusCode e outros campos relacionados à localização para essas empresas.

Corpo da resposta

Proto 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)
    }
  ],
  "routingSummaries": [
    {
      object (RoutingSummary)
    }
  ],
  "contextualContents": [
    {
      object (ContextualContent)
    }
  ],
  "nextPageToken": string,
  "searchUri": string
}
Campos
places[]

object (Place)

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

object (RoutingSummary)

Uma lista de resumos de rotas em que cada entrada está associada ao lugar correspondente no mesmo índice no campo places. Se o resumo do trajeto não estiver disponível para um dos lugares, ele vai conter uma entrada vazia. Essa lista terá o mesmo número de entradas que a lista de lugares, se solicitado.
contextualContents[]

object (ContextualContent)

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

Uma lista de conteúdos contextuais em que cada entrada está associada ao lugar correspondente no mesmo índice no campo "places". O conteúdo relevante para o textQuery na solicitação é preferível. Se o conteúdo contextual não estiver disponível para um dos lugares, ele vai retornar conteúdo não contextual. Ele só fica vazio quando o conteúdo não está disponível para o lugar. Essa lista 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 o campo for omitido ou estiver vazio, não haverá páginas subsequentes.
searchUri

string

Um link permite que o usuário pesquise com a mesma consulta de texto especificada na solicitação no Google Maps.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/cloud-platform

RankPreference

Como os resultados serão classificados na resposta.

Tipos enumerados
RANK_PREFERENCE_UNSPECIFIED Para uma consulta categórica, como "Restaurantes em São Paulo", a RELEVÂNCIA é o padrão. Para consultas não categóricas, como "Mountain View, CA", recomendamos que você deixe rankPreference sem definição.
DISTANCE Classifica os resultados por distância.
RELEVANCE Classifica os resultados por relevância. A ordem de classificação é determinada pela pilha de classificação normal.

LocationBias

A região a ser pesquisada. Esse local serve como uma tendência, o que significa que resultados próximos ao local especificado 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 do retângulo. rectangle.low() precisa ser o ponto sudoeste da janela de visualização do retângulo. O campo rectangle.low().latitude() não pode ser maior que rectangle.high().latitude(). Isso vai resultar em um intervalo de latitude vazio. Uma janela de visualização retangular não pode ter mais de 180 graus de largura.
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 dele 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 do retângulo. rectangle.low() precisa ser o ponto sudoeste da janela de visualização do retângulo. O campo rectangle.low().latitude() não pode ser maior que rectangle.high().latitude(). Isso vai resultar em um intervalo de latitude vazio. Uma janela de visualização retangular não pode ter mais de 180 graus de largura.

EVOptions

Opções de veículos elétricos pesquisáveis de uma solicitação de pesquisa de lugar.

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

number

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

enum (EVConnectorType)

Opcional. A lista de tipos de conector de VE preferidos. Um lugar que não oferece suporte a nenhum dos tipos de conector listados é filtrado.

SearchAlongRouteParameters

Especifica uma polilinha pré-calculada da API Routes que define a rota a ser pesquisada. Pesquisar ao longo de um trajeto é semelhante a usar a opção de solicitação locationBias ou locationRestriction para influenciar os resultados da pesquisa. No entanto, enquanto as opções locationBias e locationRestriction permitem especificar uma região para influenciar os resultados da pesquisa, essa opção permite influenciar os resultados ao longo de um trajeto.

Não há garantia de que os resultados estejam ao longo do trajeto fornecido. Eles são classificados na área de pesquisa definida pela polilinha e, opcionalmente, por locationBias ou locationRestriction com base nos tempos mínimos de desvio da origem ao destino. Os resultados podem estar em um trajeto alternativo, especialmente se a polilinha fornecida não definir um trajeto ideal da origem ao destino.

Representação JSON 
{
  "polyline": {
    object (Polyline)
  }
}
Campos
polyline

object (Polyline)

Obrigatório. A polilinha da rota.

Polilinha

Uma polilinha de rota. Aceita apenas uma polilinha codificada, que pode ser transmitida como uma string e inclui compactação com perda mínima. Essa é a saída padrão da API Routes.

Representação JSON 
{

  // Union field polyline_type can be only one of the following:
  "encodedPolyline": string
  // End of list of possible types for union field polyline_type.
}
Campos
Campo de união polyline_type. Encapsula o tipo de polilinha. A saída padrão da API Routes é encoded_polyline. polyline_type pode ser apenas de um dos tipos a seguir:
encodedPolyline

string

Uma polilinha codificada, conforme retornado pela API Routes por padrão. Consulte as ferramentas codificador e decodificador.

ContextualContent

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

Conteúdo contextual para a consulta de lugar.

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

object (Review)

Lista de avaliações sobre o lugar, contextualizada para a consulta de lugar.
photos[]

object (Photo)

Informações (incluindo referências) sobre fotos desse lugar, contextuais à consulta de lugar.
justifications[]

object (Justification)

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

Justificativas para o lugar.

Justificativa

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

Justificativas para o lugar. As justificativas respondem à pergunta de por que um lugar pode interessar a 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 mais detalhes.
businessAvailabilityAttributesJustification

object (BusinessAvailabilityAttributesJustification)

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

ReviewJustification

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

Justificativas de avaliações de usuários. Isso destaca uma seção da avaliação do usuário que interessaria a um usuário final. Por exemplo, se a consulta de pesquisa for "pizza de forno a lenha", a justificativa da avaliação vai 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 de que o texto destacado foi gerado.

HighlightedText

O texto destacado pela justificativa. É um subconjunto da própria avaliação. A palavra exata a ser destacada é marcada pelo HighlightedTextRange. Pode haver várias palavras destacadas no texto.

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

string
highlightedTextRanges[]

object (HighlightedTextRange)

A lista dos 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 mais detalhes. Justificativas de BusinessAvailabilityAttributes. Isso mostra alguns atributos de uma empresa que podem interessar a um usuário final.

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

boolean

Se um lugar oferece comida para viagem.
delivery

boolean

Se um lugar oferece delivery.
dineIn

boolean

Se um lugar oferece refeição no local.