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/v1alpha: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 local 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 dessa 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 v1alpha.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)
    },
    ...
  }
}
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" }.

Escopos de autorização

Requer um dos seguintes escopos do OAuth:

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

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. Locais gerais, como o nome de uma rede (por exemplo, Starbucks) ou uma consulta de pesquisa como "restaurantes", não são aceitos.

LocationBias

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

Representação JSON 
{

  // Union field type can be only one of the following:
  "viewport": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Campos
Campo de união type. O tipo de viés de local. type pode ser apenas de um dos tipos a seguir:
viewport

object (Viewport)

Uma janela de visualização definida por uma caixa delimitadora.

Janela de visualização

Uma janela de visualização de latitude-longitude, representada como dois pontos low e high diagonalmente opostos. Uma janela de visualização é considerada uma região fechada, ou seja, inclui o limite. Os limites de latitude precisam estar entre -90 e 90 graus, e os de longitude entre -180 e 180 graus. Vários casos incluem:

  • Se low = high, a janela de visualização consiste nesse único ponto.

  • Se low.longitude > high.longitude, o intervalo de longitude será invertido (a janela de visualização cruza a linha de longitude de 180 graus).

  • Se low.longitude = -180 graus e high.longitude = 180 graus, a janela de visualização inclui todas as longitudes.

  • Se low.longitude = 180 graus e high.longitude = -180 graus, o intervalo de longitude estará vazio.

  • Se low.latitude > high.latitude, o intervalo de latitude estará vazio.

low e high precisam ser preenchidos, e a caixa representada não pode estar vazia (conforme especificado nas definições acima). Uma janela de visualização vazia vai resultar em um erro.

Por exemplo, esta janela de visualização envolve totalmente a cidade de Nova York:

{ "low": { "latitude": 40.477398, "longitude": -74.259087 }, "high": { "latitude": 40.91618, "longitude": -73.70018 } }

Representação JSON 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Campos
low

object (LatLng)

Obrigatório. O ponto baixo da janela de visualização.
high

object (LatLng)

Obrigatório. O ponto alto da janela de visualização.

LatLng

Um objeto que representa um par de latitude/longitude. Ele é expresso como um par de valores duplos para representar graus de latitude e longitude. A menos que especificado de outra forma, esse objeto precisa seguir o padrão WGS84. Os valores precisam estar dentro de intervalos normalizados.

Representação JSON 
{
  "latitude": number,
  "longitude": number
}
Campos
latitude

number

A latitude em graus. Precisa estar no intervalo [-90,0, +90,0].
longitude

number

A longitude em graus. Precisa estar no intervalo [-180,0, +180,0].

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 A alta confiança indica que a resolução está correta e representa uma entidade geoespacial específica (por exemplo, um lugar específico).