getGeoRegions

Возвращает список регионов, доступных для таргетинга.

Запрос

Структура запроса в формате JSON:

{
  "method": "getGeoRegions",
  "params" : { /* required */
    "Page" : {
      "Limit" : (long),
      "Offset" : (long)
    },
    "SelectionCriteria" : { /* required */
      "Name" : (string),
      "RegionIds" : [ (long) ],
      "ExactNames" : [ (string) ]
    },
    "FieldNames" : [ ("GeoRegionId" |"GeoRegionName"|"ParentGeoRegionNames") ] /* required */
  }
}

Параметр

Тип

Описание

Обязательный

Структура params (для JSON) / GetRequest (для SOAP)

Page

LimitOffset

Структура, задающая страницу при постраничной выборке данных.

Нет

SelectionCriteria

GeoRegionsSelectionCriteria

Критерий отбора регионов.

Необходимо передать хотя бы один из параметров: Name, RegionIds или ExactNames.

Если в запросе передан параметр:

  • Name – метод вернет результаты по регионам с похожим названием.
  • RegionIds – метод вернет результаты по идентификаторам регионов.
  • ExactNames – метод вернет результаты по точным названиям регионов.

Да

FieldNames

array of AdFieldEnum

Имена параметров верхнего уровня, которые требуется получить.

Да

Структура GeoRegionsSelectionCriteria

Name

string

Отбирать регионы с похожим названием.

Нет, если указан RegionIds или ExactNames.

RegionIds

array of long

Отбирать регионы с указанными идентификаторами.

Нет, если указан Name или ExactNames.

ExactNames

array of string

Отбирать регионы по точным названиям.

Нет, если указан Name или RegionIds.

Ответ

Структура ответа в формате JSON:

{
  "result" : { /* required */
    "LimitedBy" : (long),
    "GeoRegions" : [{
      "GeoRegionId" : (long),
      "GeoRegionName" : (string),
      "ParentGeoRegionNames" : { /* nillable */
        "Items" : [ (string) ] /* required */
      }
    }, .. (unbounded)]
  }
}

Параметр

Тип

Описание

Структура result (для JSON) / GetResponse (для SOAP)

LimitedBy

long

Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.

GeoRegions

array of GeoRegionsGetItem

Список регионов.

Структура GeoRegionsGetItem

GeoRegionId

long

Идентификатор региона.

GeoRegionName

string

Название региона на языке, указанном в запросе в HTTP-заголовке Accept-Language.

ParentGeoRegionNames

array of string

Массив названий вышестоящих регионов.

Предыдущая