--- metadata: - name: generator content: Diplodoc Platform v5.50.1 alternate: - https://yandex.com/dev/adfox/doc/en/v.1/zone/zone-modify.md - https://yandex.com/dev/adfox/doc/ru/v.1/zone/zone-modify.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/adfox/doc/ru/llms.txt # modify Редактировать параметры раздела сайта. ## Формат запроса {#input} ``` https://adfox.yandex.ru/api/v1 ? object=zone & action=modify & [objectID](*objectID)= & [[name](*name)=] & [[categoryID](*categoryID)=] & [[isAutoReferer](*isAutoReferer)=] & [[templateTypeID](*templateTypeID)=] & [[template](*template)=] & [[templateExcluded](*templateExcluded)=] ``` #| || `objectID`[*](*requiredParam) | {% include notitle [Описание](../../_includes/v.1.md#objectID) %} || || `name` | {% include notitle [Описание](../../_includes/v.1.md#name) %} || || `categoryID` | {% include notitle [Описание](../../_includes/v.1.md#categoryID) %} || || `isAutoReferer` | {% include notitle [Описание](../../_includes/v.1.md#isAutoReferer) %} || || `templateTypeID` | {% include notitle [Описание](../../_includes/v.1.md#templateTypeID) %} {% include notitle [Значение по умолчанию](../../_includes/shorts.md#defaultzero) %} || || `template` | {% include notitle [Описание](../../_includes/v.1.md#template) %} || || `templateExcluded` | {% include notitle [Описание](../../_includes/v.1.md#templateExcluded) %} || |# ## Формат ответа {#output-structure} ```xml {integer} ``` ## Параметры ответа {#spec-output_1} #| || `code` | {% include notitle [Описание](../../_includes/v.1.md#code) %} || |# > **Пример запроса и ответа** > > Запрос: > > ```css > https://adfox.yandex.ru/api/v1?object=zone&action=modify&objectID=543&name=site.ru/news > ``` > > Ответ: > > ```xml > > > 0 > > > ``` > ## Другие действия с объектом {#other-actions} Читайте также о других действиях с объектом `zone`: - [добавить раздел сайта](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-add-zone.md); - [удалить раздел сайта](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-delete-zone.md); - [получить список разделов сайта](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-list-zone.md). [*objectID]: ID объекта, над которым производится действие. [*name]: Название объекта. Может содержать русские и латинские буквы, цифры и любые символы. [*categoryID]: ID категории. Читайте также: - [Добавить категорию](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-add-category.md) - [Получить список категорий](https://yandex.com/dev/adfox/doc/ru/v.1/account/account-list-category.md) [*isAutoReferer]: Динамическое определение раздела сайта по referer. Каждый запрос за баннером содержит информацию об адресе страницы (referer), откуда идет запрос. Включение данной опции позволяет использовать [код вставки, полученный с уровня сайта](https://yandex.com/dev/adfox/doc/ru/v.1/placement/placement-info-website.md). При этом система будет автоматически определять, к какому разделу сайта относится запрос, на основании поля referer запроса. При выключении данной опции необходимо использовать [коды вставки с уровня площадки](https://yandex.com/dev/adfox/doc/ru/v.1/placement/placement-info-place.md). Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `1`. [*templateTypeID]: Тип шаблонов страниц. Подробнее о типах шаблонов читайте в статье [Шаблоны referer](https://yandex.ru/support/adfox-sites/codes/referrer-templates.html?lang=ru). Допустимые значения: - `0` — стандартный; - `1` — POSIX.2. Значение по умолчанию: `0`. [*template]: Укажите шаблоны страниц, по которым будет производиться сравнение полученного адреса в запросе за баннером. {% cut "Пример" %} - Для стандартного типа шаблонов: ```css ٭site.ru/index.php ``` - Для POSIX.2: ```css homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$ ``` {% endcut %} Может содержать русские и латинские буквы, цифры и любые символы. [*templateExcluded]: Шаблоны страниц, которые не должны относиться к данному разделу сайта. {% cut "Пример" %} - Для стандартного типа шаблонов: ```css http://٭site.ru ``` Под такой шаблон попадут адреса: `http://site.ru`, `http://example.site.ru`. - Для POSIX.2: ```css homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$ ``` Под такой шаблон попадут адреса: - `homer-simpson-tv.blog4ever.com` - `http://homer-simpson-tv.blog4ever.com/?a=1212` - `forum.rojadirecta.org` - `https://www.forum.rojadirecta.org/?b=123` - `hidan.eklablog.com/?b=123` - `aniworld.spb.ru/123/adfox/s` {% endcut %} Может содержать русские и латинские буквы, цифры и любые символы. [*requiredParam]: Обязательный параметр. {% included (../../_includes/v.1.md) %} ### {#actionType} Описание действий посредника-представителя. Допустимые значения: - `0` — Иное. - `1` — Действия в целях распространения рекламы. - `2` — Заключение договоров. - `3` — Коммерческое представительство. Значение по умолчанию: `0`. Чтобы значение перешло в состояние «Не задано», можно передать null или пустое значение `''`. При редактировании перевести в состояние «Не задано» можно так: `actionType=&`. ### {#actionStatus} Включить/выключить размещение. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#account} Учетная запись пользователя. Название учетной записи должно быть уникальным в рамках системы. Может содержать русские и латинские буквы, цифры и любые символы. ### {#actionObjectID-get} Чтобы получить данные только по одному объекту, укажите его ID. Значение по умолчанию: `0` — выводить весь список. ### {#actionObjectID2} Фильтр по ID сайта. ### {#advertiserAccount} Учетная запись рекламодателя. ### {#age} Включить таргетирование по возрасту. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#ageValues} Выбрать значение возраста. Параметр **обязателен**, если `age`=`1`. Допустимые значения: - `1` — меньше 18; - `2` — от 18 до 24; - `3` — от 25 до 34; - `4` — от 35 до 44; - `5` — больше 45 (значение устарело, его использование автоматически включает значения 6 и 7); - `6` — от 45 до 54; - `7` — больше 55. Для передачи нескольких значений используйте разделитель — вертикальную черту `|` без пробелов. ### {#agentActingForPublisher} Функция посредника, признак направления денежного потока в сторону принципала. Обязателен, если выбран тип договора `type`=`1`, в противном случае указывать нельзя. Допустимые значения: - `0` — агент действует в интересах РД в этом агентском договоре (является представителем рекламодателя). - `1` — агент действует в интересах РР в этом агентском договоре (является представителем рекламной площадки). ### {#adLabel} Показывать метку «Реклама» или «Соцреклама» на баннере. Допустимые значения: - `0` — метка отключена; - `1` — показывать метку «Реклама»; - `2` — показывать метку «Соцреклама». ### {#additionalAdvertiserIDs} ID дополнительных рекламодателей. ### {#additionalAdvertiserAccounts} Учетные записи дополнительных рекламодателей. ### {#additionalAssistantIDs} ID дополнительных ассистентов. ### {#additionalAssistantAccounts} Учетные записи дополнительных ассистентов. ### {#address1} Адрес. ### {#address2} Продолжение адреса. ### {#advertiserID} ID рекламодателя. Если кампания добавляется к суперкампании, то рекламодатель не указывается и будет унаследован от суперкампании. Читайте также: - [Cоздать рекламодателя](../v.1/account/account-add-advertiser.md) - [Получить список рекламодателей](../v.1/account/account-list-advertiser.md) ### {#advertiserID-track} ID рекламодателя, к которому необходимо приписать точку учета действия. {% cut "Ошибка `Duplicate entry for key «advertiser_id_user_id»`" %} У рекламодателя уже существует точка с данным идентификатором (поле **Идентификатор**, не путать с **ID**). {% endcut %} ### {#alt} Значение параметра `alt` для тега `img` — альтернативный текст для изображения. ### {#amountRub} Цена договора. Передается, только если `amountType`=`0` (возмездный). ### {#amountType} Цена договора. Допустимые значения: - `0` — Возмездный (при этом значении обязательным становится `amountRub`). - `1` — Безвозмездный. - `2` — В договоре нет цены. ### {#assistantID} ID [ассистента](https://yandex.ru/support/adfox-sites/users/assistant-api.html?lang=ru), которому будет разрешен доступ к объекту в соответствии с его правами доступа. Если кампания добавляется к суперкампании, то ассистент не указывается и будет унаследован от суперкампании. Читайте также: - [Создать ассистента](../v.1/account/account-add-assistant.md) - [Получить список ассистентов](../v.1/account/account-list-assistant.md) ### {#backgroundColor} Цвет фона в формате HEX, например: `#FFFFFF`. ### {#bannerTypeName} Название типа баннера. ### {#bannerID} ID баннера. Читайте также: - [Получить список баннеров](../v.1/account/account-list-banner.md) ### {#bannerTypeID} ID типа баннера. Читайте также: - [Создать тип баннера](../v.1/account/account-add-bannerType.md) - [Посмотреть список ID типов баннера](../v.1/account/account-list-bannerType.md) ### {#behaviorMode} Использовать таргетирование по поведению для пользователей, размеченных с помощью: - `0` — постоянной категории, если разметка аудитории производится с помощью указания категории для сайта, раздела или площадки; - `1` — временной категории, если разметка аудитории производится с помощью точек учета действия. ### {#blocks} Применяется представление логического выражения в виде n-мерного дерева, отображенного в нерекурсивную (ссылки по ID вместо полного описания дочерних узлов) json-структуру. {% cut "Вид структуры" %} ```json {"version": 1,"nodes": [{"id": 1,"type": 2, "value": { "subnodes": [2, 5, 6] }}, {"id": 2,"type": 1, "value": { "subnodes": [3, 4] }}, {"id": 3,"type": 3, "value": { "key": 1, "values": [6, 7, 8] }}, {"id": 4,"type": 3, "value": { "key": 1, "values": [4, 5] }}, {"id": 5,"type": 3, "value": { "key": 2, "values": [1] }}, {"id": 6,"type": 3,"invert": true, "value": { "key": 2, "values": [2] }}]} {"version": 1,"nodes": [{"id": 1,"type": 2, "value": { "subnodes": [2, 5, 6] }}, {"id": 2,"type": 1, "value": { "subnodes": [3, 4] }}, {"id": 3,"type": 3, "value": { "key": 1, "values": [6, 7, 8] }}, {"id": 4,"type": 3, "value": { "key": 1, "values": [4, 5] }}, {"id": 5,"type": 3, "value": { "key": 2, "values": [1] }}, {"id": 6,"type": 3,"invert": true, "value": { "key": 2, "values": [2] }}]} ``` {% endcut %} Как видно, структура предусматривает версионность. Представление, приведенное в примере, соответствует версии 1. Дальнейшие изменения/расширения подразумеваются в последующих версиях. Каждый узел первой версии имеет четыре поля: - `id` — ID узла в пределах дерева. Нумерация всегда начинается с 1. Узел с ID=`1` всегда является корневым. - `invert` — флаг инверсии. Способ задания логики НЕ. Применяется к результату вычисления узла целиком — в случае наличия дочерних узлов сначала вычисляются все дочерние. - `type` — ID типа содержимого узла: - `1` — группирующий узел И; - `2` — группирующий узел ИЛИ; - `3` — узел проверки пользовательских полей (PUID). Узлы типов И и ИЛИ фактически реализуют скобки, все дочерние узлы в которых объединены соответствующей операцией. - `value` — json-представление содержимого узла в виде ключа и его значений: - `key` — ID пользовательской характеристики; - `values` — массив ID значений пользовательской характеристики. {% cut "Пример" %} Характеристика со значениями: `a` (valueID=`10`), `b` (valueID=`20`), `c` (valueID=`30`). `{"key": 1, "values": [10,20,30]}` {% endcut %} Читайте также: - [Получить список значений характеристики пользовательского таргетирования](../v.1/userCriteria/userCriteria-listValues.md) ### {#bundleID} ID [профиля размещения](https://yandex.ru/support/adfox-sites/settings/profiles.html?lang=ru). Профиль размещения позволяет объединить площадки, на которых часто размещаются кампании. При создании новой кампании, вы можете сразу указать профиль размещения, тогда кампания будет размещена на указанных в профиле площадках. ### {#categoryName} Название категории. ### {#categoryIDN} Укажите, с какой категорией должен быть размечен пользователь, где `N` в названии параметра — номер условия от 1 до 9. Допустимые значения: ID категории. Значение по умолчанию: `0` — не задано, если таргетирование проводится на неразмеченных пользователей. Читайте также: - [Получить список категорий](../v.1/account/account-list-category.md) ### {#categoryID} ID категории. Читайте также: - [Добавить категорию](../v.1/account/account-add-category.md) - [Получить список категорий](../v.1/account/account-list-category.md) ### {#categoryID-1} ID категории, к которой будет размечена аудитория, контактирующая с точкой учета действия. Допустимые значения: - `0` — категория не задана; - `N` — ID категории. Значение по умолчанию: `0`. ### {#campaignName} Название кампании. ### {#company} Название компании. ### {#campaignDateStart} Дата старта кампании. ### {#campaignDateEnd} Дата окончания кампании. ### {#campaignID} ID кампании или флайта, куда будет добавлен баннер. Читайте также: - [Посмотреть список ID кампаний/флайтов](../v.1/account/account-list-campaign.md) - [Создать кампанию/флайт](../v.1/account/account-add-campaign.md) ### {#campaignID-2} ID кампании, в которой находится баннер. ### {#chargePaidByAgent} Признак «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент». Поле может передаваться только в посредническом договоре `type`=`1` и признаке направления денежного потока в сторону принципала `agentActingForPublisher`=`0`. Допустимые значения: - `0` — выключено; - `1` — включено (сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент). ### {#city} Город. ### {#clicks} Общее количество кликов по баннерам. ### {#clicksToday} Кликов сегодня. ### {#clicksToday-1} Показания счетчиков. Кликов сегодня. ### {#clicksPerPeriod} Частота контакта пользователя с рекламной кампанией за выбранный период. Количество переходов за период. Допустимые значения: целое число от `1` до `2147483647`. ### {#contentType} Системные шаблоны. Параметр обязателен, если не задан шаблон баннера `templateID`. Допустимое значение: `XML` — XML-баннер (для XML типов). ### {#creativeContentType} Форма распространения рекламы. Допустимые значения: - `1` — баннер; - `2` — текстово-графический блок; - `3` — текстовый блок; - `4` — видеоролик; - `5` — видеотрансляция в прямом эфире; - `6` — аудиотрансляция в прямом эфире; - `7` — аудиозапись; - `8` — текстовый блок с видео; - `9` — текстово-графический блок с видео; - `10` — текстовый блок с аудио; - `11` — текстово-графический блок с аудио; - `12` — текстовый блок с аудио и видео; - `13` — текстово-графический блок с аудио и видео; - `14` — HTML5-баннер. ### {#code} Статус обработки запроса. Значение `0` — запрос выполнен успешно. Расшифровку смотрите в разделе [Обработка ошибок](../v.1/errors.md). ### {#costType} Тип кампании. Допустимые значения: - `0` — другое; - `1` — CPM; - `2` — CPC; - `3` — CPA. ### {#contractID} ID прямого или первичного договора. Обязательно для заполнения, если значение `sendToErir`=`1`. Подробнее о [получении списка договоров](../v.1/account/account-list-contract.md). ### {#commonProfileID} ID [общего профиля](https://yandex.ru/support/adfox-sites/settings/profiles.html?lang=ru). Общий профиль объединяет профиль таргетирования и профиль размещения. При указании общего профиля не нужно передавать `targetingProfileID` и `bundleID`. ### {#countryOKSM} ОКСМ код страны регистрации. ### {#comments} Комментарий. ### {#contractorID} ID контрагента. Параметр для маркировки рекламы. ### {#contractRole} Роль договора. Допустимые значения: - `0` — первичный; - `1` — конечный; - `2` — прямой. ### {#country} Страна. ### {#counterPostView} Показания счетчика PostView за все время. ### {#counterPostViewToday} Показания счетчика PostView за сегодня. ### {#counterPostClick} Показания счетчика PostClick за все время. ### {#counterPostClickToday} Показания счетчика PostClick за сегодня. ### {#criteriaID} ID пользовательской характеристики. Допустимые значения: `1≤N≤63`, где `N` — порядковый номер характеристики от 1 до 63 включительно. ### {#cpm} Пороговое значение CPM для рекламной кампании вида **Динамическая монетизация**. Для `kind_id`=`2` — обязательный параметр. Для `kind_id`=`1|3` — необязательный, но если передается, то значение игнорируется. Допустимые значения: целое число от `1` до `99999`. Если передается CPM, то не передавайте CPC. ### {#cpc} Пороговое значение CPC для рекламной кампании вида **Динамическая монетизация**. Для `kind_id`=`2` — обязательный параметр. Для `kind_id`=`1|3` — необязательный, но если передается, то значение игнорируется. Допустимые значения: целое число больше `0`. Если передается CPC, то не передавайте CPM. ### {#cpv} Цена за 1000 показов видео (аналогично текущим CPC/CPM). Применимо только для стратегий по VTR. ### {#strategy} Допустимые значения: - `default` — по умолчанию; - `min_ctr` — минимальный CTR; - `optimize_clicks` — оптимизация кликов; - `max_clicks` — максимизация кликов; - `min_vtr` — минимальный VTR; - `max_vtr` — максимизация VTR. ### {#targetCPC} Таргетный CPC для стратегии `optimize_clicks` — целое число. ### {#customerID} ID заказчика. Как получить список ID контрагентов, см. в разделе [contractor](../v.1/account/account-list-contractor.md). ### {#dateStart} Дата начала открутки. Формат передачи даты и времени: `YYYY-MM-DD HH:mm`. Значение по умолчанию: сегодня с 00:00. ### {#dateEnd} Дата окончания открутки. Формат передачи даты и времени: `YYYY-MM-DD HH:mm`. ### {#dateAdded} Дата добавления. ### {#dateFinished} Дата завершения открутки. ### {#datePeriod} Дата начала периода, в течение которого действует установленное ограничение показов или переходов. Формат передачи даты: `YYYY-MM-DD`. ### {#dayN} Включить таргетирование по дням месяца, где `N` — номер дня месяца (например: `1` — первое число месяца, `2` — второе число месяца и т. д.). Допустимые значения: - `0` — выключено; - `1` — включено. ### {#domain} Домен рядом с меткой «Реклама». ### {#dateConclusion} Дата договора/дополнительного соглашения. Формат: `ГГГГ-ММ-ДД`. Дата не может быть больше текущей. ### {#defaultImageURL} URL изображения баннера по умолчанию. Только для `mode`=`0` и типа баннера **Стандартный** и **Безразмерный**. Если указан `defaultImageURL`, параметр `defaultHitURL` становится обязательным. ### {#defaultHitURL} URL для перехода с баннера по умолчанию. Только для `mode`=`0` и типа баннера **Стандартный** и **Безразмерный**. ### {#description} Значение таргетирования. ### {#defaultWidth} Ширина изображения в пикселях. Только для `mode`=`0` и типа баннера **Безразмерный**. ### {#defaultHeight} Высота изображения в пикселях. Только для `mode`=`0` и типа баннера **Безразмерный**. ### {#defaultCode} Код баннера по умолчанию. Только для `mode`=`1` и типа баннера **Безразмерный**. ### {#defaultCodeType} Тип кода для баннера по умолчанию. Допустимые значения: - `0` — HTML; - `1` — JavaScript. ### {#defaultCodeType-1} Только для `mode`=`1`. Тип кода. Допустимые значения: - `0` — HTML; - `1` — JavaScript. Значение по умолчанию: `0`. ### {#eMail} Адрес электронной почты, на которую будет зарегистрирован доступ пользователя. ### {#eMail-get} Адрес электронной почты, на которую зарегистрирован доступ пользователя. ### {#epayNumber} Номер электронного средства платежа. ### {#eventN} Названия событий, где `N` — номер события от 1 до 30. В каждом шаблоне определен набор используемых событий. Получите список переменных шаблона и передайте названия к этим событиям при добавлении или редактировании баннера. ### {#executorID} ID исполнителя. Как получить список ID контрагентов, см. в разделе [contractor](../v.1/account/account-list-contractor.md). ### {#fax} Факс. ### {#frequencyTypeImpressions} Частота контакта пользователя с рекламной кампанией за выбранный период. Период частоты показов. Допустимые значения: - `0` — не задано; - `1` — 1 час; - `2` — 4 часа; - `3` — 6 часов; - `4` — 12 часов; - `5` — сутки; - `6` — неделя; - `7` — месяц; - `8` — другой период; - `9` — 14 дней. Значение по умолчанию: `0`. Обязательно укажите хотя бы один из параметров: - `minImpressionsPerPeriod` - `impressionsPerPeriod` - `avgImpressionsPerPeriod` ### {#frequencyTypeClicks} Частота контакта пользователя с рекламной кампанией за выбранный период. Период частоты переходов. Допустимые значения: - `0` — не задано; - `1` — 1 час; - `2` — 4 часа; - `3` — 6 часов; - `4` — 12 часов; - `5` — сутки; - `6` — неделя; - `7` — месяц; - `8` — другой период; - `9` — 14 дней. Значение по умолчанию: `0`. Обязательным становится параметр `clicksPerPeriod`. ### {#flashParameterName} Название параметра, который используется для передачи ссылки перехода во flash-ролик. При разработке flash-ролика в коде, который отвечает за обработку клика, используется параметр, ожидающий на вход ссылку для перехода. Ссылка для перехода и название параметра для передачи ссылки в ролик указываются при добавлении баннера в Adfox. Название параметра в баннере и во flash-ролике должно совпадать. ### {#firstName} Имя пользователя. ### {#getURL} Ссылка на flash-ролик для flash-баннеров. ### {#gender} Включить таргетирование по полу. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#genderValues} Выбрать значение пола. Параметр **обязателен**, если `gender`=`1`. Допустимые значения: - `1` — мужской; - `2` — женский. ### {#geo} Включить таргетирование по географии. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#global} Настройка для пункта **Весь мир**, с помощью которой можно указать логику таргетирования: - `все разрешено, кроме` — если объектов для выключения меньше, то включите **Весь мир** и выключите определенные объекты в списке; - `все запрещено, кроме` — если требуется включить показы только на определенные объекты, выключите **Весь мир** и включите нужные объекты в списке. Допустимые значения: - `0` — сброшено — наследуется от элемента-родителя; - `1` — разрешено; - `2` — запрещено. ### {#height} Высота баннера. ### {#hitURL} Ссылка для перехода на сайт рекламодателя. ### {#hitURLN} Укажите URL перехода для событий, где `N` в названии параметра — номер события от 1 до 30. ### {#hourNdayM} Включить таргетирование по дням недели/часам, где: - `N` — час от 0 до 23 (например: `0` — с 00:00 до 00:59, `1` — с 01:00 до 01:59 и т. д.); - `M` — день недели с 1 до 7 (например: `1` — понедельник, `2` — вторник, `3` — среда и т. д.). Допустимые значения: - `0` — выключено; - `1` — включено. ### {#impressions} Общее количество показов баннеров. ### {#impressionsToday} Показания счетчиков. Показов сегодня. ### {#impressionsPerPeriod} Частота контакта пользователя с рекламной кампанией за выбранный период. Максимальное количество показов за заданный период. ### {#impressionsSmoothTypeID} Скорость открутки показов. Допустимые значения: - `0` — максимальная скорость открутки. Баннеры кампании будут показываться с максимальной возможной скоростью, пока не сработают ограничения по показам (если таковые имеются). Максимальная скорость открутки не требует указания лимитов и дат начала и окончания рекламной кампании. - `1` — равномерное распределение суточного ограничения. Показы будут равномерно распределены в течение суток. Обязательно укажите максимальное количество показов в сутки (`maxImpressionsPerDay`). - `2` — равномерное распределение общего ограничения. Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Обязательно укажите максимальное количество показов (`maxImpressions`) и дату окончания (`dateEnd`) для рекламной кампании. - `3` — равномерное распределение общих ограничений (автоматическое продление). Система распределит показы кампании равномерно на весь период, используя статистические данные по аккаунту. Если на момент завершения кампании по дате окончания еще остались невыполненные показы, то кампания автоматически продлевается на 1 день и откручивается в этот день с максимальной скоростью. Обязательно укажите максимальное количество показов (`maxImpressions`) и дату окончания (`dateEnd`) для рекламной кампании. ### {#impressionsMethodID} [Методика подсчета показов](https://yandex.ru/support/adfox-sites/campaigns/impressions-method.html?lang=ru). Допустимые значения: - `0` — загрузка баннера. Показ будет засчитан в момент выгрузки кода баннера на страницу сайта. - `101≤N≤130`, где `N` — порядковый номер события с 1 по 30 (для события номер 1 нужно передать число 101, для события номер 5 — число 105). Показ будет засчитан в тот момент, когда со страницы сайта от баннера придет вызов события с указанным номером. - `1101` — видимый показ, Яндекс (IMS). Показ засчитывается только в случае, если минимум 50% площади баннера находится в активном окне браузера не менее двух секунд. - `2101` — показ (IMS). Событие показа, наступающее в момент начала отрисовки (рендеринга) объявлений. - `2102` — видимый показ (IMS). Показы объявлений в видимой области окна в активной вкладке браузера, которые учитываются по критериям, установленным международными стандартами медиаиндустрии: минимальный процент пикселей, находящихся в видимой области, и длительность нахождения в видимой области браузера. ### {#isEnabled} Включить логическое таргетирование. Допустимые значения: - `0` — выключено, параметр `blocks` является необязательным; - `1` — включено, параметр `blocks` является обязательным. ### {#isIms} Допустимые значения: - `0` — шаблон не содержит IMS событий. Подходит для создания баннеров в кампаниях с методиками посчета показов, отличными от IMS. - `1` — шаблон поддерживает IMS события. Подходит для создания баннеров в кампаниях с IMS-методиками учета показов. ### {#isRr} Является распространителем рекламы. Допустимые значения: - `0` — не является распространителем рекламы; - `1` — является распространителем рекламы. ### {#isRedefined} Переопределить таргетирование. Допустимые значения: - `0` — наследовать настройки таргетирования, установленные на уровне выше. Иерархия уровней от верхнего к нижнему: - кампания; - размещение кампании на сайте; - размещение кампании на разделе сайта; - размещение кампании на площадке; - баннер. - `1` — отменить настройки таргетирования на более высоких уровнях и использовать настройки, установленные на текущем уровне. ### {#isOrs} Является оператором рекламной системы. Допустимые значения: - `0` — не является оператором рекламной системы; - `1` — является оператором рекламной системы. ### {#isEvents} Получить ссылки на события. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#isCreateOwnCampaigns} Настройка прав доступа. Возможность создавать собственные кампании. Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `0`. ### {#isAdvertisers} Настройка прав доступа. Возможность создавать собственных рекламодателей. Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `0`. ### {#isAutoReferer} Динамическое определение раздела сайта по referer. Каждый запрос за баннером содержит информацию об адресе страницы (referer), откуда идет запрос. Включение данной опции позволяет использовать [код вставки, полученный с уровня сайта](../v.1/placement/placement-info-website.md). При этом система будет автоматически определять, к какому разделу сайта относится запрос, на основании поля referer запроса. При выключении данной опции необходимо использовать [коды вставки с уровня площадки](../v.1/placement/placement-info-place.md). Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `1`. ### {#isModifyAllCampaigns} Настройка прав доступа. Управление всеми кампаниями. Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `0`. ### {#isModifyOwnCampaigns} Настройка прав доступа. Управление приписанными к ассистенту рекламными кампаниями. Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `0`. Включается автоматически, если: - `isCreateOwnCampaigns`=`1` — разрешено создание собственных кампаний; - `isModifyAllCampaigns`=`1` — разрешено управление всеми кампаниями. ### {#isOn} Включить/выключить объект. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#intermediaryContractID} ID родительского договора. Передается, только если `type`=`2`. ### {#isRsyaEnabled} Включить или выключить блок. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#isViewAllCampaigns} Настройка прав доступа. Просмотр всех кампаний. Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `0`. Включается автоматически, если `isModifyAllCampaigns`=`1` (разрешено управление всеми кампаниями). ### {#isViewOwnCampaigns} Настройка прав доступа. Просмотр приписанных к ассистенту кампаний. Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `0`. Включается автоматически, если: - `isModifyAllCampaigns`=`1` — разрешено управление всеми кампаниями; - `isCreateOwnCampaigns`=`1` — разрешено создание собственных кампаний; - `isModifyOwnCampaigns`=`1` — разрешено управление приписанными к ассистенту кампаниями. ### {#isWebsite} Настройка прав доступа. Управление всеми сайтами. Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `0`. ### {#isCommonReports} Настройка прав доступа. Доступ к общим отчетам. Допустимые значения: - `0` — выключено; - `1` — включено. Значение по умолчанию: `0`. ### {#id} ID объекта. ### {#id-user} ID пользователя. ### {#inn} ИНН контрагента. ### {#imageURL} Ссылка на изображение графических баннеров, заглушку flash-баннеров. ### {#isUnplaced} Отключить размещение баннера на площадках, созданных после добавления баннера. Допустимые значения: - `0` — выключено; - `1` — включено. Функционал зависит от подключенного в аккаунте модуля «Отключение размещения баннеров». Если модуль подключен, значение по умолчанию — `1`. ### {#impressionCode} В зависимости от типа баннера: HTML-код, XML-код или JavaScript. ### {#isSession} [Сессионные показы](https://yandex.ru/support/adfox-sites/campaigns/session.html?lang=ru). Допустимые значения: - `0` — выключено; - `1` — включено. ### {#kind_id} Определяет [вид кампании](https://yandex.ru/support/adfox-sites/campaigns/rotation-method.html?lang=ru#rotation-method__kind). Допустимые значения: - `1` — вид **Гарантия**, используется для кампаний с гарантированными продажами, по которым есть обязательства по открутке. Включает зависимость двух параметров: - `level` может принимать значения только в диапазоне от 1 до 10. Если `level` не передан, будет установлено значение по умолчанию — `1`. - `cpm` не требуется. Если параметр был передан, то его значение игнорируется. - `2` — вид **Динамическая монетизация**, дает возможность издателю получать наибольший доход от показа, разрешая Рекламной сети Яндекса конкурировать за показы негарантированных рекламных кампаний. Приоритезация кампаний происходит по CPM. Включает зависимость двух параметров: - `level` должен быть равен `11`. Если `level` не передан, будет установлено значение по умолчанию — `11`. - `cpm` обязателен и должен быть больше `0`. Если рекламная кампания создана с внешним монетизатором, то изменять **Вид кампании** нельзя. Он должен быть равен значению `2`. - `3` — вид **Промо**, используется для кампаний собственного промоутирования, заглушек. Включает зависимость двух параметров: - `level` может принимать значения только в диапазоне от 12 до 20. Если `level` не передан, будет установлено значение по умолчанию — `12`. - `cpm` не требуется. Если параметр был передан, то его значение игнорируется. Значение по умолчанию: `1`. ### {#keywords} Укажите ключевую фразу или слова, на которые будет старгетирован объект. Одновременно таргетировать и на фразы, и на слова нельзя. Формат записи: - разделитель фраз — запятая; - разделитель слов — пробел или запятая. Может содержать русские и латинские буквы, цифры и любые символы. ### {#keywordsLogic} Способ таргетирования. Допустимые значения: - `0` — по словам; - `1` — по фразам. Значение по умолчанию: `0`. ### {#keywordsNotAllowed} Ключевая фраза или слова, которые не должны присутствовать в запросе за баннером, чтобы баннер был показан. Формат записи: - разделитель фраз — запятая; - разделитель слов — пробел или запятая. Может содержать русские и латинские буквы, цифры и любые символы. ### {#listCampaignIDs} Вывести результат только для указанных кампаний. Список ID кампаний через запятую. Читайте также: - [Получить список кампаний/флайтов](../v.1/account/account-list-campaign.md) ### {#lastName} Фамилия пользователя. ### {#level} [Уровень](https://yandex.ru/support/adfox-sites/campaigns/rotation-method.html?lang=ru#rotation-method__rotation) кампании. В зависимости от подключения в аккаунте модуля [Виды кампаний](https://yandex.ru/support/adfox-sites/campaigns/rotation-method.html?lang=ru#rotation-method__kind), будет доступно разное количество уровней для рекламных кампаний. Допустимые значения, если модуль **Виды кампаний** выключен: от 1 до 10 включительно. Значение по умолчанию: `1`. Допустимые значения, если модуль **Виды кампаний** включен: - с `1` по `10` включительно — для кампаний вида **Гарантия** (`kind_id`=`1`). - `11` — для кампаний вида **Динамическая монетизация** (`kind_id`=`2`). - с `12` по `20` — для кампаний вида **Промо** (`kind_id`=`3`). Обратите внимание на зависимость значений параметров `kind_id` и `cpm`. ### {#logicType} Вид кампании. Для кампании внутри суперкампании не требуется. Допустимые значения: - `0` — коммерческая; - `1` — [промерочная](https://yandex.ru/support/adfox-sites/campaigns/promerochnyye.html?lang=ru). ### {#markingAdvertiserInfo} Информация о рекламодателе в рекламном меню баннера. Отображается, если на баннере включена опция **Показывать рекламное меню**. По умолчанию — пустая строка. ### {#markingDescription} Описание креатива. ### {#markingKktu} Код справочника ККТУ. Обязательный параметр, если включена маркировка. Если в параметре `markingKktu` указано значение `30.15.1`, то параметр `markingCommonDescription` становится обязательным. Список кодов можно получить с помощью метода [bannerKktu](../v.1/account/account-list-bannerKktu.md). ### {#markingCommonDescription} Общее описание объекта рекламирования. Обязательный параметр, если в параметре `markingKktu` указано значение `30.15.1`. ### {#markingSendRegionsType} Регион показа рекламы. Допустимые значения: - `none` — значение **Не передавать**. Информация о регионах показа не будет передаваться в ЕРИР. - `all` — значение **Вся Россия**. Баннер показывается на всей территории России. - `selected` — значение **Указать регионы вручную**. При передаче `selected` обязательно укажите ID выбранных регионов в параметре `markingSelectedRegions`. ### {#markingSelectedRegions} ID региона показа рекламы. Обязательный параметр, если в параметре `markingSendRegionsType` выбрано значение `selected`. Если нужно задать несколько регионов, добавьте несколько `markingSendRegionsType` в параметрах запроса. {% cut "Пример" %} Для регионов показа рекламы с кодами `9`, `21` и `63`: ``` &markingSendRegionsType=9&markingSendRegionsType=21&markingSendRegionsType=63 ``` {% endcut %} Список регионов можно получить с помощью метода [erirRegions](../v.1/account/account-list-erirRegions.md). ### {#mediaData} Массив с медиаданными креативов. Поле обязательно для заполнения, если не были указаны параметры `textData` и `sendToErir`. URL-ссылка проверяется на доступность перед сохранением. Поле `description` необязательно для заполнения. {% cut "Пример" %} ``` mediaData[]={"url": "https://avatars.mds.yandex.net/get-adfox-content/2462621/221121_adfox_2033661_5594482.379ba05374bcd6b6339273f47b5a1b64.jpeg/optimize.webp", "description": "Text_string"} ``` {% endcut %} Действия с массивом: - Добавление элемента: передайте все предыдущие элементы и все новые элементы. - Удаление элемента: передайте все элементы, кроме удаляемого. - Полная очистка массива: передайте массив с пустым значением, например `mediaData[]=`. ### {#maxUniqueImpressions} Частота контакта пользователя с рекламной кампанией за все время. Максимальное количество показов баннеров одному пользователю. Допустимые значения: целое число от `1` до `2147483647`. Должен быть не меньше `minUniqueImpressions`. ### {#maxImpressions} Максимальное количество показов баннера. Допустимые значения: целое число от `1` до `2147483647`. ### {#maxImpressionsPerDay} Максимальное количество показов в сутки. Допустимые значения: целое число от `1` до `2147483647`. ### {#maxImpressionsPerHour} Максимальное количество показов в час. Допустимые значения: целое число от `1` до `2147483647`. ### {#maxClicks} Максимальное количество кликов всего. Допустимые значения: целое число от `1` до `2147483647`. ### {#maxUniqueClicks} Частота контакта пользователя с рекламной кампанией за все время. Максимальное количество переходов для посетителя, после совершения которых ограничивается показ рекламного объявления. Допустимые значения: целое число от `1` до `2147483647`. ### {#maxClicksPerDay} Максимальное количество кликов в сутки. Допустимые значения: целое число от `1` до `2147483647`. ### {#maxClicksPerHour} Максимальное количество кликов в час. Допустимые значения: целое число от `1` до `2147483647`. ### {#minCtr} Минимальное допустимое значение CTR в процентах. Допустимые значения: от 0 до 100. Значение по умолчанию: `0`. ### {#minVtr} Минимальный VTR для стратегии `min_vtr`. Целое число от 1 до 100%. ### {#minimalPeriodClicks} Частота контакта пользователя с рекламной кампанией за все время. Минимальный период между переходами (часы:минуты:секунды). Формат передачи времени с секундами: `HH:mm:ss`. ### {#minimalPeriodImpressions} Частота контакта пользователя с рекламной кампанией за все время. Минимальный период между показами баннеров уникальному пользователю (часы:минуты:секунды). Формат передачи времени с секундами: `HH:mm:ss`. ### {#mode-target} Режим таргетирования: по дням недели или по дням месяца. Допустимые значения: - `0` — по дням недели; - `1` — по дням месяца. Значение по умолчанию: `0`. ### {#mode-banner} Режим для вставки баннера по умолчанию. Допустимые значения: - `0` — файл (только для стандартных и безразмерных типов баннеров); - `1` — код. Значение по умолчанию: `0`. ### {#mobilePhone} Номер телефона контрагента. Указывается в формате `+[кодстраны]{номертелефона}`. В номере телефона можно указать только цифры (от 1 до 50 цифр) без пробелов, тире и других знаков. ### {#name} Название объекта. Может содержать русские и латинские буквы, цифры и любые символы. ### {#name-campaign} Название новой рекламной кампании (флайта). Может содержать русские и латинские буквы, цифры и любые символы. ### {#name-partner} Название контрагента. Может содержать только русские буквы, пробел и тире (не более одного пробела и/или тире между словами). Тире нельзя использовать в начале и в конце предложения. ### {#newBlockName} Название блока. ### {#newBlockPageId} Идентификатор площадки РСЯ, на которой нужно создать блок. ### {#newBlockType} Тип блока. Укажите в зависимости от типа инвентаря, на котором создаете блок: - Для рекламы на сайте: - `BANNER`; - `FULLSCREEN_DESKTOP`; - `FULLSCREEN_MOBILE`; - `FLOORAD_DESKTOP`; - `FLOORAD_MOBILE`; - `TOPAD`. - Для мобильных приложений: - `BANNER`; - `INTERSTITIAL`; - `NATIVE`; - `REWARDED`; - `APP_OPEN`; - `FEED`. - Для видеоплощадок: - `PRE`; - `MID`; - `POST`; - `PAUSE`; - `INROLL`; - `POSTPAUSE`. ### {#number} Номер договора/дополнительного соглашения. В начале и в конце строки не должно быть пробелов и символов перевода строки. ### {#nonRepeatingPlaces} Получить указанное количество кодов вставки для неповторяющихся площадок. Допустимые значения: от `1` до `20`. Значение по умолчанию: `1`. ### {#objectID} ID объекта, над которым производится действие. ### {#objectID-add} ID кампании, к которой нужно добавить дополнительного пользователя. ### {#objectID-delete} ID кампании, в которой нужно удалить дополнительного пользователя. ### {#objectID-block-bind} Идентификатор площадки, к которой нужно привязать блок РСЯ. ### {#objectID-block-create} Идентификатор площадки, где нужно создать и привязать блок РСЯ. ### {#objectID-block-delete} Идентификатор площадки, где нужно удалить и заархивировать блок РСЯ. ### {#objectID-block-enable} Идентификатор площадки, на которой нужно поменять состояние блока. ### {#objectID-super-add} ID суперкампании, к которой нужно добавить дополнительного пользователя. ### {#objectID-super-delete} ID суперкампании, в которой нужно удалить дополнительного пользователя. ### {#objectID-user} ID значения характеристики. Читайте также: - [Получить список значений](../v.1/userCriteria/userCriteria-listValues.md) ### {#objectID-campaign} ID кампании. Читайте также: - [Получить список кампаний](../v.1/account/account-list-campaign.md) ### {#optimizationMode} Оптимизация показа баннеров, которая автоматически перераспределяет показы между баннерами внутри одной кампании в зависимости от фактической эффективности. Допустимые значения: - `none` — не использовать оптимизацию. - `ctr` — оптимизировать показы по CTR. Подробнее см. в статье [Добавление кампании](https://yandex.ru/support/adfox/ru/campaigns/add-new#step-3) справки Adfox. Значение по умолчанию: `none`. ### {#ownerID} ID аккаунта. ### {#parametersDivider} Разделитель параметров запроса, не используется в кодах вставки с загрузчиком. Допустимые значения: - `0` — &\; - `1` — &. Значение по умолчанию: `0`. ### {#placeID} ID площадки. Читайте также: - [Получить список площадок](../v.1/account/account-list-place.md) ### {#previewCode} Только для XML-баннеров. Укажите HTML-код, который покажет XML-баннер в окне предварительного просмотра баннера. ### {#priority} [Приоритет](https://yandex.ru/support/adfox-sites/campaigns/rotation-method.html#rotation-method__rotation). Допустимые значения: `1≤N≤1000`, где `N` — от 1 до 1000 включительно. ### {#phone} Телефон. ### {#platformName} Название площадки. Параметр для маркировки рекламы. Обязателен, если `sendToErir`=`1`. ### {#placeName} Название площадки. ### {#platformType} Тип площадки. Параметр для маркировки рекламы. Обязателен, если `sendToErir`=`1`. Допустимые значения: - `0` — приложение; - `1` — сайт; - `2` — информационная система (не используется, deprecated); - `3` — Smart TV; - `4` — HbbTV. Если `platformType`=`0` или `platformType`=`1`, поле `url` обязательно для заполнения. ### {#positionID} ID расположения площадки. Читайте также: - [Создать расположение](../v.1/account/account-add-position.md) - [Посмотреть список расположений](../v.1/account/account-list-position.md) ### {#presentationTypeName} Название типа представления для типа баннера. ### {#presentationTypeID} ID типа представления — определяет способ выгрузки кода баннера на сайт. Допустимые значения: - `0` — стандартный. Код баннера будет выгружен как HTML-код в iframe с заданными размерами. - `4` — безразмерный. Код баннера будет выгружен как JavaScript-код. - `5` — XML. Код баннера будет выгружен как XML-код. ### {#publisherContractID} ID конечного договора. Обязательный параметр, если в `contractID` указан первичный договор. ### {#pop} Ограничение по частоте показов на уровне площадки. Другой период (минуты) — собственный период действия ограничения показов в минутах. Допустимые значения: целое число больше `1`. Значение по умолчанию: `1`. Обязателен, если `plp`=`5` (**Период частоты показов**=`другой`). Если `plp`=`-1` или `plp`=`0` (параметр **Период частоты показов** передается со значением `из URL запроса` или `без ограничений`), то параметр `pop` должен отсутствовать в запросе или передаваться с пустым значением. ### {#pli} Ограничение по частоте показов на уровне площадки. Количество показов за период, которое определяет, сколько показов баннеров на этой площадке будет совершено для уникального пользователя. Допустимые значения: целое число больше `1`. Если `plp`=`-1` или `plp`=`0` (параметр **Период частоты показов** передается со значением `из URL запроса` или `без ограничений`), то параметр `pli` должен отсутствовать в запросе или передаваться с пустым значением. ### {#plp} Ограничение по частоте показов на уровне площадки. Период частоты показов. Допустимые значения: - `-1` — из URL запроса (по умолчанию). Настройки ограничения показов будут использоваться из параметров URL запроса за баннером. Если в запросе значения не были переданы, то считается, что площадка без ограничений. Параметры `pli` (количество показов за период) и `pop` (другой период) должны быть пустыми или отсутствовать в запросе. - `0` — без ограничений. Показы баннеров на данной площадке не ограничиваются, даже если в параметрах запроса указано иное. Параметры `pli` (количество показов за период) и `pop` (другой период) должны быть пустыми или отсутствовать в запросе. - `1` — 1 час. Ограничение действует 1 час с момента первого показа баннера уникальному пользователю. - `2` — 6 часов. Ограничение действует 6 часов с момента первого показа баннера уникальному пользователю. - `3` — 12 часов. Ограничение действует 12 часов с момента первого показа баннера уникальному пользователю. - `4` — 24 часа. Ограничение действует 24 часа с момента первого показа баннера уникальному пользователю. - `5` — другой. Собственный период действия ограничения показов в минутах. Параметр `pop` (другой период) является обязательным. ### {#pct} Настройка, разрешающая показы определенных типов рекламных кампаний на данной площадке. Допустимые значения: - `0` — из URL запроса (по умолчанию). Тип кода определяется значением параметра, полученного из URL запроса за баннером. Если в запросе значение не было передано, по умолчанию площадка считается с типом кода обычный. - `1` — обычный. Разрешены к показу баннеры из всех рекламных кампаний, кроме кампаний с типом **сессионные на странице**. - `2` — неповторяющиеся. На странице сайта устанавливается несколько кодов вставки для данной площадки, по запросам которых будет подобрано для показа несколько разных баннеров, кроме кампаний с типом **сессионные на странице**. - `3` — сессионный на странице. Разрешены к показу баннеры из рекламных кампаний, отмеченных как **сессионные на странице** (имеют приоритет перед обычными кампаниями), если сессионных кампаний для показа нет, будет выбрана для показа обычная рекламная кампания. - `4` — неповторяющиеся кампании. На странице сайта устанавливается несколько кодов вставки для данной площадки, по запросам которых будет подобрано по одному баннеру из одной рекламной кампании, кроме кампаний с типом **сессионные на странице**. ### {#requiredParam} Обязательный параметр. ### {#regions} Укажите статус таргетирования для регионов. Формат записи: `{"225":2,"3":0}`, где: `{"ID региона":значение,"ID региона":значение}`. Допустимые значения: - `0` — сброшено — наследуется от элемента-родителя; - `1` — разрешено; - `2` — запрещено. Например, запись `regions={"225":1}` разрешает показы в России. Настройку для пункта **Весь мир** можно также задать и через параметр `regions` с ID=`10000`. Эта настройка будет приоритетнее, чем значение, переданное в параметре `global`. ### {#rotationMethodID} [Метод ротации кампании](https://yandex.ru/support/adfox-sites/campaigns/rotation-method.html?lang=ru). Допустимые значения: - `0` — по приоритетности: использовать значения параметров `level` и `priority` для оценки вероятности показа рекламной кампании; - `1` — по проценту от трафика: использовать значение параметра `trafficPercents` для оценки вероятности показа рекламной кампании. Параметр `trafficPercents` обязателен. Значение по умолчанию: `0`. ### {#rotationMethodID-1} [Метод ротации кампании](https://yandex.ru/support/adfox-sites/campaigns/rotation-method.html?lang=ru). Допустимые значения: - `−1` — не переопределен (значение наследуется от уровня выше); - `0` — по приоритетности: использовать значения параметров `level` и `priority` для оценки вероятности показа рекламной кампании; - `1` — по проценту от трафика: использовать значение параметра `trafficPercents` для оценки вероятности показа рекламной кампании. Значение по умолчанию: `-1`. ### {#row0} Элемент списка с соответствующим номером. ### {#revenue} Включить таргетирование по доходу. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#revenueValues} Выбрать значение дохода. Параметр **обязателен**, если `revenue`=`1`. Допустимые значения: - `1` — ниже среднего; - `2` — средний; - `3` — выше среднего. Для передачи нескольких значений используйте разделитель — вертикальную черту `|` без пробелов. ### {#rows} Количество элементов в дереве ответа. ### {#rowN} Порядковый номер элемента в дереве ответа, где `N` — число от 0 до `rows-1` (где `rows` — общее количество элементов в ответе). ### {#regNumber} Регистрационный номер. ### {#roles} Роли, в которых может выступать контрагент при заключении договора. Допустимые значения: - `0` — исполнитель; - `1` — заказчик. Значение по умолчанию: `roles[]=0&roles[]=1` — роль «Заказчик и Исполнитель». ### {#referrer} Шаблон URL для сравнения с адресом страницы сайта, который получен из запроса. Если адрес не подходит под шаблон URL, загрузка точки не будет засчитана. {% cut "Пример" %} - Для стандартного типа шаблонов: ```css ٭site.ru/index.php ``` - Для POSIX.2: ```css homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$ ``` {% endcut %} Может содержать русские и латинские буквы, цифры и любые символы. ### {#rsyaBlockID} ID блока, например: `R-A-19385233-3`. ### {#rsyaEnabled} Состояние блока, который привязан к площадке. Допустимые значения: - `0` — отключен; - `1` — включен. ### {#rsUrl} URL рекламной системы или другая информация. ### {#state} Регион. ### {#showMenu} Показывать меню на баннере. Допустимые значения: - `0` — не показывать меню; - `1` — показывать меню. ### {#sendToErir} Передавать данные в ЕРИР. Допустимые значения: - `0` — не передавать данные в ЕРИР; - `1` — передавать данные в ЕРИР (маркировка включена). ### {#sendToErir-1} Передавать данные в ЕРИР. Допустимые значения: - `0` — не передавать данные в ЕРИР. Остальные поля для маркировки рекламы игнорируются. - `1` — передавать данные в ЕРИР (маркировка включена). В этом случае обязательны для заполнения поля `platformName` и`platformType`. ### {#superCampaignID} ID суперкампании, если кампания добавляется к суперкампании. Читайте также: - [Создать суперкампанию](../v.1/account/account-add-superCampaign.md) - [Получить список суперкампаний](../v.1/account/account-list-superCampaign.md) ### {#search} Фильтрация по подстроке в имени кампании/флайта. Может содержать русские и латинские буквы, цифры и любые символы. ### {#sendToErirParameterN} Включение/отключение для определенной переменной передачи значения параметра (креатива) в ЕРИР, где `` — название переменной. Если вы передаете предопределенные переменные, используйте следующие названия параметров: - `sendToErirImageURL` — для переменной **Изображение**; - `sendToErirGetFLV` — для переменной **FLV-ролик**. Чтобы включить пользовательские переменные (user1-user25), используйте ``, где `N` — значение от 1 до 25. Например, `sendToErirParameter2` — для дополнительной переменной **user2**. Допустимые значения: - `0` — отключить передачу данных в ЕРИР для переменной; - `1` — включить передачу данных в ЕРИР для переменной. Значение по умолчанию: `0`. Поле обязательно для заполнения, если **не** были указаны параметры `mediaData` и `textData`. {% cut "Ошибка `Incorrect value (-6)`" %} Не включена опция передачи параметров на шаблоне (в столбце **Маркировка** выбрана опция **Не использовать в маркировке**) — параметр передать не получится (ошибка `Incorrect value (-6)`). Чтобы управлять передачей данных при создании баннера, перейдите в интерфейс Adfox и включите опцию в шаблоне. {% endcut %} ### {#sendToErir3} Тип файла, загруженного в переменную с включенной передачей в ЕРИР. Список допустимых значений: * `image` * `video` * `audio` * `zip` При выборе `image` параметр с описанием объекта креатива `sendToErirDescription` становится обязательным. ### {#sendToErirDescription} Описание объекта креатива для той переменной, в которую загружен файл. Обязательный параметр, если в параметре `sendToErirContentType` указано значение `image`. ### {#subjectType} Сведения о предмете договора. Допустимые значения: - `0` — Иное. - `1` — Договор на распространение рекламы. - `2` — Договор на организацию распространения рекламы. - `3` — Посредничество. - `4` — Представительство. Значение по умолчанию: `0`. Чтобы значение перешло в состояние «Не задано», можно передать null или пустое значение `''`. При редактировании перевести в состояние «Не задано» можно так: `subjectType=&`. ### {#sectionName} Название раздела сайта. ### {#siteName} Название сайта в управлении. ### {#siteID} ID сайта. ### {#siteID-1} ID сайта, в котором находится площадка. ### {#status} Статус объекта. Могут быть показаны только объекты, находящиеся в статусе **активный**. Допустимые значения: - `0` — активный. Объект готов к началу открутки. - `1` — приостановленный. Предполагается, что объект временно отключен. По умолчанию фильтры в веб-интерфейсе Adfox показывают приостановленные объекты в списке. - `2` — завершенный. Предполагается, что объект завершил свою открутку. По умолчанию фильтры в веб-интерфейсе Adfox скрывают завершенные объекты. ### {#status-short} Статус. Допустимые значения: - `0` — активный; - `1` — приостановленный; - `2` — завершенный. ### {#sectionID} ID раздела сайта. ### {#sectorID} [Отрасль](https://yandex.ru/support/adfox-sites/campaigns/add-campaign.html?lang=ru). Как получить список отраслей, читайте в разделе [utility-sector](../v.1/account/account-utility-sector.md). ### {#show} Настройка полноты данных в списке кампаний/флайтов. Допустимые значения: - `common` — краткий вывод: - `ID` - `name` - `short` — сокращенный вывод: - `ID` - `bannerTypeID` - `templateID` - `campaignID` - `status` - `dateStart` - `dateEnd` - `advanced` — полный вывод. Значение по умолчанию: `advanced`. ### {#socialType} Вид договора. Допустимые значения: - `0` — Коммерческий. - `1` — Договор социальной рекламы с оплатой. - `2` — Договор социальной рекламы по квоте. ### {#synchronousFactor} Вид кода. Допустимые значения: - `1` — асинхронный; - `2` — асинхронный с проверкой скролла; - `3` — адаптивный. Значение по умолчанию: `1`. ### {#targetingUrlOn} URL страницы, на которой разрешен показ. Если URL несколько, то каждый URL надо передавать в отдельном параметре. Максимальное количество параметров с URL — 5. {% cut "Пример" %} ```css targetingUrlOn[]=url1&targetingUrlOn[]=url2... ``` {% endcut %} ### {#targetingUrlOff} URL страницы, на которой запрещен показ. Если URL несколько, то каждый URL надо передавать в отдельном параметре. Максимальное количество параметров с URL — 5. {% cut "Пример" %} ```css targetingUrlOff[]=url1&targetingUrlOff[]=url2... ``` {% endcut %} ### {#template} Укажите шаблоны страниц, по которым будет производиться сравнение полученного адреса в запросе за баннером. {% cut "Пример" %} - Для стандартного типа шаблонов: ```css ٭site.ru/index.php ``` - Для POSIX.2: ```css homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$ ``` {% endcut %} Может содержать русские и латинские буквы, цифры и любые символы. ### {#templateName} Название шаблона баннера. ### {#templateExcluded} Шаблоны страниц, которые не должны относиться к данному разделу сайта. {% cut "Пример" %} - Для стандартного типа шаблонов: ```css http://٭site.ru ``` Под такой шаблон попадут адреса: `http://site.ru`, `http://example.site.ru`. - Для POSIX.2: ```css homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$ ``` Под такой шаблон попадут адреса: - `homer-simpson-tv.blog4ever.com` - `http://homer-simpson-tv.blog4ever.com/?a=1212` - `forum.rojadirecta.org` - `https://www.forum.rojadirecta.org/?b=123` - `hidan.eklablog.com/?b=123` - `aniworld.spb.ru/123/adfox/s` {% endcut %} Может содержать русские и латинские буквы, цифры и любые символы. ### {#templateID} ID шаблона баннера. Шаблон представляет собой код баннера с переменными и определяет внешний вид и функциональные возможности баннера на сайте. Обратите внимание: если рекламная кампания (`campaignID`), в которую добавляется баннер, создана с методикой учета показов (`impressionsMethodID`=`2101` или `2102`), то шаблон должен иметь признак `is_Ims`=`1`. Наличие признака у шаблона можно проверить, получив параметры шаблона ([account-list-template](../v.1/account/account-list-template.md)) или список шаблонов в типе баннера ([bannerType-list-template](../v.1/bannerType/bannerType-list-template.md)). Как посмотреть список ID шаблонов, читайте в разделе [list-template](../v.1/bannerType/bannerType-list-template.md). ### {#templateType} Тип шаблона для таргетирования по URL. Допустимые значения: - `0` — стандартный. В шаблоне URL используйте символ `*` для обозначения последовательности любых символов любой длины. - `1` — POSIX. В шаблоне URL используйте регулярные выражения по стандарту POSIX. Значение по умолчанию: `0`. ### {#templateTypeID} Тип шаблонов страниц. Подробнее о типах шаблонов читайте в статье [Шаблоны referer](https://yandex.ru/support/adfox-sites/codes/referrer-templates.html?lang=ru). Допустимые значения: - `0` — стандартный; - `1` — POSIX.2. ### {#targetingProfileID} ID [профиля таргетирования](https://yandex.ru/support/adfox-sites/settings/profiles.html?lang=ru). Профиль таргетирования позволяет объединить настройки нескольких видов таргетирования. При создании кампании или баннера можно указывать профиль, чтобы не тратить время на настройку каждого таргетирования в отдельности. Как посмотреть список ID профилей, читайте в разделе [list-targetingProfile](../v.1/account/account-list-targetingProfile.md). ### {#target} Значение параметра `target` для ссылки определяет, в каком окне открыть ссылку. Допустимые значения: - `_blank` — открыть страницу в новом окне браузера; - `_parent` — открыть страницу в текущем окне; - `_top` — открыть страницу в полном окне браузера. ### {#timeout} Активность категории в днях. Значение по умолчанию: `не задано`. ### {#timeoutN} Укажите, сколько дней назад пользователь должен быть размечен в последний раз, где `N` в названии параметра — номер условия от 1 до 9. Допустимые значения: целое число от `1` до `2147483647`. ### {#title} Название таргетирования. ### {#targetParameterName} Название параметра, который используется для передачи значения `target` во flash-ролик. При разработке flash-ролика в коде, который отвечает за обработку клика, используется параметр, ожидающий на вход значение `target`. Ссылка для перехода и название параметра для передачи значения `target` в ролик указываются при добавлении баннера в Adfox. Название параметра в баннере и во flash-ролике должно совпадать. ### {#targetURL} Целевые ссылки. Допустимо указывать несколько ссылок в поле через разделитель `\n`, в URL он кодируется как `%0A`. Каждая ссылка должна начинаться с протокола. Длина одной ссылки не может превышать 2000 символов. {% cut "Пример" %} `targetURL=http://site1.ru%0Ahttp://site2.ru` Или же можно передавать с помощью изменения названия переменной: `&targetURL[]=http://site1.ru` `&targetURL[]=http://site2.ru` {% endcut %} ### {#textData} Массив с текстовыми данными креативов. Поле обязательно для заполнения, если не были указаны параметры `mediaData` и `sendToErir`. Действия с массивом: - Добавление элемента: передайте все предыдущие элементы и все новые элементы. - Удаление элемента: передайте все элементы, кроме удаляемого. - Полная очистка массива: передайте массив с пустым значением, например `textData[]=`. ### {#trackingURL} Ссылка на промерочный пиксель. В ссылке на пиксель обычно присутствует переменная, ожидающая на вход случайное число. Это число помогает защитить ссылку от кеширования в браузере. В Adfox существует макрос для подстановки случайного числа к переменной — `%random%`. {% cut "Пример" %} Подставим макрос к параметру для подстановки случайного числа `pr` в ссылках на пиксель Adfox: `http://ads.adfox.ru/166283/getCode?p1=borgd&p2=ezjv&pfb=dwsey&pr=%random%` {% endcut %} ### {#token} Токен баннера, который был получен от стороннего ОРД, в том числе в ОРД Яндекса по API (не через стандартный механизм маркировки в Adfox). Вы можете задать значение параметра `token` только в том случае, если `sendToErir`=`0`. В поле **Токен** можно добавить только значение токена. Не добавляйте другие символы. ### {#trafficPercents} Процент от трафика. Обязателен, если используется метод ротации по проценту от трафика (`rotationMethodID`=`1`). Допустимые значения: от `1` до `100`. ### {#type-category} Тип категории. Допустимые значения: - `0` — постоянная категория. Используется для разметки сайтов, разделов и площадок. - `1` — временная категория. Используется для настройки поведенческого таргетирования. ### {#type-category-short} Тип категории. Допустимые значения: - `0` — постоянная категория; - `1` — временная категория. ### {#type-contract} Тип контракта. Допустимые значения: - `0` — Договор оказания услуг. - `1` — Посреднический договор. Доступны параметры: - `agentActingForPublisher`— функция посредника; - `chargePaidByAgent` — опция «Сбор по этому договору оплачивает посредник, поверенный, комиссионер или агент». - `2` — Дополнительное соглашение. Обязательно заполнить поле `intermediaryContractID`. ### {#type-contragent} Тип контрагента. Допустимые значения: - `0` — Юридическое лицо (РФ). Обязательно указать значение `inn` (10 цифр). - `1` — Физическое лицо (РФ). Обязательно указать значение `inn` (12 цифр). - `2` — Индивидуальный предприниматель (РФ). Обязательно указать значение `inn` (12 цифр). - `3` — Юридическое лицо (Нерезидент). Обязательно заполнить поле `countryOKSM`, а также одно из полей: `mobilePhone` или `epayNumber`. - `4` — Физическое лицо (Нерезидент). Обязательно заполнить поле `countryOKSM`, а также одно из полей: `inn` или `regNumber`. ### {#userN} Пользовательские параметры, где `N` — номер используемого параметра от 1 до 25. В каждом шаблоне определен набор переменных. Получите список используемых переменных шаблона и передайте значения к этим переменным при добавлении или редактировании баннера. {% cut "Пример" %} В шаблоне используются два пользовательских параметра: `user1` и `user3` с типом данных «строка». Значит, при добавлении или редактировании баннера в запросе необходимо передать: `user1=text1&user3=text3`. {% endcut %} ### {#userID} ID, который передается в код вставки. ### {#userID-trackingpoint} Пользовательский ID точки учета действия. ### {#uniquePeriodImpressions} Частота контакта пользователя с рекламной кампанией за выбранный период. Если период частоты показов выбран как `другой период` (`frequencyTypeImpressions`=`8`), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах. Формат передачи времени: `HH:mm`. ### {#uniquePeriodClicks} Частота контакта пользователя с рекламной кампанией за выбранный период. Если период частоты переходов выбран как `другой период` (`frequencyTypeClicks`=`8`), то укажите собственный период. Если в течение периода пользователь произведет по баннеру максимально разрешенное количество кликов, то показы баннера этому пользователю будут ограничены до конца периода. Формат передачи времени: `HH:mm`. ### {#url} Домен сайта или видеоресурса, URL блога или ссылка для скачивания приложения. Параметр для маркировки рекламы. Требования к параметру `url`: - URL начинается с протокола http или https; - путь не должен содержать `punycode` или `urlencode`. Поле `url` обязательно для заполнения, если `platformType`=`0` или `platformType`=`1`. ### {#UTLogic} В таргетировании по поведению рекламодатель сам регулирует условия, при соблюдении которых разрешен показ рекламного объявления. Есть два режима соблюдения условий: «верно любое из заданных условий» и «верны все условия». Можно задать до 9 условий, каждое условие состоит из 4 параметров, где `N` в названии параметра — номер условия от 1 до 9: - размеченные/не размеченные пользователи (`UTNotN`); - если пользователь размечен, то с какой категорией (`categoryIDN`); - сколько раз пользователь был размечен (`visitsN`); - когда пользователь был размечен последний раз (`timeoutN`). Укажите логику соблюдения условий для показа баннеров рекламной кампании пользователям. Допустимые значения: - `0` — верно любое из заданных условий; - `1` — верны все заданные условия. ### {#UTNotN} Выбрать целевую аудиторию: размеченные или не размеченные пользователи, где `N` в названии параметра — номер условия от 1 до 9. Допустимые значения: - `0` — условие не задано; - `1` — размеченные пользователи; - `2` — не размеченные пользователи. Значение по умолчанию: `0`. ### {#UTSVisitsN} Посещений не менее заданного числа раз, где `N` — номер условия. Допустимые значения: целое число от `1` до `2147483647`. ### {#UTSTimeoutN} Последнее посещение было не позднее чем заданное число дней назад, где `N` — номер условия. Допустимые значения: целое число от `1` до `2147483647`. ### {#vN} Где `N` в названии параметра — ID значения характеристики. Допустимые значения: - `0` — выключено; - `1` — включено. ### {#video-resolution} Качество видео. Допустимые значения: - `240p` - `360p` - `480p` - `720p` - `1080p` Значение по умолчанию: `480p`. ### {#visitsN} Укажите, сколько раз пользователь должен быть размечен, где `N` в названии параметра — номер условия от 1 до 9. Допустимые значения: целое число от `1` до `2147483647`. ### {#video-duration} Длительность видео в секундах. Можно задать длительность до тысячных долей секунды, например `11.325`. ### {#width} Ширина баннера. ### {#weight} Вес точки учета действия. Используется для построения отчетов. Например, для посадочной страницы после клика по баннеру вес будет меньше, а для страницы оформления заказа — больше, так как целью рекламной кампании являлось увеличение продаж. Допустимые значения: `0≤N≤100`, где `N` — вес точки учета, который позволяет определить степень ее важности для достижения рекламных целей. ### {#WMZ} Номер кошелька WebMoney. ### {#WMZProtection} Код защиты кошелька WebMoney. ### {#webmasterID} ID [владельца сайта](https://yandex.ru/support/adfox-sites/users/webmaster.html?lang=ru). Владельцу сайта предоставляется доступ только к статистике по сайту. Читайте также: - [Создать владельца сайта](../v.1/account/account-add-webmaster.md) - [Получить список владельцев сайтов](../v.1/account/account-list-webmaster.md) ### {#websiteName} Название сайта. ### {#YandexMoney} Номер кошелька в Яндекс Деньги. ### {#ZIPCode} Почтовый индекс. ### {#zoneID} ID раздела сайта. {% endincluded %} {% included (../../_includes/v.1.md:./shorts.md) %} ### {#account} Учетная запись пользователя. ### {#actionType} Описание действий посредника-представителя. Допустимые значения: - `0` — Иное. - `1` — Действия в целях распространения рекламы. - `2` — Заключение договоров. - `3` — Коммерческое представительство. ### {#actionObjectID-get} Чтобы получить данные только по одному объекту, укажите его ID. ### {#advertiserID} ID рекламодателя. ### {#advertiserID-read} Читайте также: - [Cоздать рекламодателя](../v.1/account/account-add-advertiser.md) - [Получить список рекламодателей](../v.1/account/account-list-advertiser.md) ### {#assistantID} ID [ассистента](https://yandex.ru/support/adfox-sites/users/assistant-api.html?lang=ru), которому будет разрешен доступ к объекту в соответствии с его правами доступа. ### {#assistantID-read} Читайте также: - [Создать ассистента](../v.1/account/account-add-assistant.md) - [Получить список ассистентов](../v.1/account/account-list-assistant.md) ### {#bannerID} ID баннера. ### {#bannername} Название баннера. ### {#bannerTypeID} ID типа баннера. ### {#categoryID} ID категории. ### {#contractID} ID прямого или первичного договора. ### {#criteriaID} ID пользовательской характеристики. ### {#criteriaName} Название пользовательской характеристики. ### {#criteriaTargetingName} Название вкладки для таргетирования по пользовательской характеристике у рекламной кампании и баннера. ### {#criteriaReportName} Название отчета по таргетированию по пользовательской характеристике. ### {#format-datetime} Формат передачи даты и времени: `YYYY-MM-DD HH:mm`. ### {#format-date} Формат передачи даты: `YYYY-MM-DD`. ### {#format-time} Формат передачи времени: `HH:mm`. ### {#format-sec} Формат передачи времени с секундами: `HH:mm:ss`. ### {#dateStart} Дата начала открутки. ### {#dateEnd} Дата окончания открутки. ### {#defaultzero} Значение по умолчанию: `0`. ### {#defaultone} Значение по умолчанию: `1`. ### {#defaulthundred} Значение по умолчанию: `100`. ### {#defaultminusone} Значение по умолчанию: `-1`. ### {#defaultCode} Код баннера по умолчанию. ### {#delete} ID объекта, который нужно удалить. ### {#impressionsSmoothTypeID} - `4` — максимальная в начале открутки кампании. Показы распределяются неравномерно: система планирует больше показов на первые дни размещения, а к завершению кампании уменьшает количество показов. Это снижает риск недовыполнения кампании из-за неожиданного ограничения доступного инвентаря в конце срока. Обязательно укажите максимальное количество показов (`maxImpressions`) и дату окончания (`dateEnd`) для рекламной кампании. ### {#isRegReport} На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы. ### {#markingSelectedRegions} ID региона показа рекламы. ### {#markingCommonDescription} Общее описание объекта рекламирования. ### {#markingSendRegionsType} Регион показа рекламы. ### {#maxImpressionsPerDay} Максимальное количество показов в сутки. ### {#maxImpressionsPerHour} Максимальное количество показов в час. ### {#minUniqueImpressions} Частота контакта пользователя с рекламной кампанией за все время. Минимальное количество показов баннеров одному пользователю. Допустимые значения: целое число от `1` до `2147483647`. Должен быть не больше `maxUniqueImpressions`. ### {#avgUniqueImpressions} Частота контакта пользователя с рекламной кампанией за все время. Целевое среднее количество показов. Средняя частота приоритезирует показы до целевого значения и ограничивает их после — поэтому задается отдельно от минимальной и максимальной. Может быть задан только при отсутствии `minUniqueImpressions` и `maxUniqueImpressions`. ### {#minImpressionsPerPeriod} Частота контакта пользователя с рекламной кампанией за выбранный период. Минимальное количество показов за заданный период. ### {#avgImpressionsPerPeriod} Частота контакта пользователя с рекламной кампанией за выбранный период. Целевое среднее количество показов за заданный период. ### {#maxClicks} Максимальное количество кликов всего. ### {#maxClicksPerDay} Максимальное количество кликов в сутки. ### {#maxClicksPerHour} Максимальное количество кликов в час. ### {#mediaData} Массив с медиаданными креативов. Поле обязательно для заполнения, если не были указаны параметры `textData` и `sendToErir`. URL-ссылка проверяется на доступность перед сохранением. Поле `description` необязательно для заполнения. {% cut "Пример" %} ``` mediaData[]={"url": "https://avatars.mds.yandex.net/get-adfox-content/2462621/221121_adfox_2033661_5594482.379ba05374bcd6b6339273f47b5a1b64.jpeg/optimize.webp", "description": "Text_string"} ``` {% endcut %} ### {#objectID-user} ID значения характеристики. ### {#campaignID} ID кампании. ### {#placeID} ID площадки. ### {#platformType} Допустимые значения: - `0` — приложение; - `1` — сайт; - `2` — информационная система (не используется, deprecated); - `3` — Smart TV; - `4` — HbbTV. ### {#publisherContractID} ID конечного договора. ### {#roles} Роли, в которых может выступать контрагент при заключении договора. Допустимые значения: - `0` — исполнитель; - `1` — заказчик. ### {#sample} {% cut "Пример" %} - Для стандартного типа шаблонов: ```css ٭site.ru/index.php ``` - Для POSIX.2: ```css homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$ ``` {% endcut %} ### {#separator-comma} Для передачи списка ID объектов используйте разделитель — запятую. ### {#separator-line} Для передачи нескольких значений используйте разделитель — вертикальную черту `|` без пробелов. ### {#separator-words} Формат записи: - разделитель фраз — запятая; - разделитель слов — пробел или запятая. ### {#subjectType} Сведения о предмете договора. Допустимые значения: - `0` — Иное. - `1` — Договор на распространение рекламы. - `2` — Договор на организацию распространения рекламы. - `3` — Посредничество. - `4` — Представительство. ### {#templateID} ID шаблона баннера. ### {#targetingProfileID} ID [профиля таргетирования](https://yandex.ru/support/adfox-sites/settings/profiles.html?lang=ru). ### {#textData} Массив с текстовыми данными креативов. Поле обязательно для заполнения, если не были указаны параметры `mediaData` и `sendToErir`. ### {#values} Допустимые значения: целое число от `1` до `2147483647`. ### {#values-on-off} Допустимые значения: - `on` — включить размещение; - `off` — выключить размещение. ### {#values-0-1} Допустимые значения: - `0` — выключено; - `1` — включено. ### {#values-no-yes} Допустимые значения: - `0` — нет; - `1` — да. ### {#values-code} Допустимые значения: - `0` — HTML; - `1` — JavaScript. ### {#frequencyType} Допустимые значения: - `0` — не задано; - `1` — 1 час; - `2` — 4 часа; - `3` — 6 часов; - `4` — 12 часов; - `5` — сутки; - `6` — неделя; - `7` — месяц; - `8` — другой период; - `9` — 14 дней. ### {#values-all-required} Может содержать русские и латинские буквы, цифры и любые символы. ### {#values-users} Может содержать русские и латинские буквы, цифры и любые символы. Если производится включение новой характеристики, то параметр становится обязательным. ### {#video-duration} Длительность видео в секундах. ### {#uniquePeriodImpressions} Если период частоты показов выбран как `другой период` (`frequencyTypeImpressions`=`8`), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах. ### {#url} Домен сайта или видеоресурса, URL блога или ссылка для скачивания приложения. Параметр для маркировки рекламы. {% endincluded %} {% included (../../_includes/shorts.md) %} ### {#account} Учетная запись пользователя. ### {#actionType} Описание действий посредника-представителя. Допустимые значения: - `0` — Иное. - `1` — Действия в целях распространения рекламы. - `2` — Заключение договоров. - `3` — Коммерческое представительство. ### {#actionObjectID-get} Чтобы получить данные только по одному объекту, укажите его ID. ### {#advertiserID} ID рекламодателя. ### {#advertiserID-read} Читайте также: - [Cоздать рекламодателя](../v.1/account/account-add-advertiser.md) - [Получить список рекламодателей](../v.1/account/account-list-advertiser.md) ### {#assistantID} ID [ассистента](https://yandex.ru/support/adfox-sites/users/assistant-api.html?lang=ru), которому будет разрешен доступ к объекту в соответствии с его правами доступа. ### {#assistantID-read} Читайте также: - [Создать ассистента](../v.1/account/account-add-assistant.md) - [Получить список ассистентов](../v.1/account/account-list-assistant.md) ### {#bannerID} ID баннера. ### {#bannername} Название баннера. ### {#bannerTypeID} ID типа баннера. ### {#categoryID} ID категории. ### {#contractID} ID прямого или первичного договора. ### {#criteriaID} ID пользовательской характеристики. ### {#criteriaName} Название пользовательской характеристики. ### {#criteriaTargetingName} Название вкладки для таргетирования по пользовательской характеристике у рекламной кампании и баннера. ### {#criteriaReportName} Название отчета по таргетированию по пользовательской характеристике. ### {#format-datetime} Формат передачи даты и времени: `YYYY-MM-DD HH:mm`. ### {#format-date} Формат передачи даты: `YYYY-MM-DD`. ### {#format-time} Формат передачи времени: `HH:mm`. ### {#format-sec} Формат передачи времени с секундами: `HH:mm:ss`. ### {#dateStart} Дата начала открутки. ### {#dateEnd} Дата окончания открутки. ### {#defaultzero} Значение по умолчанию: `0`. ### {#defaultone} Значение по умолчанию: `1`. ### {#defaulthundred} Значение по умолчанию: `100`. ### {#defaultminusone} Значение по умолчанию: `-1`. ### {#defaultCode} Код баннера по умолчанию. ### {#delete} ID объекта, который нужно удалить. ### {#impressionsSmoothTypeID} - `4` — максимальная в начале открутки кампании. Показы распределяются неравномерно: система планирует больше показов на первые дни размещения, а к завершению кампании уменьшает количество показов. Это снижает риск недовыполнения кампании из-за неожиданного ограничения доступного инвентаря в конце срока. Обязательно укажите максимальное количество показов (`maxImpressions`) и дату окончания (`dateEnd`) для рекламной кампании. ### {#isRegReport} На контрагенте-исполнителе лежит обязанность регистрировать и отправлять креативы. ### {#markingSelectedRegions} ID региона показа рекламы. ### {#markingCommonDescription} Общее описание объекта рекламирования. ### {#markingSendRegionsType} Регион показа рекламы. ### {#maxImpressionsPerDay} Максимальное количество показов в сутки. ### {#maxImpressionsPerHour} Максимальное количество показов в час. ### {#minUniqueImpressions} Частота контакта пользователя с рекламной кампанией за все время. Минимальное количество показов баннеров одному пользователю. Допустимые значения: целое число от `1` до `2147483647`. Должен быть не больше `maxUniqueImpressions`. ### {#avgUniqueImpressions} Частота контакта пользователя с рекламной кампанией за все время. Целевое среднее количество показов. Средняя частота приоритезирует показы до целевого значения и ограничивает их после — поэтому задается отдельно от минимальной и максимальной. Может быть задан только при отсутствии `minUniqueImpressions` и `maxUniqueImpressions`. ### {#minImpressionsPerPeriod} Частота контакта пользователя с рекламной кампанией за выбранный период. Минимальное количество показов за заданный период. ### {#avgImpressionsPerPeriod} Частота контакта пользователя с рекламной кампанией за выбранный период. Целевое среднее количество показов за заданный период. ### {#maxClicks} Максимальное количество кликов всего. ### {#maxClicksPerDay} Максимальное количество кликов в сутки. ### {#maxClicksPerHour} Максимальное количество кликов в час. ### {#mediaData} Массив с медиаданными креативов. Поле обязательно для заполнения, если не были указаны параметры `textData` и `sendToErir`. URL-ссылка проверяется на доступность перед сохранением. Поле `description` необязательно для заполнения. {% cut "Пример" %} ``` mediaData[]={"url": "https://avatars.mds.yandex.net/get-adfox-content/2462621/221121_adfox_2033661_5594482.379ba05374bcd6b6339273f47b5a1b64.jpeg/optimize.webp", "description": "Text_string"} ``` {% endcut %} ### {#objectID-user} ID значения характеристики. ### {#campaignID} ID кампании. ### {#placeID} ID площадки. ### {#platformType} Допустимые значения: - `0` — приложение; - `1` — сайт; - `2` — информационная система (не используется, deprecated); - `3` — Smart TV; - `4` — HbbTV. ### {#publisherContractID} ID конечного договора. ### {#roles} Роли, в которых может выступать контрагент при заключении договора. Допустимые значения: - `0` — исполнитель; - `1` — заказчик. ### {#sample} {% cut "Пример" %} - Для стандартного типа шаблонов: ```css ٭site.ru/index.php ``` - Для POSIX.2: ```css homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$ ``` {% endcut %} ### {#separator-comma} Для передачи списка ID объектов используйте разделитель — запятую. ### {#separator-line} Для передачи нескольких значений используйте разделитель — вертикальную черту `|` без пробелов. ### {#separator-words} Формат записи: - разделитель фраз — запятая; - разделитель слов — пробел или запятая. ### {#subjectType} Сведения о предмете договора. Допустимые значения: - `0` — Иное. - `1` — Договор на распространение рекламы. - `2` — Договор на организацию распространения рекламы. - `3` — Посредничество. - `4` — Представительство. ### {#templateID} ID шаблона баннера. ### {#targetingProfileID} ID [профиля таргетирования](https://yandex.ru/support/adfox-sites/settings/profiles.html?lang=ru). ### {#textData} Массив с текстовыми данными креативов. Поле обязательно для заполнения, если не были указаны параметры `mediaData` и `sendToErir`. ### {#values} Допустимые значения: целое число от `1` до `2147483647`. ### {#values-on-off} Допустимые значения: - `on` — включить размещение; - `off` — выключить размещение. ### {#values-0-1} Допустимые значения: - `0` — выключено; - `1` — включено. ### {#values-no-yes} Допустимые значения: - `0` — нет; - `1` — да. ### {#values-code} Допустимые значения: - `0` — HTML; - `1` — JavaScript. ### {#frequencyType} Допустимые значения: - `0` — не задано; - `1` — 1 час; - `2` — 4 часа; - `3` — 6 часов; - `4` — 12 часов; - `5` — сутки; - `6` — неделя; - `7` — месяц; - `8` — другой период; - `9` — 14 дней. ### {#values-all-required} Может содержать русские и латинские буквы, цифры и любые символы. ### {#values-users} Может содержать русские и латинские буквы, цифры и любые символы. Если производится включение новой характеристики, то параметр становится обязательным. ### {#video-duration} Длительность видео в секундах. ### {#uniquePeriodImpressions} Если период частоты показов выбран как `другой период` (`frequencyTypeImpressions`=`8`), то укажите собственный период для показов баннеров уникальному пользователю в часах и минутах. ### {#url} Домен сайта или видеоресурса, URL блога или ссылка для скачивания приложения. Параметр для маркировки рекламы. {% endincluded %}