Method: places.searchNearby

Pesquise lugares próximos.

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 de preferência, se disponível. Se o código de idioma não for especificado ou não for reconhecido, detalhes do lugar de qualquer idioma poderão ser retornados, com preferência para o inglês, se houver.

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 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 é possível usar códigos de região de três dígitos.
includedTypes[]

string

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

Até 50 tipos da Tabela A podem ser especificados.

Se houver algum tipo conflitante, ou seja, um tipo aparece em includeTypes e excludedTypes, um erro INVALID_MCC será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, apenas lugares que satisfizerem todas as restrições serão retornados. Por exemplo, se houver {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados vão mostrar "restaurante" serviços relacionados, mas não operem primariamente 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 informar includeTypes (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 locais que correspondem a pelo menos um dos includeTypes e nenhum dos excludedTypes.

Se houver algum tipo conflitante, ou seja, um tipo aparece em includeTypes e excludedTypes, um erro INVALID_MCC será retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, apenas lugares que satisfizerem todas as restrições serão retornados. Por exemplo, se houver {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados vão mostrar "restaurante" serviços relacionados, mas não operem primariamente como "restaurantes".
includedPrimaryTypes[]

string

Inclusão do tipo de lugar principal (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 tipo principal da tabela de tipos compatíveis associada a ele.

Até 50 tipos da Tabela A podem ser especificados.

Se houver tipos principais conflitantes, ou seja, um tipo aparece em includePrimaryTypes e excludedPrimaryTypes, um erro INVALID_MCC é retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, apenas lugares que satisfizerem todas as restrições serão retornados. Por exemplo, se houver {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados vão mostrar "restaurante" serviços relacionados, mas não operem primariamente como "restaurantes".
excludedPrimaryTypes[]

string

Tipo de lugar principal 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 houver tipos principais conflitantes, ou seja, um tipo aparece em includePrimaryTypes e excludedPrimaryTypes, um erro INVALID_MCC é retornado.

Se um tipo de lugar for especificado com várias restrições de tipo, apenas lugares que satisfizerem todas as restrições serão retornados. Por exemplo, se houver {includedTypes = ["restaurante"], excludedPrimaryTypes = ["restaurante"]}, os lugares retornados vão mostrar "restaurante" serviços relacionados, mas não operem primariamente 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 for definido, ele voltará ao limite máximo. Se o número for definido como negativo ou exceder o limite máximo, um erro INVALID_MCC será retornado.
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

Proto 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 locais que atende aos requisitos do usuário, como tipos, número de lugares e restrição de local específica.

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