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) |
|||
|
LimitOffset |
Структура, задающая страницу при постраничной выборке данных. |
Нет |
|
GeoRegionsSelectionCriteria |
Критерий отбора регионов. Необходимо передать хотя бы один из параметров: Если в запросе передан параметр:
|
Да |
|
array of AdFieldEnum |
Имена параметров верхнего уровня, которые требуется получить. |
Да |
Структура GeoRegionsSelectionCriteria |
|||
|
string |
Отбирать регионы с похожим названием. |
Нет, если указан |
|
array of long |
Отбирать регионы с указанными идентификаторами. |
Нет, если указан |
|
array of string |
Отбирать регионы по точным названиям. |
Нет, если указан |
Ответ
Структура ответа в формате JSON:
{
"result" : { /* required */
"LimitedBy" : (long),
"GeoRegions" : [{
"GeoRegionId" : (long),
"GeoRegionName" : (string),
"ParentGeoRegionNames" : { /* nillable */
"Items" : [ (string) ] /* required */
}
}, .. (unbounded)]
}
}
Параметр |
Тип |
Описание |
Структура result (для JSON) / GetResponse (для SOAP) |
||
|
long |
Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
|
array of GeoRegionsGetItem |
Список регионов. |
Структура GeoRegionsGetItem |
||
|
long |
Идентификатор региона. |
|
string |
Название региона на языке, указанном в запросе в HTTP-заголовке Accept-Language. |
|
array of string |
Массив названий вышестоящих регионов. |