Method: places.searchNearby

Pesquisar lugares perto de 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 vão aparecer 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.

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

string

Tipo de lugar incluído (por exemplo, "restaurant" ou "gas_station") 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 aparecer em "includedTypes" e "excludedTypes", um erro INVALID_ARGUMENT será retornado.

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

string

Tipo de lugar excluído (por exemplo, "restaurant" ou "gas_station") de 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 a nenhum dos excludedTypes.

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

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

string

Incluído o tipo de lugar principal (por exemplo, "restaurant" ou "gas_station") de https://developers.google.com/maps/documentation/places/web-service/place-types. Um lugar só pode ter um tipo principal associado a ele na tabela de tipos aceitos.

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

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

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

string

Tipo de lugar principal excluído (por exemplo, "restaurant" ou "gas_station") de 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 aparecer em "includedPrimaryTypes" e "excludedPrimaryTypes", um erro INVALID_ARGUMENT será retornado.

Se um tipo de lugar for especificado com várias restrições, somente os lugares que atendem a todas elas serão retornados. Por exemplo, se tivermos {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, os lugares retornados vão oferecer serviços relacionados a "restaurante", mas não vão operar 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 negativo ou exceder o limite máximo, será retornado um erro INVALID_ARGUMENT.
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 encaminhamento para os resultados da pesquisa.
includeFutureOpeningBusinesses

boolean

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

Corpo da resposta

Proto de resposta para "Pesquisar nas proximidades".

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 atendem aos requisitos do usuário, como tipos de lugares, número de lugares e restrição de local específico.
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 precisa ter o mesmo número de entradas que a lista de lugares, se solicitado.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • 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 por um ponto central e um raio.

RankPreference

Como os resultados serão classificados na resposta.

Tipos enumerados
RANK_PREFERENCE_UNSPECIFIED O valor de RankPreference não foi definido. Vai usar a classificação por POPULARIDADE por padrão.
DISTANCE Classifica os resultados por distância.
POPULARITY Classifica os resultados por popularidade.