Method: places.searchNearby

Pesquise lugares próximos a locais.

Solicitação HTTP

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

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 
{
  "languageCode": string,
  "regionCode": string,
  "includedTypes": [
    string
  ],
  "excludedTypes": [
    string
  ],
  "includedPrimaryTypes": [
    string
  ],
  "excludedPrimaryTypes": [
    string
  ],
  "maxResultCount": integer,
  "locationRestriction": {
    object (LocationRestriction)
  },
  "rankPreference": enum (RankPreference),
  "routingParameters": {
    object (RoutingParameters)
  },
  "includeFutureOpeningBusinesses": boolean
}
Campos
languageCode

string

Os detalhes do lugar serão exibidos no idioma preferido, se disponível. Se o código do 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 compatíveis: https://developers.google.com/maps/faq#languagesupport.
regionCode

string

O código de país/região Unicode (CLDR) do local de onde a solicitação está vindo. 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.

Observe que códigos de região de 3 dígitos não são suportados no momento.
includedTypes[]

string

Tipo de lugar incluído (por exemplo, "restaurante" ou "posto_de_gasolina") em https://developers.google.com/maps/documentation/places/web-service/place-types.

É possível especificar até 50 tipos da tabela A.

Se houver tipos conflitantes, ou seja, um tipo aparece em includedTypes e excludedTypes, um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, somente os lugares que atendem a todas as restrições serão retornados. Por exemplo, se tivermos {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não operam principalmente como "restaurantes".
excludedTypes[]

string

Tipo de lugar excluído (por exemplo, "restaurante" ou "posto_de_gasolina") em https://developers.google.com/maps/documentation/places/web-service/place-types.

É possível especificar até 50 tipos da tabela A.

Se o cliente fornecer includedTypes (por exemplo, restaurante) e excludedTypes (por exemplo, café), a resposta vai incluir lugares que são restaurantes, mas não cafés. A resposta inclui lugares que correspondem a pelo menos um dos includedTypes e nenhum dos excludedTypes.

Se houver tipos conflitantes, ou seja, um tipo aparece em includedTypes e excludedTypes, um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, somente os lugares que atendem a todas as restrições serão retornados. Por exemplo, se tivermos {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não operam principalmente como "restaurantes".
includedPrimaryTypes[]

string

Tipo de lugar principal incluído (por exemplo, "restaurante" ou "posto_de_gasolina") em https://developers.google.com/maps/documentation/places/web-service/place-types. Um lugar só pode ter um único tipo principal da tabela de tipos compatíveis associada a ele.

É possível especificar até 50 tipos da tabela A.

Se houver tipos principais conflitantes, ou seja, um tipo aparece em includedPrimaryTypes e excludedPrimaryTypes, um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, somente os lugares que atendem a todas as restrições serão retornados. Por exemplo, se tivermos {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não operam principalmente como "restaurantes".
excludedPrimaryTypes[]

string

Tipo de lugar principal excluído (por exemplo, "restaurante" ou "posto_de_gasolina") em https://developers.google.com/maps/documentation/places/web-service/place-types.

É possível especificar até 50 tipos da tabela A.

Se houver tipos principais conflitantes, ou seja, um tipo aparece em includedPrimaryTypes e excludedPrimaryTypes, um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, somente os lugares que atendem a todas as restrições serão retornados. Por exemplo, se tivermos {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não operam principalmente como "restaurantes".
maxResultCount

integer

Número máximo de resultados a serem retornados. Ele precisa estar entre 1 e 20 (padrão), inclusive. Se o número não estiver definido, ele vai voltar ao limite superior. Se o número for definido como negativo ou exceder o limite superior, um erro INVALID_ARGUMENT será retornado.
locationRestriction

object (LocationRestriction)

Obrigatório. A região a ser pesquisada.
rankPreference

enum (RankPreference)

Como os resultados serão classificados na resposta.
routingParameters

object (RoutingParameters)

Opcional. Parâmetros que afetam o roteamento para os resultados da pesquisa.
includeFutureOpeningBusinesses

boolean

Opcional. Se for verdadeiro, inclua empresas que ainda não estão abertas, mas serão abertas no futuro.

Corpo da resposta

Proto de resposta para pesquisa por perto.

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

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

object (Place)

Uma lista de lugares que atende aos requisitos do usuário, como tipos de lugares, número de lugares e restrição de local específica.
routingSummaries[]

object (RoutingSummary)

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

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

LocationRestriction

A região a ser pesquisada.

Representação JSON 
{

  // Union field type can be only one of the following:
  "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:
circle

object (Circle)

Um círculo definido pelo ponto central e pelo raio.

RankPreference

Como os resultados serão classificados na resposta.

Tipos enumerados
RANK_PREFERENCE_UNSPECIFIED Valor RankPreference não definido. Usará a classificação por POPULARIDADE por padrão.
DISTANCE Classifica os resultados por distância.
POPULARITY Classifica os resultados por popularidade.