Method: places.searchNearby

Pesquise lugares perto de outros lugares.

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)
  }
}
Campos
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 aceitos: 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 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, 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.
includedTypes[]

string

Incluir o tipo de lugar (por exemplo, "restaurante" ou "gasolina") de 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, só os lugares que atenderem a todas as restrições serão retornados. Por exemplo, se tivermos {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não funcionam 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 tipos incluídos (por exemplo, restaurante) e excluídos (por exemplo, café), a resposta precisará incluir lugares que são restaurantes, mas não cafés. A resposta inclui lugares que correspondem a pelo menos um dos tipos incluídos e a nenhum dos tipos excluídos.

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, só os lugares que atenderem a todas as restrições serão retornados. Por exemplo, se tivermos {includedTypes = ["restaurant"], excludedPrimaryTypes = ["restaurant"]}, os lugares retornados oferecem serviços relacionados a "restaurantes", mas não funcionam principalmente como "restaurantes".
includedPrimaryTypes[]

string

Incluiu o tipo de lugar principal (por exemplo, "restaurante" ou "gasolina") de 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 em excludedPrimaryTypes, um erro INVALID_ARGUMENT será retornado.

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

string

Exclusão do tipo de lugar principal (por exemplo, "restaurante" 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 principais conflitantes, ou seja, um tipo aparece em includedPrimaryTypes e em excludedPrimaryTypes, um erro INVALID_ARGUMENT será retornado.

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

integer

Número máximo de resultados a serem retornados. Precisa estar entre 1 e 20 (padrão), inclusive. Se o número não for definido, ele vai voltar para o limite superior. Se o número for definido como 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 roteamento para os resultados da pesquisa.

Corpo da resposta

Proto de resposta para a Pesquisa 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 atende 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 roteamento em que cada entrada é 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 tantas entradas quanto a lista de lugares, se solicitada.

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.

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