CpmBannerCampaign

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 */
            },
            "WbAverageCpv" : {  /* StrategyWbAverageCpvAdd */
              "AverageCpv" : (long) /* required */,
              "SpendLimit" : (long) /* required */
            },
            "CpAverageCpv" : {  /* StrategyCpAverageCpvAdd */
              "AverageCpv" : (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 */
        },
        "VideoTarget": ("VIEWS"|"CLICKS")
      }
    }, ... ] /* required */
  }
}


Структура CpmBannerCampaignAddItem
Параметр	Тип	Описание	Обязательный
`BiddingStrategy`	CpmBannerCampaignStrategyAdd	Стратегия показа.	Да
`Settings`	array of CpmBannerCampaignSetting	Массив настроек, допускающих только значения YES или NO.	Нет
`CounterIds`	ArrayOfInteger	Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа).	Нет
`FrequencyCap`	FrequencyCapSetting	Ограничение частоты показов одному пользователю. Если структура не задана, частота показов не ограничена.	Нет
`VideoTarget`	VideoTargetEnum	Цель показов видеоролика. Доступные значения: VIEWS — досмотры; CLICKS — переходы на сайт. При стратегиях AUTOBUDGET_AVG_CPV и AUTOBUDGET_AVG_CPV_CUSTOM_PERIOD значение сбрасывается в null.	Нет
Структура CpmBannerCampaignSetting
`Option`	CpmBannerCampaignSettingsEnum	Имя настройки: ADD_METRICA_TAG ADD_OPENSTAT_TAG ADD_TO_FAVORITES ENABLE_AREA_OF_INTEREST_TARGETING ENABLE_SITE_MONITORING REQUIRE_SERVICING	Да
`Value`	YesNoEnum	Значение настройки.	Да
Структура FrequencyCapSetting
`Impressions`	int	Максимальное количество показов одному пользователю за период.	Да
`PeriodDays`	int, nillable	Количество дней от 1 до 30. null (nil) — ограничение действует всё время проведения рекламной кампании.	Да
Структура CpmBannerCampaignStrategyAdd
`Search`	CpmBannerCampaignSearchStrategyAdd	Стратегия показа на поиске.	Да
`Network`	CpmBannerCampaignNetworkStrategyAdd	Стратегия показа в сетях.	Да
Структура CpmBannerCampaignSearchStrategyAdd
`BiddingStrategyType`	CpmBannerCampaignSearchStrategyTypeEnum	Тип стратегии показа на поиске. Доступно единственное значение: SERVING_OFF.	Да
Структура CpmBannerCampaignNetworkStrategyAdd
`BiddingStrategyType`	CpmBannerCampaignNetworkStrategyTypeEnum	Тип стратегии показа в сетях: MANUAL_CPM CP_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS WB_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS CP_MAXIMUM_IMPRESSIONS WB_MAXIMUM_IMPRESSIONS CP_AVERAGE_CPV WB_AVERAGE_CPV	Да
`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
`WbAverageCpv`	StrategyWbAverageCpvAdd	Параметры стратегии Максимум просмотров видео (еженедельно).	При значении WB_AVERAGE_CPV в параметре BiddingStrategyType
`CpAverageCpv`	StrategyCpAverageCpvAdd	Параметры стратегии Максимум просмотров видео (за период).	При значении CP_AVERAGE_CPV в параметре 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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.	Да
Структура StrategyWbAverageCpvAdd
`AverageCpv`	long	Средняя цена за просмотр видео в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.	Да
`SpendLimit`	long	Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.	Да
Структура StrategyCpAverageCpvAdd
`AverageCpv`	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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.	Да


Структура CpmBannerCampaignAddItem
Параметр	Тип	Описание	Обязательный
`BiddingStrategy`	CpmBannerCampaignStrategyAdd	Стратегия показа.	Да
`Settings`	array of CpmBannerCampaignSetting	Массив настроек, допускающих только значения YES или NO.	Нет
`CounterIds`	ArrayOfInteger	Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа).	Нет
`FrequencyCap`	FrequencyCapSetting	Ограничение частоты показов одному пользователю. Если структура не задана, частота показов не ограничена.	Нет
`VideoTarget`	VideoTargetEnum	Цель показов видеоролика. Доступные значения: VIEWS — досмотры; CLICKS — переходы на сайт. При стратегиях AUTOBUDGET_AVG_CPV и AUTOBUDGET_AVG_CPV_CUSTOM_PERIOD значение сбрасывается в null.	Нет
Структура CpmBannerCampaignSetting
`Option`	CpmBannerCampaignSettingsEnum	Имя настройки: ADD_METRICA_TAG ADD_OPENSTAT_TAG ADD_TO_FAVORITES ENABLE_AREA_OF_INTEREST_TARGETING ENABLE_SITE_MONITORING REQUIRE_SERVICING	Да
`Value`	YesNoEnum	Значение настройки.	Да
Структура FrequencyCapSetting
`Impressions`	int	Максимальное количество показов одному пользователю за период.	Да
`PeriodDays`	int, nillable	Количество дней от 1 до 30. null (nil) — ограничение действует всё время проведения рекламной кампании.	Да
Структура CpmBannerCampaignStrategyAdd
`Search`	CpmBannerCampaignSearchStrategyAdd	Стратегия показа на поиске.	Да
`Network`	CpmBannerCampaignNetworkStrategyAdd	Стратегия показа в сетях.	Да
Структура CpmBannerCampaignSearchStrategyAdd
`BiddingStrategyType`	CpmBannerCampaignSearchStrategyTypeEnum	Тип стратегии показа на поиске. Доступно единственное значение: SERVING_OFF.	Да
Структура CpmBannerCampaignNetworkStrategyAdd
`BiddingStrategyType`	CpmBannerCampaignNetworkStrategyTypeEnum	Тип стратегии показа в сетях: MANUAL_CPM CP_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS WB_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS CP_MAXIMUM_IMPRESSIONS WB_MAXIMUM_IMPRESSIONS CP_AVERAGE_CPV WB_AVERAGE_CPV	Да
`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
`WbAverageCpv`	StrategyWbAverageCpvAdd	Параметры стратегии Максимум просмотров видео (еженедельно).	При значении WB_AVERAGE_CPV в параметре BiddingStrategyType
`CpAverageCpv`	StrategyCpAverageCpvAdd	Параметры стратегии Максимум просмотров видео (за период).	При значении CP_AVERAGE_CPV в параметре 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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.	Да
Структура StrategyWbAverageCpvAdd
`AverageCpv`	long	Средняя цена за просмотр видео в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.	Да
`SpendLimit`	long	Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.	Да
Структура StrategyCpAverageCpvAdd
`AverageCpv`	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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.	Да

Была ли статья полезна?

Расскажите, что вам не понравилось в статье:

MobileAppCampaign