Method: places.searchNearby

Pesquise lugares perto dos 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)
}
Campos
languageCode

string

Os detalhes do lugar serão exibidos com o idioma preferencial, se disponível. Se o código de idioma não for especificado ou não for reconhecido, detalhes de lugares de 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 origem da solicitação. Esse parâmetro é usado para exibir 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, acesse https://www.unicode.org/cldr/charts/latest/supplemental/territory_language_information.html.

No momento, não é possível usar códigos regionais de três dígitos.
includedTypes[]

string

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

Até 50 tipos da Tabela A podem ser especificados.

Se houver tipos conflitantes, ou seja, um tipo aparecer tanto em includeTypes 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 atenderem a todas as restrições serão retornados. Por exemplo, se houver {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados fornecerão serviços relacionados ao "restaurante", mas não operam principalmente como "restaurantes".
excludedTypes[]

string

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

Até 50 tipos da Tabela A podem ser especificados.

Se o cliente fornece os dois tipos de armazenamento (por exemplo, restaurante) e A resposta inclui locais que correspondem a pelo menos um dosincludedTypes e a nenhum dos excludedTypes.

Se houver tipos conflitantes, ou seja, um tipo aparecer tanto em includeTypes 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 atenderem a todas as restrições serão retornados. Por exemplo, se houver {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados fornecerão serviços relacionados ao "restaurante", mas não operam principalmente como "restaurantes".
includedPrimaryTypes[]

string

O tipo de lugar principal foi 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.

Até 50 tipos da Tabela A podem ser especificados.

Se houver conflitos de tipos principais, ou seja, se um tipo aparecer em includePrimaryTypes e excludedPrimaryTypes, um erro INVALID_MCC será retornado.

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

string

O tipo principal de lugar excluído (por exemplo, "restaurante" ou "posto de gasolina") foi excluído de https://developers.google.com/maps/documentation/places/web-service/place-types.

Até 50 tipos da Tabela A podem ser especificados.

Se houver conflitos de tipos principais, ou seja, se um tipo aparecer em includePrimaryTypes e excludedPrimaryTypes, um erro INVALID_MCC será retornado.

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

integer

Número máximo de resultados a serem retornados. Esse valor precisa estar entre 1 e 20 (padrão), inclusive. Se o número não for definido, ele voltará para o limite máximo. Se o número for definido como negativo ou exceder o limite superior, 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.

Corpo da resposta

Protocolo de resposta para o Search Nearby.

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

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

object (Place)

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

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. Por padrão, a classificação por POPULARITY será usada.
DISTANCE Classificação dos resultados por distância.
POPULARITY Classifica os resultados por popularidade.