- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- RankPreference
- LocationBias
- LocationRestriction
- EVOptions (em inglês)
- ContextualContent
- Justificativa
- ReviewJustification
- HighlightedText
- HighlightedTextRange
- BusinessAvailabilityAttributesJustification
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 ( |
Campos | |
---|---|
textQuery |
Obrigatório. A consulta de texto para pesquisa textual. |
languageCode |
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 |
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 |
Como os resultados serão classificados na resposta. |
includedType |
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 |
Usado para restringir a pesquisa a lugares que estão abertos no momento. O valor padrão é falso. |
minRating |
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 |
Obsoleto: use 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 Se |
pageSize |
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 Se |
pageToken |
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 |
priceLevels[] |
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 |
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 |
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 |
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 |
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 ( |
Campos | |
---|---|
places[] |
Uma lista de lugares que atendem aos critérios de pesquisa de texto do usuário. |
contextualContents[] |
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 |
nextPageToken |
Um token que pode ser enviado como |
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 |
Campos | |
---|---|
Campo de união
|
|
rectangle |
Uma caixa retangular 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. 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 |
Campos | |
---|---|
Campo de união
|
|
rectangle |
Uma caixa retangular definida pelos cantos nordeste e sudoeste. |
EVOptions
Opções de VE pesquisáveis de uma solicitação de pesquisa de lugar.
Representação JSON |
---|
{
"minimumChargingRateKw": number,
"connectorTypes": [
enum ( |
Campos | |
---|---|
minimumChargingRateKw |
Opcional. Taxa de carregamento mínima necessária em quilowatts. Um lugar com uma taxa de carregamento menor que a taxa especificada é filtrado. |
connectorTypes[] |
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 ( |
Campos | |
---|---|
reviews[] |
Lista de avaliações sobre esse lugar, semelhantes à consulta de local. |
photos[] |
Informações (incluindo referências) sobre fotos deste local, relacionadas à consulta de local. |
justifications[] |
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 |
Campos | |
---|---|
Campo de união
|
|
reviewJustification |
Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para saber mais detalhes. |
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 ( |
Campos | |
---|---|
highlightedText |
|
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 ( |
Campos | |
---|---|
text |
|
highlightedTextRanges[] |
A lista de intervalos do texto destacado. |
HighlightedTextRange
O intervalo do texto destacado.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer } |
Campos | |
---|---|
startIndex |
|
endIndex |
|
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 |
Se um lugar oferece opções de retirada para viagem. |
delivery |
Se um lugar oferece entrega. |
dineIn |
Se um lugar oferece refeição no local. |