- Solicitação HTTP
- Corpo da solicitação
- Corpo da resposta
- RankPreference
- LocationBias
- LocationRestriction
- EVOptions
- SearchAlongRouteParameters
- Polilinha
- 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 | |
---|---|
text |
Obrigatório. A consulta de texto para pesquisa textual. |
language |
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 aceitos: https://developers.google.com/maps/faq#languagesupport. |
region |
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 do lugar 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, acesse 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. |
rank |
Como os resultados serão classificados na resposta. |
included |
O tipo de lugar solicitado. Lista completa de tipos aceitos: https://developers.google.com/maps/documentation/places/web-service/place-types. Suporte a apenas um tipo incluído. |
open |
Usado para restringir a pesquisa a lugares que estão abertos no momento. O valor padrão é falso. |
min |
Filtra os resultados com a classificação média do usuário menor que esse limite. Um valor válido precisa ser um número flutuante 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 mais próximo(teto). Por exemplo, uma classificação de 0,6 vai 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 |
page |
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 |
page |
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, exceto |
price |
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. Por padrão, selecione todos os níveis de preço. |
strict |
Usado para definir a filtragem de tipo estrita para includeType. Se definido como verdadeiro, apenas os resultados do mesmo tipo serão retornados. O padrão é "false". |
location |
A região a ser pesquisada. Esse local serve como viés, o que significa que os resultados em torno do local podem ser retornados. Não pode ser definido com "locationRestriction". |
location |
A região a ser pesquisada. Esse local serve como uma restrição, o que significa que os resultados fora do local especificado não serão retornados. Não pode ser definido junto com locationBias. |
ev |
Opcional. Define as opções de VE pesquisáveis de uma solicitação de Place Search. |
routing |
Opcional. Parâmetros adicionais para roteamento de resultados. |
search |
Opcional. Protocolo de parâmetros adicionais para pesquisar ao longo de uma rota. |
include |
Opcional. Inclua empresas de serviço local se o campo estiver definido como verdadeiro. Uma empresa de serviço local é aquela que 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 |
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 ( |
Campos | |
---|---|
places[] |
Uma lista de locais que atendem aos critérios de pesquisa de texto do usuário. |
routing |
Uma lista de resumos de roteamento em que cada entrada é associada ao lugar correspondente no mesmo índice no campo |
contextual |
Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para ver mais detalhes. Uma lista de conteúdos contextuais em que cada entrada é associada ao lugar correspondente no mesmo índice no campo "lugares". O conteúdo relevante para o |
next |
Um token que pode ser enviado como |
search |
Um link permite que o usuário pesquise usando a mesma consulta de texto especificada na solicitação no Google Maps. |
RankPreference
Como os resultados serão classificados na resposta.
Enums | |
---|---|
RANK_PREFERENCE_UNSPECIFIED |
Para uma consulta categórica, como "Restaurantes em Nova York", a RELEVÂNCIA é o padrão. Para consultas não categóricas como "Mountain View, CA", recomendamos que você deixe a rankPreference não definida. |
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 viés, o que significa que os resultados em torno do local 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 pelo ponto central e pelo raio. |
LocationRestriction
A região a ser pesquisada. Esse local serve como uma restrição, o que significa que os resultados fora do local especificado 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 | |
---|---|
minimum |
Opcional. Taxa de recarga mínima necessária em quilowatts. Um lugar com uma taxa de cobrança menor que a especificada é filtrado. |
connector |
Opcional. Lista de tipos preferidos de conector de VE. Um lugar que não oferece suporte a nenhum dos tipos de conector listados é filtrado. |
SearchAlongRouteParameters
Especifica uma poligonal pré-calculada da API Routes que define a rota a ser pesquisada. Pesquisar ao longo de uma rota é semelhante a usar a opção de solicitação locationBias
ou locationRestriction
para enviesar os resultados da pesquisa. No entanto, enquanto as opções locationBias
e locationRestriction
permitem especificar uma região para enviesar os resultados da pesquisa, essa opção permite enviesar os resultados ao longo de um trajeto.
Não há garantia de que os resultados vão estar ao longo do trajeto fornecido, mas eles serão classificados dentro da área de pesquisa definida pela polilinha e, opcionalmente, por locationBias
ou locationRestriction
com base nos tempos de desvio mínimos da origem até o destino. Os resultados podem estar em um trajeto alternativo, principalmente se a poligonal fornecida não definir um trajeto ideal da origem ao destino.
Representação JSON |
---|
{
"polyline": {
object ( |
Campos | |
---|---|
polyline |
Obrigatório. A polilinha da rota. |
Polilinha
Uma polilinha de rota. Suporta 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 |
Campos | |
---|---|
Campo de união polyline_type . Encapsula o tipo de polilinha. A saída da API Routes é padrão para encoded_polyline . polyline_type pode ser apenas de um dos tipos a seguir: |
|
encoded |
Uma polilinha codificada, conforme retornado pela API Routes por padrão. Consulte as ferramentas de codificador e decodificador. |
ContextualContent
Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes.
Conteúdo contextual à consulta de lugar.
Representação JSON |
---|
{ "reviews": [ { object ( |
Campos | |
---|---|
reviews[] |
Lista de avaliações sobre esse lugar, contextualizadas à consulta do lugar. |
photos[] |
Informações (incluindo referências) sobre as fotos desse lugar, contextualizadas à consulta de lugar. |
justifications[] |
Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes. Justificativas para o lugar. |
Motivo
Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para ver 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 |
Campos | |
---|---|
Campo de união
|
|
review |
Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para mais detalhes. |
business |
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 do usuário. 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 lenha", a justificativa da avaliação destacará o texto relevante para a consulta de pesquisa.
Representação JSON |
---|
{ "highlightedText": { object ( |
Campos | |
---|---|
highlighted |
|
review |
A avaliação em que o texto destacado foi gerado. |
HighlightedText
O texto destacado pela justificação. Esse é um subconjunto da avaliação em si. A palavra exata a ser destacada é marcada pelo HighlightedTextRange. Pode haver várias palavras no texto destacado.
Representação JSON |
---|
{
"text": string,
"highlightedTextRanges": [
{
object ( |
Campos | |
---|---|
text |
|
highlighted |
A lista dos intervalos do texto em destaque. |
HighlightedTextRange
O intervalo do texto destacado.
Representação JSON |
---|
{ "startIndex": integer, "endIndex": integer } |
Campos | |
---|---|
start |
|
end |
|
BusinessAvailabilityAttributesJustification
Experimental: consulte https://developers.google.com/maps/documentation/places/web-service/experimental/places-generative para ver 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 |
Se um lugar oferece comida para viagem. |
delivery |
Se um lugar oferece entrega. |
dine |
Se um lugar oferece refeições no local. |