CpmBannerCampaign

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

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

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

{
  "result": {
    "Campaigns": [{  /* CampaignGetItem */
      ...
      "CpmBannerCampaign": {  /* CpmBannerCampaignGetItem */
        "BiddingStrategy": {  /* CpmBannerCampaignStrategy */
          "Search": {  /* CpmBannerCampaignSearchStrategy */
            "BiddingStrategyType": ( "SERVING_OFF" | "UNKNOWN" ) /* required */
          }, 
          "Network": {  /* CpmBannerCampaignNetworkStrategy */
            "BiddingStrategyType": ( "MANUAL_CPM" | ... | "WB_MAXIMUM_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 */
            },
            "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 */
            }
          } 
        },
        "Settings": [{  /* CpmBannerCampaignSettingGet */
          "Option": ( "ADD_METRICA_TAG" | ... | "SHARED_ACCOUNT_ENABLED" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        }, /* nillable */
        "FrequencyCap": {  /* FrequencyCapSetting */
          "Impressions": (int), /* required */
          "PeriodDays": (int) /* required */ /* nillable */
        }, /* nillable */
        "VideoTarget": ("VIEWS"|"CLICKS")
      }
    }, ... ],
    "LimitedBy": (long)
  }
}


Структура CpmBannerCampaignGetItem
Параметр	Тип	Описание
`BiddingStrategy`	CpmBannerCampaignStrategy	Стратегия показа.
`Settings`	array of CpmBannerCampaignSettingGet	Массив настроек, допускающих только значения YES или NO.
`CounterIds`	ArrayOfInteger, nillable	Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа).
`FrequencyCap`	FrequencyCapSetting, nillable	Ограничение частоты показов одному пользователю. Если структура не задана, частота показов не ограничена.
`VideoTarget`	VideoTargetEnum	Цель показов видеоролика. Доступные значения: VIEWS — досмотры; CLICKS — переходы на сайт. При стратегиях AUTOBUDGET_AVG_CPV и AUTOBUDGET_AVG_CPV_CUSTOM_PERIOD значение сбрасывается в null.
Структура CpmBannerCampaignSettingGet
`Option`	CpmBannerCampaignSettingsGetEnum	Имя настройки: ADD_METRICA_TAG ADD_OPENSTAT_TAG ADD_TO_FAVORITES ENABLE_AREA_OF_INTEREST_TARGETING ENABLE_SITE_MONITORING REQUIRE_SERVICING SHARED_ACCOUNT_ENABLED DAILY_BUDGET_ALLOWED
`Value`	YesNoEnum	Значение настройки.
Структура FrequencyCapSetting
`Impressions`	int	Максимальное количество показов одному пользователю за период.
`PeriodDays`	int, nillable	Количество дней от 1 до 30. null (nil) — ограничение действует всё время проведения рекламной кампании.
Структура CpmBannerCampaignStrategy
`Search`	CpmBannerCampaignSearchStrategy	Стратегия показа на поиске.
`Network`	CpmBannerCampaignNetworkStrategy	Стратегия показа в сетях.
Структура CpmBannerCampaignSearchStrategy
`BiddingStrategyType`	CpmBannerCampaignSearchStrategyTypeEnum	Тип стратегии показа на поиске. Доступно единственное значение: SERVING_OFF.
Структура CpmBannerCampaignNetworkStrategy
`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 UNKNOWN
`WbMaximumImpressions`	StrategyWbMaximumImpressions	Параметры стратегии Максимум показов по минимальной цене (еженедельно).
`CpMaximumImpressions`	StrategyCpMaximumImpressions	Параметры стратегии Максимум показов по минимальной цене (за период).
`WbDecreasedPriceForRepeatedImpressions`	StrategyWbDecreasedPriceForRepeatedImpressions	Параметры стратегии Снижение цены повторных показов (еженедельно).
`CpDecreasedPriceForRepeatedImpressions`	StrategyCpDecreasedPriceForRepeatedImpressions	Параметры стратегии Снижение цены повторных показов (за период).
`WbAverageCpv`	StrategyWbAverageCpv	Параметры стратегии Максимум просмотров видео (еженедельно).
`CpAverageCpv`	StrategyCpAverageCpv	Параметры стратегии Максимум просмотров видео (за период).
Структура StrategyWbMaximumImpressions
`AverageCpm`	long	Средняя цена за тысячу показов в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
`SpendLimit`	long	Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
Структура StrategyCpMaximumImpressions
`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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.
Структура StrategyWbDecreasedPriceForRepeatedImpressions
`AverageCpm`	long	Средняя цена за тысячу показов в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
`SpendLimit`	long	Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
Структура StrategyCpDecreasedPriceForRepeatedImpressions
`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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.
Структура StrategyWbAverageCpv
`AverageCpv`	long	Средняя цена за просмотр видео в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
`SpendLimit`	long	Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
Структура StrategyCpAverageCpv
`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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.


