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)

Только для вывода. Список объектов, полученных в результате запросов местоположения. Гарантированно сопоставляется 1:1 с индексами 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, Mountain View, CA" или "Эйфелева башня, Париж". Запросы должны содержать точный адрес или название места. Приблизительное местоположение, например название сети (например, 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 Высокая степень уверенности означает, что сопоставление выполнено правильно и представляет определенный геопространственный объект (например, конкретное место).