add: параметры CpmBannerCampaign

Внимание. Все денежные параметры кампаний (дневной бюджет, недельный бюджет, средняя цена для автоматических стратегий) передаются через API Директа в виде целых чисел. Передаваемое значение представляет собой денежное значение в валюте рекламодателя, умноженное на 1 000 000.

Структура запроса в формате JSON:

{
  "method": "add",
  "params": {
    "Campaigns": [{  /* CampaignAddItem */
      ...
      "CpmBannerCampaign": {  /* CpmBannerCampaignAddItem */
        "BiddingStrategy": {  /* CpmBannerCampaignStrategyAdd */
          "Search": {  /* CpmBannerCampaignSearchStrategyAdd */
            "BiddingStrategyType": ( "SERVING_OFF" ) /* required */
          }, /* required */
          "Network": {  /* CpmBannerCampaignNetworkStrategyAdd */
            "BiddingStrategyType": ( "MANUAL_CPM" | ... | "WB_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS" ), /* required */
            "WbMaximumImpressions": {  /* StrategyWbMaximumImpressionsAdd */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long) /* required */
            },
            "CpMaximumImpressions": {  /* StrategyCpMaximumImpressionsAdd */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long), /* required */
              "StartDate": (string), /* required */
              "EndDate": (string), /* required */
              "AutoContinue": ( "YES" | "NO" ) /* required */
            },
            "WbDecreasedPriceForRepeatedImpressions": {  /* StrategyWbDecreasedPriceForRepeatedImpressionsAdd */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long) /* required */
            },
            "CpDecreasedPriceForRepeatedImpressions": {  /* StrategyCpDecreasedPriceForRepeatedImpressionsAdd */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long), /* required */
              "StartDate": (string), /* required */
              "EndDate": (string), /* required */
              "AutoContinue": ( "YES" | "NO" ) /* required */
            }
          } /* required */
        }, /* required */
        "Settings": [{  /* CpmBannerCampaignSetting */
          "Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        },
        "FrequencyCap": {  /* FrequencyCapSetting */
          "Impressions": (int), /* required */
          "PeriodDays": (int) /* required */ /* nillable */
        }
      }
    }, ... ] /* required */
  }
}
Параметр Тип Описание Обязательный
Структура CpmBannerCampaignAddItem
BiddingStrategy CpmBannerCampaignStrategyAdd Стратегия показа. Да
Settings array of CpmBannerCampaignSetting Массив настроек, допускающих только значения YES или NO. Нет
CounterIds ArrayOfInteger Идентификаторы счетчиков Яндекс.Метрики, установленных на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). Не более 5 элементов в массиве. Нет
FrequencyCap FrequencyCapSetting Ограничение частоты показов одному пользователю. Если структура не задана, частота показов не ограничена. Нет
Структура CpmBannerCampaignSetting
Option CpmBannerCampaignSettingsEnum

Имя настройки:

Да
Value YesNoEnum Значение настройки. Да
Структура FrequencyCapSetting
Impressions int Максимальное количество показов одному пользователю за период. Да
PeriodDays int, nillable

Количество дней от 1 до 30.

null (nil) — ограничение действует всё время проведения рекламной кампании.

Да
Структура CpmBannerCampaignStrategyAdd
Network CpmBannerCampaignNetworkStrategyAdd Стратегия показа в сетях. Да
Структура CpmBannerCampaignSearchStrategyAdd
BiddingStrategyType CpmBannerCampaignSearchStrategyTypeEnum Тип стратегии показа на поиске. Доступно единственное значение: SERVING_OFF. Да
Структура CpmBannerCampaignNetworkStrategyAdd
BiddingStrategyType CpmBannerCampaignNetworkStrategyTypeEnum

Тип стратегии показа в сетях:

Да
WbMaximumImpressions StrategyWbMaximumImpressionsAdd Параметры стратегии Максимум показов по минимальной цене (еженедельно). При значении WB_MAXIMUM_IMPRESSIONS в параметре BiddingStrategyType
CpMaximumImpressions StrategyCpMaximumImpressionsAdd Параметры стратегии Максимум показов по минимальной цене (за период). При значении CP_MAXIMUM_IMPRESSIONS в параметре BiddingStrategyType
WbDecreasedPriceForRepeatedImpressions StrategyWbDecreasedPriceForRepeatedImpressionsAdd Параметры стратегии Снижение цены повторных показов (еженедельно). При значении WB_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS в параметре BiddingStrategyType
CpDecreasedPriceForRepeatedImpressions StrategyCpDecreasedPriceForRepeatedImpressionsAdd Параметры стратегии Снижение цены повторных показов (за период). При значении CP_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS в параметре BiddingStrategyType
Структура StrategyWbMaximumImpressionsAdd
AverageCpm long

Средняя цена за тысячу показов в валюте рекламодателя, умноженная на 1 000 000.

Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Да
SpendLimit long

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Да
Структура StrategyCpMaximumImpressionsAdd
AverageCpm long

Средняя цена за тысячу показов в валюте рекламодателя, умноженная на 1 000 000.

Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Да
SpendLimit long

Бюджет на период в валюте рекламодателя, умноженный на 1 000 000.

Минимальный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Да
StartDate string Дата начала периода в формате YYYY-MM-DD. Должна быть не меньше текущей даты и даты начала кампании. Да
EndDate string Дата окончания периода в формате YYYY-MM-DD. Должна быть не больше даты окончания кампании. Да
AutoContinue YesNoEnum Продлевать период автоматически, чтобы использовать оставшийся бюджет. Да
Структура StrategyWbDecreasedPriceForRepeatedImpressionsAdd
AverageCpm long

Средняя цена за тысячу показов в валюте рекламодателя, умноженная на 1 000 000.

Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Да
SpendLimit long

Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000.

Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Да
Структура StrategyCpDecreasedPriceForRepeatedImpressionsAdd
AverageCpm long

Средняя цена за тысячу показов в валюте рекламодателя, умноженная на 1 000 000.

Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Да
SpendLimit long

Бюджет на период в валюте рекламодателя, умноженный на 1 000 000.

Минимальный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.

Да
StartDate string Дата начала периода в формате YYYY-MM-DD. Должна быть не меньше текущей даты и даты начала кампании. Да
EndDate string Дата окончания периода в формате YYYY-MM-DD. Должна быть не больше даты окончания кампании. Да
AutoContinue YesNoEnum Продлевать период автоматически, чтобы использовать оставшийся бюджет. Да