Method: resolveNames

Resolve uma lista de nomes de lugares (ou endereços) em entidades geoespaciais específicas (por exemplo, lugares) no Google Maps.

Solicitação HTTP

POST https://mapstools.googleapis.com/v1:resolveNames

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 
{
  "queries": [
    {
      object (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
Campos
queries[]

object (LocationQuery)

Obrigatório. Uma lista de consultas de localizações a serem resolvidas. É possível especificar até 20 consultas.
locationBias

object (LocationBias)

Opcional. Uma região opcional para influenciar os resultados da resolução. Se especificado, os resultados da resolução serão tendenciosos em relação às entidades mais próximas a essa região. Incluir locationBias ou regionCode geralmente oferece resultados melhores ao restringir o espaço de pesquisa.

Se locationBias e regionCode forem especificados, locationBias terá precedência sobre regionCode.
regionCode

string

Opcional. Um código regional opcional para influenciar os resultados da resolução. Se especificado, os resultados da resolução serão tendenciosos em relação às entidades que estão na região especificada ou perto dela. Precisa ser um código de região CLDR. Por exemplo, "US" ou "CA". Incluir locationBias ou regionCode geralmente oferece resultados melhores ao restringir o espaço de pesquisa.

Se locationBias e regionCode forem especificados, locationBias terá precedência sobre regionCode.

Corpo da resposta

Mensagem de resposta para v1.resolveNames.

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

Representação JSON 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  },
  "saveToMapsUrl": string
}
Campos
results[]

object (Result)

Apenas saída. A lista de entidades resolvidas das consultas de local. Garantido para mapear 1:1 com os índices queries da solicitação. Uma string vazia no índice i indica que a resolução falhou para essa consulta. Se a resolução falhar, verifique o campo failedRequests para conferir o status do erro.
failedRequests

map (key: integer, value: object (Status))

Apenas saída. Um mapa que comunica falhas parciais. A chave é o índice da solicitação com falha no campo queries. O valor é o status do erro que detalha por que a resolução falhou.

Um objeto com uma lista de pares "key": value. Exemplo: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
saveToMapsUrl

string

Apenas saída. Um link para salvar todas as entidades resolvidas no Google Maps.

Escopos de autorização

Requer o seguinte escopo OAuth:

  • https://www.googleapis.com/auth/maps-platform.mapstools

LocationQuery

Uma consulta de local representa uma entidade de local específica que pode ser resolvida com o Google Maps. No momento, apenas nomes de lugares e endereços são aceitos como consultas de local.

Representação JSON 
{
  "text": string
}
Campos
text

string

Obrigatório. A consulta de texto para resolver uma entidade geoespacial específica no Google Maps, como um lugar ou um endereço. Quanto mais específica for a consulta, mais precisa será a resolução. Por exemplo, "São Francisco", "Googleplex, Mountain View, CA", "1600 Amphitheatre Parkway, Mountain View, CA" ou "Torre Eiffel, Paris". As consultas precisam ser um endereço ou nome de lugar específico. Não é possível usar locais gerais, como o nome de uma rede (por exemplo, Starbucks) ou uma consulta de pesquisa como "restaurantes".

LocationBias

A região para direcionar os resultados da resolução.

Representação JSON 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "viewport": {
    object (Viewport)
  }
  // End of mutually exclusive fields.
}
Campos
O tipo de viés de local. Confira a seguir uma lista de campos mutuamente exclusivos. No máximo um dos campos será definido em uma resposta:
viewport

object (Viewport)

Uma janela de visualização definida por uma caixa delimitadora.
Fim dos campos mutuamente exclusivos.

Resultado

Uma única entidade resolvida de uma determinada consulta de local, junto com o nível de confiança da resolução.

Representação JSON 
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
Campos
entity

object (Entity)

Apenas saída. A entidade resolvida da consulta de local.
confidence

enum (Confidence)

Apenas saída. O nível de confiança da resolução.

Confiança

O nível de confiança da resolução.

Tipos enumerados
CONFIDENCE_UNSPECIFIED Valor padrão. Esse valor não é usado.
MEDIUM A confiança média indica que a resolução provavelmente está correta, mas pode haver outros candidatos.
HIGH Um alto nível de confiança indica que a resolução está correta e representa uma entidade geoespacial específica (por exemplo, um lugar específico).