Структура CpmBannerCampaignGetItem
Параметр	Тип	Описание
`BiddingStrategy`	CpmBannerCampaignStrategy	Стратегия показа.
`Settings`	array of CpmBannerCampaignSettingGet	Массив настроек, допускающих только значения YES или NO.
`CounterIds`	ArrayOfInteger, nillable	Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа).
`FrequencyCap`	FrequencyCapSetting, nillable	Ограничение частоты показов одному пользователю. Если структура не задана, частота показов не ограничена.
`VideoTarget`	VideoTargetEnum	Цель показов видеоролика. Доступные значения: VIEWS — досмотры; CLICKS — переходы на сайт. При стратегиях AUTOBUDGET_AVG_CPV и AUTOBUDGET_AVG_CPV_CUSTOM_PERIOD значение сбрасывается в null.
Структура CpmBannerCampaignSettingGet
`Option`	CpmBannerCampaignSettingsGetEnum	Имя настройки: ADD_METRICA_TAG ADD_OPENSTAT_TAG ADD_TO_FAVORITES ENABLE_AREA_OF_INTEREST_TARGETING ENABLE_SITE_MONITORING REQUIRE_SERVICING SHARED_ACCOUNT_ENABLED DAILY_BUDGET_ALLOWED
`Value`	YesNoEnum	Значение настройки.
Структура FrequencyCapSetting
`Impressions`	int	Максимальное количество показов одному пользователю за период.
`PeriodDays`	int, nillable	Количество дней от 1 до 30. null (nil) — ограничение действует всё время проведения рекламной кампании.
Структура CpmBannerCampaignStrategy
`Search`	CpmBannerCampaignSearchStrategy	Стратегия показа на поиске.
`Network`	CpmBannerCampaignNetworkStrategy	Стратегия показа в сетях.
Структура CpmBannerCampaignSearchStrategy
`BiddingStrategyType`	CpmBannerCampaignSearchStrategyTypeEnum	Тип стратегии показа на поиске. Доступно единственное значение: SERVING_OFF.
Структура CpmBannerCampaignNetworkStrategy
`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 UNKNOWN
`WbMaximumImpressions`	StrategyWbMaximumImpressions	Параметры стратегии Максимум показов по минимальной цене (еженедельно).
`CpMaximumImpressions`	StrategyCpMaximumImpressions	Параметры стратегии Максимум показов по минимальной цене (за период).
`WbDecreasedPriceForRepeatedImpressions`	StrategyWbDecreasedPriceForRepeatedImpressions	Параметры стратегии Снижение цены повторных показов (еженедельно).
`CpDecreasedPriceForRepeatedImpressions`	StrategyCpDecreasedPriceForRepeatedImpressions	Параметры стратегии Снижение цены повторных показов (за период).
`WbAverageCpv`	StrategyWbAverageCpv	Параметры стратегии Максимум просмотров видео (еженедельно).
`CpAverageCpv`	StrategyCpAverageCpv	Параметры стратегии Максимум просмотров видео (за период).
Структура StrategyWbMaximumImpressions
`AverageCpm`	long	Средняя цена за тысячу показов в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
`SpendLimit`	long	Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
Структура StrategyCpMaximumImpressions
`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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.
Структура StrategyWbDecreasedPriceForRepeatedImpressions
`AverageCpm`	long	Средняя цена за тысячу показов в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
`SpendLimit`	long	Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
Структура StrategyCpDecreasedPriceForRepeatedImpressions
`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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.
Структура StrategyWbAverageCpv
`AverageCpv`	long	Средняя цена за просмотр видео в валюте рекламодателя, умноженная на 1 000 000. Минимальное значение средней цены для каждой валюты представлено в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
`SpendLimit`	long	Недельный бюджет в валюте рекламодателя, умноженный на 1 000 000. Минимальный недельный бюджет для каждой валюты представлен в справочнике валют. Справочник валют можно получить с помощью метода Dictionaries.get.
Структура StrategyCpAverageCpv
`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	Продлевать период автоматически, чтобы использовать оставшийся бюджет.

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

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