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

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

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

{
  "method": "update",
  "params": {
    "Campaigns": [{  /* CampaignUpdateItem */
      ...
      "CpmBannerCampaign": {  /* CpmBannerCampaignUpdateItem */
        "BiddingStrategy": {  /* CpmBannerCampaignStrategy */
          "Search": {  /* CpmBannerCampaignSearchStrategy */
            "BiddingStrategyType": ( "SERVING_OFF" ) /* required */
          }, 
          "Network": {  /* CpmBannerCampaignNetworkStrategy */
            "BiddingStrategyType": ( "MANUAL_CPM" | ... | "WB_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS" ), /* required */
            "WbMaximumImpressions": {  /* StrategyWbMaximumImpressions */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long) /* required */
            },
            "CpMaximumImpressions": {  /* StrategyCpMaximumImpressions */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long), /* required */
              "StartDate": (string), /* required */
              "EndDate": (string), /* required */
              "AutoContinue": ( "YES" | "NO" ) /* required */
            },
            "WbDecreasedPriceForRepeatedImpressions": {  /* StrategyWbDecreasedPriceForRepeatedImpressions */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long) /* required */
            },
            "CpDecreasedPriceForRepeatedImpressions": {  /* StrategyCpDecreasedPriceForRepeatedImpressions */
              "AverageCpm": (long), /* required */
              "SpendLimit": (long), /* required */
              "StartDate": (string), /* required */
              "EndDate": (string), /* required */
              "AutoContinue": ( "YES" | "NO" ) /* required */
            }
          } 
        },
        "Settings": [{  /* CpmBannerCampaignSetting */
          "Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        }, /* nillable */
        "FrequencyCap": {  /* FrequencyCapSetting */
          "Impressions": (int), /* required */
          "PeriodDays": (int) /* required */ /* nillable */
        } /* nillable */
      }
    }, ... ] /* required */
  }
}
ПараметрТипОписаниеОбязательный
Структура CpmBannerCampaignUpdateItem
BiddingStrategyCpmBannerCampaignStrategyСтратегия показа.Нет
Settingsarray of CpmBannerCampaignSettingМассив настроек, допускающих только значения YES или NO.Нет
CounterIdsArrayOfInteger, nillableИдентификаторы счетчиков Яндекс.Метрики, установленных на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). Не более 5 элементов в массиве.Нет
FrequencyCapFrequencyCapSetting, nillableОграничение частоты показов одному пользователю. Чтобы сбросить ограничение, передайте null (nil).Нет
Структура CpmBannerCampaignSetting
OptionCpmBannerCampaignSettingsEnum

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

Да
ValueYesNoEnumЗначение настройки.Да
Структура FrequencyCapSetting
ImpressionsintМаксимальное количество показов одному пользователю за период.Да
PeriodDaysint, nillable

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

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

Да
Структура CpmBannerCampaignStrategy
NetworkCpmBannerCampaignNetworkStrategyСтратегия показа в сетях.Нет
Структура CpmBannerCampaignSearchStrategy
BiddingStrategyTypeCpmBannerCampaignSearchStrategyTypeEnumТип стратегии показа на поиске. Доступно единственное значение: SERVING_OFF.Да
Структура CpmBannerCampaignNetworkStrategy
BiddingStrategyTypeCpmBannerCampaignNetworkStrategyTypeEnum

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

Да
WbMaximumImpressionsStrategyWbMaximumImpressionsПараметры стратегии Максимум показов по минимальной цене (еженедельно).При значении WB_MAXIMUM_IMPRESSIONS в параметре BiddingStrategyType
CpMaximumImpressionsStrategyCpMaximumImpressionsПараметры стратегии Максимум показов по минимальной цене (за период).При значении CP_MAXIMUM_IMPRESSIONS в параметре BiddingStrategyType
WbDecreasedPriceForRepeatedImpressionsStrategyWbDecreasedPriceForRepeatedImpressionsПараметры стратегии Снижение цены повторных показов (еженедельно).При значении WB_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS в параметре BiddingStrategyType
CpDecreasedPriceForRepeatedImpressionsStrategyCpDecreasedPriceForRepeatedImpressionsПараметры стратегии Снижение цены повторных показов (за период).При значении CP_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS в параметре BiddingStrategyType
Структура StrategyWbMaximumImpressions
AverageCpmlong

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

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

Да
SpendLimitlong

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

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

Да
Структура StrategyCpMaximumImpressions
AverageCpmlong

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

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

Да
SpendLimitlong

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

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

Да
StartDatestringДата начала периода в формате YYYY-MM-DD. Должна быть не меньше текущей даты и даты начала кампании.Да
EndDatestringДата окончания периода в формате YYYY-MM-DD. Должна быть не больше даты окончания кампании.Да
AutoContinueYesNoEnumПродлевать период автоматически, чтобы использовать оставшийся бюджет.Да
Структура StrategyWbDecreasedPriceForRepeatedImpressions
AverageCpmlong

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

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

Да
SpendLimitlong

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

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

Да
Структура StrategyCpDecreasedPriceForRepeatedImpressions
AverageCpmlong

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

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

Да
SpendLimitlong

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

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

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