Method: resolveNames

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

HTTP-запрос

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

В URL-адресе используется синтаксис транскодирования gRPC .

Текст запроса

Тело запроса содержит данные следующей структуры:

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 .

Ответный текст

Ответное сообщение для v1alpha.resolveNames.

В случае успеха тело ответа будет содержать данные следующей структуры:

JSON-представление 
{
  "results": [
    {
      object (Result)
    }
  ],
  "failedRequests": {
    integer: {
      object (Status)
    },
    ...
  }
}
Поля
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" } .

Области полномочий

Требуется один из следующих диапазонов аутентификации OAuth:

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

LocationQuery

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

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

string

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

LocationBias

Область, в которую следует сместить результаты разрешения.

JSON-представление 
{

  // Union field type can be only one of the following:
  "viewport": {
    object (Viewport)
  }
  // End of list of possible types for union field type.
}
Поля
type поля объединения. Тип смещения местоположения. type может принимать только одно из следующих значений:
viewport

object ( Viewport )

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

Видовое окно

Широта-долгота — это область просмотра, представленная двумя расположенными по диагонали low и high точками. Область просмотра считается замкнутой областью, то есть включает в себя свои границы. Границы широты должны находиться в диапазоне от -90 до 90 градусов включительно, а границы долготы — в диапазоне от -180 до 180 градусов включительно. Возможны различные варианты:

  • Если low = high , то область просмотра состоит из этой единственной точки.

  • Если low.longitude > high.longitude , диапазон долготы инвертируется (область просмотра пересекает линию долготы в 180 градусов).

  • Если low.longitude = -180 градусов и high.longitude = 180 градусов, то область просмотра будет включать все долготы.

  • Если low.longitude = 180 градусов и high.longitude = -180 градусов, то диапазон долготы пуст.

  • Если low.latitude > high.latitude , диапазон широт пуст.

Необходимо заполнить поля low и high , при этом отображаемый прямоугольник не может быть пустым (как указано в приведенных выше определениях). Пустой экран приведет к ошибке.

Например, этот иллюминатор полностью охватывает Нью-Йорк:

{ "низкая": { "широта": 40.477398, "долгота": -74.259087 }, "высокая": { "широта": 40.91618, "долгота": -73.70018 } }

JSON-представление 
{
  "low": {
    object (LatLng)
  },
  "high": {
    object (LatLng)
  }
}
Поля
low

object ( LatLng )

Обязательно. Нижняя точка области просмотра.

high

object ( LatLng )

Обязательно. Самая высокая точка в области просмотра.

LatLng

Объект, представляющий пару координат широты и долготы. Он выражается в виде пары чисел с плавающей запятой (double), обозначающих градусы широты и долготы. Если не указано иное, этот объект должен соответствовать стандарту WGS84 . Значения должны находиться в пределах нормализованных диапазонов.

JSON-представление 
{
  "latitude": number,
  "longitude": number
}
Поля
latitude

number

Широта в градусах. Она должна находиться в диапазоне [-90,0, +90,0].

longitude

number

Долгота в градусах. Она должна находиться в диапазоне [-180,0, +180,0].

Результат

Полученная в результате запроса местоположения единственная определенная сущность, а также уровень достоверности определения.

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

object ( Entity )

Только вывод. Полученная сущность из запроса местоположения.

confidence

enum ( Confidence )

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

Уверенность

Уровень уверенности в принятой резолюции.

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