get
Возвращает параметры креативов, отвечающих заданным критериям.
Ограничения
Метод возвращает не более 10 000 объектов.
Запрос
Структура запроса в формате JSON:
{
"method": "get",
"params": {
"SelectionCriteria": { /* CreativesSelectionCriteria */
"Ids": [(long), ... ],
"Types": [( "IMAGE_CREATIVE" | "HTML5_CREATIVE" | "VIDEO_EXTENSION_CREATIVE" | "CPC_VIDEO_CREATIVE" | "CPM_VIDEO_CREATIVE" | "SMART_CREATIVE" ), ... ]
}, /* required */
"FieldNames": [( "Id" | "Type" | "Name" | "PreviewUrl" | "Width" | "Height" | "ThumbnailUrl" | "Associated" | "IsAdaptive" ), ... ], /* required */
"VideoExtensionCreativeFieldNames": [( "Duration" ), ... ],
"CpcVideoCreativeFieldNames": [( "Duration" ), ... ],
"CpmVideoCreativeFieldNames": [( "Duration" ), ... ],
"SmartCreativeFieldNames" : [( "CreativeGroupId" | "CreativeGroupName" | "BusinessType" ), ... ],
"Page": { /* LimitOffset */
"Limit": (long),
"Offset": (long)
}
}
}
Ниже приведено описание параметров.
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | CreativesSelectionCriteria | Критерий отбора креативов. Чтобы получить все креативы рекламодателя, необходимо указать пустой SelectionCriteria. | Да |
FieldNames | array of AdFieldEnum | Имена параметров верхнего уровня, которые требуется получить. | Да |
VideoExtensionCreativeFieldNames | array of VideoExtensionCreativeFieldNames | Имена параметров креативов для видеодополнений, которые требуется получить. См. Тип креатива. Примечание. Если согласно SelectionCriteria отобран креатив другого типа, параметры из VideoExtensionCreativeFieldNames не возвращаются. | Нет |
CpcVideoCreativeFieldNames | array of CpcVideoCreativeFieldEnum | Имена параметров креативов для видеообъявлений (в кампаниях с типом «Текстово-графические объявления»), которые требуется получить. Примечание. Если согласно SelectionCriteria отобран креатив другого типа, параметры из CpcVideoCreativeFieldNames не возвращаются. | Нет |
CpmVideoCreativeFieldNames | array of CpmVideoCreativeFieldEnum | Имена параметров креативов для видеообъявлений (в кампаниях с типом «Медийная кампания»), которые требуется получить. Примечание. Если согласно SelectionCriteria отобран креатив другого типа, параметры из CpmVideoCreativeFieldNames не возвращаются. | Нет |
SmartCreativeFieldNames | array of SmartCreativeFieldEnum | Имена параметров креативов для смарт-баннеров, которые требуется получить. Примечание. Если согласно SelectionCriteria отобран креатив другого типа, параметры из SmartCreativeFieldNames не возвращаются. | Нет |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура CreativesSelectionCriteria | |||
Ids | array of long | Отбирать креативы с указанными идентификаторами. От 1 до 10 000 элементов в массиве. | Нет |
Types | array of CreativeTypeEnum | Отбирать креативы с указанными типами. См. Тип креатива. | Нет |
Параметр | Тип | Описание | Обязательный |
Структура params (для JSON) / GetRequest (для SOAP) | |||
---|---|---|---|
SelectionCriteria | CreativesSelectionCriteria | Критерий отбора креативов. Чтобы получить все креативы рекламодателя, необходимо указать пустой SelectionCriteria. | Да |
FieldNames | array of AdFieldEnum | Имена параметров верхнего уровня, которые требуется получить. | Да |
VideoExtensionCreativeFieldNames | array of VideoExtensionCreativeFieldNames | Имена параметров креативов для видеодополнений, которые требуется получить. См. Тип креатива. Примечание. Если согласно SelectionCriteria отобран креатив другого типа, параметры из VideoExtensionCreativeFieldNames не возвращаются. | Нет |
CpcVideoCreativeFieldNames | array of CpcVideoCreativeFieldEnum | Имена параметров креативов для видеообъявлений (в кампаниях с типом «Текстово-графические объявления»), которые требуется получить. Примечание. Если согласно SelectionCriteria отобран креатив другого типа, параметры из CpcVideoCreativeFieldNames не возвращаются. | Нет |
CpmVideoCreativeFieldNames | array of CpmVideoCreativeFieldEnum | Имена параметров креативов для видеообъявлений (в кампаниях с типом «Медийная кампания»), которые требуется получить. Примечание. Если согласно SelectionCriteria отобран креатив другого типа, параметры из CpmVideoCreativeFieldNames не возвращаются. | Нет |
SmartCreativeFieldNames | array of SmartCreativeFieldEnum | Имена параметров креативов для смарт-баннеров, которые требуется получить. Примечание. Если согласно SelectionCriteria отобран креатив другого типа, параметры из SmartCreativeFieldNames не возвращаются. | Нет |
Page | LimitOffset | Структура, задающая страницу при постраничной выборке данных. | Нет |
Структура CreativesSelectionCriteria | |||
Ids | array of long | Отбирать креативы с указанными идентификаторами. От 1 до 10 000 элементов в массиве. | Нет |
Types | array of CreativeTypeEnum | Отбирать креативы с указанными типами. См. Тип креатива. | Нет |
Ответ
Структура ответа в формате JSON:
{
"result": { /* result */
"Creatives": [{ /* CreativeGetItem */
"Id": (long),
"Type": ( "IMAGE_CREATIVE" | "HTML5_CREATIVE" | "VIDEO_EXTENSION_CREATIVE" | "CPC_VIDEO_CREATIVE" | "CPM_VIDEO_CREATIVE" | "SMART_CREATIVE" ),
"Name": (string),
"PreviewUrl": (string),
"Width": (int),
"Height": (int),
"ThumbnailUrl": (string),
"Associated": ( "YES" | "NO" ),
"IsAdaptive": ( "YES" | "NO" ),
"VideoExtensionCreative": { /* VideoExtensionCreativeGet */
"Duration": (int) /* required */
},
"CpcVideoCreative": { /* CpcVideoCreativeGet */
"Duration": (int) /* required */
},
"CpmVideoCreative": { /* CpmVideoCreativeGet */
"Duration": (int) /* required */
},
"SmartCreative" : { /* SmartCreativeGet */
"CreativeGroupId" : (long),
"CreativeGroupName" : (string),
"BusinessType" : ( "RETAIL" | "HOTELS" | "REALTY" | "AUTOMOBILES" | "FLIGHTS" | "CLOTHES" | "OTHER" )
}
}, ... ],
"LimitedBy": (long)
}
}
Ниже приведено описание параметров.
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
Creatives | array of CreativeGetItem | Креативы. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура CreativeGetItem | ||
Id | long | Идентификатор креатива. |
Type | CreativeTypeEnum | Тип креатива. См. Тип креатива. |
Name | string | Название видеокреатива или группы графических креативов. |
PreviewUrl | string | Ссылка для предварительного просмотра. |
Width | int | Ширина креатива. |
Height | int | Высота креатива. |
ThumbnailUrl | string | Ссылка на миниатюру для предварительного просмотра. |
Associated | YesNoEnum | Привязан ли креатив хотя бы к одному объявлению клиента. |
IsAdaptive | YesNoEnum | Является ли креатив адаптивным. |
VideoExtensionCreative | VideoExtensionCreativeGet | Параметры креатива для видеодополнений. |
CpcVideoCreative | CpcVideoCreativeGet | Параметры креатива для видеообъявлений (в кампаниях с типом «Текстово-графические объявления»). |
CpmVideoCreative | CpmVideoCreativeGet | Параметры креатива для видеообъявлений (в кампаниях с типом «Медийная кампания»). |
SmartCreative | SmartCreativeGet | Параметры креатива для смарт-баннеров (в кампаниях с типом «Смарт-баннеры»). |
Структура VideoExtensionCreativeGet | ||
Duration | int | Длительность видео в секундах. |
Структура CpcVideoCreativeGet | ||
Duration | int | Длительность видео в секундах. |
Структура CpmVideoCreativeGet | ||
Duration | int | Длительность видео в секундах. |
Структура SmartCreativeGet | ||
CreativeGroupId | long | Идентификатор группы креативов. |
CreativeGroupName | string | Название группы креативов. |
BusinessType | BusinessTypeEnum | Тематика креатива, которая соответствует типу бизнеса фида. |
Параметр | Тип | Описание |
Структура result (для JSON) / GetResponse (для SOAP) | ||
---|---|---|
Creatives | array of CreativeGetItem | Креативы. |
LimitedBy | long | Порядковый номер последнего возвращенного объекта. Передается в случае, если количество объектов в ответе было ограничено лимитом. См. раздел Постраничная выборка. |
Структура CreativeGetItem | ||
Id | long | Идентификатор креатива. |
Type | CreativeTypeEnum | Тип креатива. См. Тип креатива. |
Name | string | Название видеокреатива или группы графических креативов. |
PreviewUrl | string | Ссылка для предварительного просмотра. |
Width | int | Ширина креатива. |
Height | int | Высота креатива. |
ThumbnailUrl | string | Ссылка на миниатюру для предварительного просмотра. |
Associated | YesNoEnum | Привязан ли креатив хотя бы к одному объявлению клиента. |
IsAdaptive | YesNoEnum | Является ли креатив адаптивным. |
VideoExtensionCreative | VideoExtensionCreativeGet | Параметры креатива для видеодополнений. |
CpcVideoCreative | CpcVideoCreativeGet | Параметры креатива для видеообъявлений (в кампаниях с типом «Текстово-графические объявления»). |
CpmVideoCreative | CpmVideoCreativeGet | Параметры креатива для видеообъявлений (в кампаниях с типом «Медийная кампания»). |
SmartCreative | SmartCreativeGet | Параметры креатива для смарт-баннеров (в кампаниях с типом «Смарт-баннеры»). |
Структура VideoExtensionCreativeGet | ||
Duration | int | Длительность видео в секундах. |
Структура CpcVideoCreativeGet | ||
Duration | int | Длительность видео в секундах. |
Структура CpmVideoCreativeGet | ||
Duration | int | Длительность видео в секундах. |
Структура SmartCreativeGet | ||
CreativeGroupId | long | Идентификатор группы креативов. |
CreativeGroupName | string | Название группы креативов. |
BusinessType | BusinessTypeEnum | Тематика креатива, которая соответствует типу бизнеса фида. |