banner
Получить список баннеров.
Формат запроса
Примечание
Доступна пагинация.
Примечание
Доступ к запросу для пользователя с типом «владелец сайта».
https://adfox.yandex.ru/api/v1
? object=account
& action=list
& actionObject=banner
& [actionObjectID=<integer>]
& [listCampaignIDs=<integer>]
& [show=<string>]
& [search=<string>]
|
Чтобы получить данные только по одному баннеру, укажите его идентификатор. Значение по умолчанию: 0 — выводить список всех баннеров. |
|
Вывести результат только для указанных кампаний. Список ID кампаний через запятую. Читайте также: |
|
Настройка полноты данных в списке кампаний/флайтов: Допустимые значения:
Значение по умолчанию: |
|
Фильтрация по подстроке в имени кампании/флайта. Может содержать русские и латинские буквы, цифры и любые символы. |
* Обязательный параметр
Формат ответа
<response>
<status>
<code>{integer}</code>
</status>
<data>
<result>
<row0>
<ID>{integer}</ID>
<name>{string}</name>
<campaignID>{integer}</campaignID>
<campaignName>{string}</campaignName>
<campaignDateStart>{date}</campaignDateStart>
<campaignDateEnd>{date}</campaignDateEnd>
<bannerTypeID>{integer}</bannerTypeID>
<bannerTypeName>{string}</bannerTypeName>
<status>{integer}</status>
<isUnplaced>{integer}</isUnplaced>
<priority>{integer}</priority>
<impressions>{integer}</impressions>
<impressionsToday>{integer}</impressionsToday>
<impressionsHour>{integer}</impressionsHour>
<clicks>{integer}</clicks>
<clicksToday>{integer}</clicksToday>
<clicksHour>{integer}</clicksHour>
<targetingProfileID>{integer}</targetingProfileID>
<targetingProfileName>{string}</targetingProfileName>
<isEvents>{integer}</isEvents>
<templateID>{integer}</templateID>
<templateName>{string}</templateName>
<imageURL>{string}</imageURL>
<hitURL>{string}</hitURL>
<target>{string}</target>
<alt>{string}</alt>
<isParameter1Required>{integer}</isParameter1Required>
<parameter1Name>{string}</parameter1Name>
<parameter1Type>{string}</parameter1Type>
<parameter1Length>{integer}</parameter1Length>
<parameter1Default>{string}</parameter1Default>
<parameter1>{integer}</parameter1>
<isParameter2Required>{integer}</isParameter2Required>
<parameter2Name>{string}</parameter2Name>
<parameter2Type>string</parameter2Type>
<parameter2Length>{integer}</parameter2Length>
<parameter2Default>{string}</parameter2Default>
<parameter2>{integer}</parameter2>
<impressionCode>{html}</impressionCode>
<maxImpressions>{integer}</maxImpressions>
<maxImpressionsPerDay>{integer}</maxImpressionsPerDay>
<maxImpressionsPerHour>{integer}</maxImpressionsPerHour>
<maxClicks>{integer}</maxClicks>
<maxClicksPerDay>{integer}</maxClicksPerDay>
<maxClicksPerHour>{integer}</maxClicksPerHour>
<dateStart>{date}</dateStart>
<dateEnd>{date}</dateEnd>
<dateAdded>{date}</dateAdded>
<sendToErir>{integer}</sendToErir>
<markingSettings>
<adLabel>{integer}</adLabel>
<domain>{string}</domain>
<showMenu>{integer}</showMenu>
</markingSettings>
<markingInfo>
<token>{string}</token>
<description>{string}</description>
<contentType>{integer}</contentType>
<targetURL>{string}</targetURL>
<okveds>
<row0>{string}</row0>
</okveds>
<creatives>
<row0>
<textData>{string}</textData>
<mediaData>{string}</mediaData>
<mediaDataDescription>{string}</mediaDataDescription>
<fromTemplate>{integer}</fromTemplate>
</row0>
</creatives>
</markingInfo>
</row0>
</data>
</result>
</response>
Параметры ответа
|
Статус обработки запроса. Значение |
|
Количество элементов в дереве ответа. |
|
Порядковый номер элемента в дереве ответа, где N — число от 0 до rows-1 (где rows — общее количество элементов в ответе). |
|
Уникальный идентификатор баннера. |
|
Название баннера. |
|
ID кампании, в которой находится баннер. |
|
Название кампании, в которой находится баннер. |
|
Дата старта кампании. |
|
Дата окончания кампании. |
|
ID типа баннера, с помощью которого создан баннер. |
|
Название типа баннера, с помощью которого создан баннер. |
|
Статус. Возможные значения:
|
|
Отключен на новых площадках (дополнительный модуль). |
|
Приоритет баннера относительно других баннеров данной кампании. |
|
Показания счетчиков. Показов всего. |
|
Показания счетчиков. Показов сегодня. |
|
Показания счетчиков. Показов в текущий час. |
|
Показания счетчиков. Кликов всего. |
|
Показания счетчиков. Кликов сегодня. |
|
Показания счетчиков. Кликов в текущий час. |
|
ID профиля таргетирования. |
|
Названия профиля таргетирования. |
|
Включена возможность получения ссылок на события. |
|
ID шаблона баннера. |
|
Название шаблона баннера. |
|
Ссылка на изображение графических баннеров, заглушку flash-баннеров. |
|
Выводится только для площадок с типом баннера 1x1. Ссылка для перехода на сайт рекламодателя. |
|
В каком окне открывать ссылку для перехода. |
|
Альтернативный текст для изображения. |
|
Обязательный/необязательный дополнительный параметр (user-переменная), где N — номер параметра от 1 до 25. |
|
Название дополнительного параметра, где N — номер параметра от 1 до 25. |
|
Тип данных дополнительного параметра, где N — номер параметра от 1 до 25. |
|
Максимальная длина для значения дополнительного параметра, где N — номер параметра от 1 до 25. |
|
Значение по умолчанию для дополнительного параметра, где N — номер параметра от 1 до 25. |
|
HTML-код баннера. |
|
Максимальное количество показов. |
|
Максимальное количество показов в сутки. |
|
Максимальное количество показов в час. |
|
Максимальное кликов всего. |
|
Максимальное количество кликов в сутки. |
|
Максимальное количество кликов в час. |
|
Дата начала открутки. |
|
Дата окончания открутки. |
|
Дата добавления. |
|
Передавать данные в ЕРИР. Допустимые значения:
|
|
Настройка рекламного меню и метки «Реклама». |
|
Показывать метку «Реклама» или «Соцреклама»на баннере. Допустимые значения:
|
|
Домен рядом с меткой «Реклама». |
|
Показывать меню на баннере. Допустимые значения:
|
|
Информация о креативе. |
|
Токен баннера. |
|
Описание креатива. |
|
Тип креатива. Допустимые значения:
|
|
Целевая ссылка. |
|
Список с ОКВЭД-ами рекламируемых товаров. |
|
Массив с текстовыми данными креативов. |
|
Массив с медиаданными креативов. |
|
Описание креатива. |
|
Креатив заполняется автоматически из параметров баннера (если включена опция на шаблоне). |
Пример запроса и ответа
Запрос:
https://adfox.yandex.ru/api/v1?object=account&action=list&actionObject=banner
Ответ:
<response> <status> <code>0</code> </status> <data> <result> <row0> <ID>940132</ID> <name>example</name> <campaignID>321516</campaignID> <campaignName>test campaign</campaignName> <campaignDateStart>2020-11-27 00:00:00</campaignDateStart> <campaignDateEnd/> <bannerTypeID>24</bannerTypeID> <bannerTypeName>Перетяжка 100%</bannerTypeName> <status>2</status> <isUnplaced>0</isUnplaced> <priority>100</priority> <impressions>184</impressions> <impressionsToday>0</impressionsToday> <impressionsHour>0</impressionsHour> <clicks>0</clicks> <clicksToday>0</clicksToday> <clicksHour>0</clicksHour> <targetingProfileID>306331</targetingProfileID> <targetingProfileName/> <isEvents>0</isEvents> <templateID>16602</templateID> <templateName>Картинка [Sync_Async]</templateName> <imageURL> http://banners.adfox.ru/000000/adfox/0000000/940132.jpg </imageURL> <hitURL>http://www.yandex.ru/</hitURL> <target>_blank</target> <alt/> <isParameter1Required>1</isParameter1Required> <parameter1Name>Ширина изображения</parameter1Name> <parameter1Type>string</parameter1Type> <parameter1Length>0</parameter1Length> <parameter1Default/> <parameter1>120</parameter1> <isParameter2Required>1</isParameter2Required> <parameter2Name>Высота изображения</parameter2Name> <parameter2Type>string</parameter2Type> <parameter2Length>0</parameter2Length> <parameter2Default/> <parameter2>120</parameter2> <impressionCode> <img src="http://banners.adfox.ru/0000000/adfox/000000/940132.jpg" width="120" height="120" alt="" border=0> </impressionCode> <maxImpressions>0</maxImpressions> <maxImpressionsPerDay>0</maxImpressionsPerDay> <maxImpressionsPerHour>0</maxImpressionsPerHour> <maxClicks>0</maxClicks> <maxClicksPerDay>0</maxClicksPerDay> <maxClicksPerHour>0</maxClicksPerHour> <dateStart>2021-02-05 00:00:00</dateStart> <dateEnd/> <dateAdded>2021-02-05 18:28:35</dateAdded> <sendToErir>1</sendToErir> <markingSettings> <adLabel>0</adLabel> <domain></domain> <showMenu>1</showMenu> </markingSettings> <markingInfo> <token>4CQwVszH9pQMNLzJn7q</token> <description>тест</description> <contentType>1</contentType> <targetURL></targetURL> <okveds> <row0>123</row0> </okveds> <creatives> <row0> <textData>тест</textData> <mediaData></mediaData> <mediaDataDescription></mediaDataDescription> <fromTemplate>0</fromTemplate> </row0> </creatives> </markingInfo> </row0> </data> </result> </response>
Другие действия с объектом
Читайте также о других действиях с объектом banner
:
- добавить баннер;
- удалить баннер;
- редактировать баннер;
- получить информацию о размещении баннера;
- редактировать размещение баннера;
- получить статистику по кампаниям/баннерам/площадкам за день
- таргетировать баннер по частоте;
- таргетировать баннер по географии;
- таргетировать баннер по ключевым словам;
- таргетировать баннер по полу, возрасту, доходу;
- таргетировать баннер по пользовательским характеристикам;
- таргетировать баннер по времени.
Чтобы получить данные только по одному баннеру, укажите его идентификатор.
Значение по умолчанию: 0 — выводить список всех баннеров.
Вывести результат только для указанных кампаний. Список ID кампаний через запятую.
Читайте также:
Настройка полноты данных в списке кампаний/флайтов:
Допустимые значения:
-
common
— краткий вывод:-
ID;
-
name.
-
-
short
— сокращенный вывод:-
ID;
-
bannerTypeID;
-
templateID;
-
campaignID;
-
status;
-
dateStart;
-
dateEnd.
-
-
advanced
— полный вывод.
Значение по умолчанию: advanced
.
Фильтрация по подстроке в имени кампании/флайта.
Может содержать русские и латинские буквы, цифры и любые символы.
Обязательный параметр