Method: resolveNames

Преобразует список названий мест (или адресов) в определенные геопространственные объекты (например, места) на Google Картах.

HTTP-запрос

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

URL имеет синтаксис gRPC Transcoding.

Тело запроса

Ниже приведена структура данных в теле запроса.

JSON-представление 
{
  "queries": [
    {
      object (LocationQuery)
    }
  ],
  "locationBias": {
    object (LocationBias)
  },
  "regionCode": string
}
Поля
queries[]

object (LocationQuery)

Обязательно. Список запросов на определение местоположения, которые нужно обработать. Можно указать до 20 запросов.
locationBias

object (LocationBias)

Необязательное поле. Необязательный регион, который будет учитываться при определении результатов. Если указано, результаты разрешения будут смещены в сторону объектов, которые находятся ближе к этому региону. Использование операторов locationBias или regionCode часто позволяет получить более точные результаты, поскольку сужает область поиска.

Если указаны оба параметра – locationBias и regionCode, то locationBias является приоритетнымregionCode.
regionCode

string

Необязательное поле. Необязательный код региона, который будет влиять на результаты разрешения. Если указано, результаты разрешения будут смещены в сторону объектов, которые находятся в указанном регионе или рядом с ним. Это должен быть код региона CLDR. Примеры: "US" или "CA". Использование операторов locationBias или regionCode часто позволяет получить более точные результаты, поскольку сужает область поиска.

Если указаны оба параметра – locationBias и regionCode, то locationBias является приоритетнымregionCode.

Тело ответа

Сообщение с ответом для v1.resolveNames.

Ниже приведена структура данных в ответе, полученном на запрос.

JSON-представление 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  },
  "saveToMapsUrl": string
}
Поля
results[]

object (Result)

Используется только для вывода. Список распознанных объектов из запросов местоположения. Гарантированно соответствует индексам запроса queries. Пустая строка в индексе i означает, что разрешение для этого запроса не удалось. Если разрешение не удалось, проверьте поле failedRequests на наличие статуса ошибки.
failedRequests

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

Используется только для вывода. Карта, на которой показаны частичные сбои. Ключ – это индекс неудачного запроса в поле queries. Значение представляет собой статус ошибки, в котором указано, почему преобразование не удалось.

Объект содержит список из нескольких пар ("key": value). Пример: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
saveToMapsUrl

string

Используется только для вывода. Ссылка для сохранения всех успешно распознанных объектов в Google Картах.

Области авторизации

Требуется следующая область действия OAuth:

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

LocationQuery

Запрос местоположения представляет собой определенный объект местоположения, который можно найти на Google Картах. В настоящее время в качестве запросов местоположения поддерживаются только названия мест и адреса.

JSON-представление 
{
  "text": string
}
Поля
text

string

Обязательно. Текстовый запрос, который нужно преобразовать в определенный геопространственный объект на Google Картах, например место или адрес. Чем точнее запрос, тем точнее будет ответ. Примеры: "Сан-Франциско", "Googleplex, Маунтин-Вью, Калифорния", "1600 Amphitheatre Parkway, Маунтин-Вью, Калифорния" или "Эйфелева башня, Париж". Запросы должны представлять собой определенный адрес или название места. Общие местоположения, например название сети (Starbucks) или поисковый запрос (рестораны), не поддерживаются.

LocationBias

Регион, в котором нужно искать результаты.

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.
}
Поля
Тип смещения местоположения. Ниже приведен список взаимоисключающих полей. В ответе будет задано не более одного из следующих полей:
viewport

object (Viewport)

Область просмотра, заданная граничной рамкой.
Конец взаимоисключающих полей.

Результат

Единственный распознанный объект из запроса местоположения вместе с уровнем достоверности распознавания.

JSON-представление 
{
  "entity": {
    object (Entity)
  },
  "confidence": enum (Confidence)
}
Поля
entity

object (Entity)

Используется только для вывода. Распознанный объект из запроса местоположения.
confidence

enum (Confidence)

Используется только для вывода. Уровень достоверности для разрешения.

Точность

Уровень достоверности для разрешения.

Перечисления
CONFIDENCE_UNSPECIFIED Значение по умолчанию. Это значение не используется.
MEDIUM Средняя достоверность означает, что разрешение, скорее всего, правильное, но могут быть и другие варианты.
HIGH Высокая достоверность означает, что разрешение правильное и представляет собой определенный геопространственный объект (например, определенное место).