get

Возвращает изображения, отвечающие заданным критериям.

  1. Ограничения
  2. Запрос
  3. Ответ

Ограничения

Метод возвращает не более 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)
SelectionCriteria AdImageSelectionCriteria

Критерий отбора изображений. Если не указан, будут получены все изображения рекламодателя.

Нет
FieldNames array of AdImageFieldEnum

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

Да
Page LimitOffset

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

Нет
Структура AdImageSelectionCriteria
AdImageHashes array of string Отбирать изображения с указанными хэшами. Не более 10 000 элементов в массиве. Нет
Associated 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_336_280" | "IMG_640_100" | "IMG_640_200" | "IMG_640_960" | "IMG_728_90" | "IMG_960_640" | "IMG_970_250" | "NONE" ),
      "OriginalUrl": (string), /* nillable */
      "PreviewUrl": (string) /* nillable */
    }, ... ],
    "LimitedBy": (long)
  }
}
Параметр Тип Описание
Структура result (для JSON) / GetResponse (для SOAP)
AdImages array of AdImageGetItem Изображения.
LimitedBy long Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка.
Структура AdImageGetItem
AdImageHash string Хэш изображения.
Name string Произвольное наименование изображения. Не более 255 символов.
Associated YesNoEnum Привязано ли изображение хотя бы к одному объявлению клиента.
Type AdImageTypeEnum Тип изображения, см. Тип изображения.
Subtype AdImageSubtypeEnum Размер изображения для типа FIXED_IMAGE. Для изображений с типом, отличным от FIXED_IMAGE, возвращается значение NONE.
OriginalUrl string, nillable Ссылка на изображение в полном размере.
PreviewUrl string, nillable Ссылка на превью изображения.