get
Возвращает изображения, отвечающие заданным критериям.
Узнайте больше
Ограничения
Метод возвращает не более 10 000 объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": { /* params */
"SelectionCriteria": { /* AdImageSelectionCriteria */
"AdImageHashes": [(string), ... ],
"Associated": ( "YES" | "NO" )
},
"FieldNames": [( "AdImageHash" | "OriginalUrl" | "PreviewUrl" | "Name" | "Type" | "Subtype" | "Associated" ), ... ], /* required */
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
|
Параметр |
Тип |
Описание |
Обязательный |
|
Структура params (для JSON) / GetRequest (для SOAP) |
|||
|
|
AdImageSelectionCriteria |
Критерий отбора изображений. Если не указан, будут получены все изображения рекламодателя. |
Нет |
|
|
array of AdImageFieldEnum |
Имена параметров изображения, которые требуется получить. |
Да |
|
|
LimitOffset |
Структура, задающая страницу при постраничной выборке данных. |
Нет |
|
Структура AdImageSelectionCriteria |
|||
|
|
array of string |
Отбирать изображения с указанными хэшами. Не более 10 000 элементов в массиве. |
Нет |
|
|
YesNoEnum |
Отбирать изображения по признаку привязки к объявлениям: YES — привязанные, NO — непривязанные. |
Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"AdImages": [{ /* AdImageGetItem */
"AdImageHash": (string),
"Name": (string),
"Associated": ( "YES" | "NO" ),
"Type": ( "SMALL" | "REGULAR" | "WIDE" | "FIXED_IMAGE" | "UNFIT" ),
"Subtype": ( "IMG_240_400" | "IMG_300_250" | "IMG_300_500" | "IMG_300_600" | "IMG_320_50" | "IMG_320_100" | "IMG_320_480" | "IMG_336_280" | "IMG_480_320" | "IMG_480_800" | "IMG_600_500" | "IMG_600_1000" | "IMG_600_1200" | "IMG_640_100" | "IMG_640_200" | "IMG_640_960" | "IMG_672_560" | "IMG_720_1200" | "IMG_728_90" | "IMG_900_750" | "IMG_900_1500" | "IMG_900_1800" | "IMG_960_150" | "IMG_960_300" | "IMG_960_640" | "IMG_960_1440" | "IMG_960_1600" | "IMG_970_250" | "IMG_1008_840" | "IMG_1200_1000" | "IMG_1200_2000" | "IMG_1200_2400" | "IMG_1280_200" | "IMG_1280_400" | "IMG_1280_1920" | "IMG_1344_1120" | "IMG_1440_960" | "IMG_1456_180" | "IMG_1920_1280" | "IMG_1940_500" | "IMG_2184_270" | "IMG_2910_750" | "IMG_2912_360" | "IMG_3880_1000" | "NONE" ),
"OriginalUrl": (string), /* nillable */
"PreviewUrl": (string) /* nillable */
}, ... ],
"LimitedBy": (long)
}
}
|
Параметр |
Тип |
Описание |
|
Структура result (для JSON) / GetResponse (для SOAP) |
||
|
|
array of AdImageGetItem |
Изображения. |
|
|
long |
Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
|
Структура AdImageGetItem |
||
|
|
string |
Хэш изображения. |
|
|
string |
Произвольное наименование изображения. Не более 255 символов. |
|
|
YesNoEnum |
Привязано ли изображение хотя бы к одному объявлению клиента. |
|
|
AdImageTypeEnum |
Тип изображения, см. Тип изображения. |
|
|
AdImageSubtypeEnum |
Размер изображения для типа FIXED_IMAGE. Для изображений с типом, отличным от FIXED_IMAGE, возвращается значение NONE. |
|
|
string, nillable |
Ссылка на изображение в полном размере. |
|
|
string, nillable |
Ссылка на превью изображения. |