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 */
            }
          } 
        },
        "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 */
      }
    }, ... ],
    "LimitedBy": (long)
  }
}
Параметр Тип Описание
Структура CpmBannerCampaignGetItem
BiddingStrategy CpmBannerCampaignStrategy Стратегия показа.
Settings array of CpmBannerCampaignSettingGet Массив настроек, допускающих только значения YES или NO.
CounterIds ArrayOfInteger, nillable Идентификаторы счетчиков Яндекс.Метрики, установленных на сайте рекламодателя (см. раздел Метрика. Оценка эффективности рекламной кампании помощи Директа). Не более 5 элементов в массиве.
FrequencyCap FrequencyCapSetting, nillable Ограничение частоты показов одному пользователю. Если структура не задана, частота показов не ограничена.
Структура CpmBannerCampaignSettingGet
Option CpmBannerCampaignSettingsGetEnum

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

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

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

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

Структура CpmBannerCampaignStrategy
Network CpmBannerCampaignNetworkStrategy Стратегия показа в сетях.
Структура CpmBannerCampaignSearchStrategy
BiddingStrategyType CpmBannerCampaignSearchStrategyTypeEnum Тип стратегии показа на поиске. Доступно единственное значение: SERVING_OFF.
Структура CpmBannerCampaignNetworkStrategy
BiddingStrategyType CpmBannerCampaignNetworkStrategyTypeEnum Тип стратегии показа в сетях:
WbMaximumImpressions StrategyWbMaximumImpressions Параметры стратегии Максимум показов по минимальной цене (еженедельно).
CpMaximumImpressions StrategyCpMaximumImpressions Параметры стратегии Максимум показов по минимальной цене (за период).
WbDecreasedPriceForRepeatedImpressions StrategyWbDecreasedPriceForRepeatedImpressions Параметры стратегии Снижение цены повторных показов (еженедельно).
CpDecreasedPriceForRepeatedImpressions StrategyCpDecreasedPriceForRepeatedImpressions Параметры стратегии Снижение цены повторных показов (за период).
Структура 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 Продлевать период автоматически, чтобы использовать оставшийся бюджет.