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

Структура запроса в формате 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 */
            },
            "WbAverageCpv" : {  /* StrategyWbAverageCpv */
              "AverageCpv" : (long) /* required */,
              "SpendLimit" : (long) /* required */
            },
            "CpAverageCpv" : {  /* StrategyCpAverageCpv */
              "AverageCpv" : (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 */
        "VideoTarget": ("VIEWS"|"CLICKS")
      }
    }, ... ] /* required */
  }
}

Параметр

Тип

Описание

Обязательный

Структура CpmBannerCampaignUpdateItem

BiddingStrategy

CpmBannerCampaignStrategy

Стратегия показа.

Нет

Settings

array of CpmBannerCampaignSetting

Массив настроек, допускающих только значения YES или NO.

Нет

CounterIds

ArrayOfInteger, nillable

Идентификаторы счетчиков Яндекс Метрики, установленных на сайте рекламодателя (см. раздел Яндекс Метрика: оценка эффективности рекламы помощи Директа).

Нет

FrequencyCap

FrequencyCapSetting, nillable

Ограничение частоты показов одному пользователю. Чтобы сбросить ограничение, передайте null (nil).

Нет

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) — ограничение действует всё время проведения рекламной кампании.

Да

Структура 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

Да

WbMaximumImpressions

StrategyWbMaximumImpressions

Параметры стратегии Максимум показов по минимальной цене (еженедельно).

При значении WB_MAXIMUM_IMPRESSIONS в параметре BiddingStrategyType

CpMaximumImpressions

StrategyCpMaximumImpressions

Параметры стратегии Максимум показов по минимальной цене (за период).

При значении CP_MAXIMUM_IMPRESSIONS в параметре BiddingStrategyType

WbDecreasedPriceForRepeatedImpressions

StrategyWbDecreasedPriceForRepeatedImpressions

Параметры стратегии Снижение цены повторных показов (еженедельно).

При значении WB_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS в параметре BiddingStrategyType

CpDecreasedPriceForRepeatedImpressions

StrategyCpDecreasedPriceForRepeatedImpressions

Параметры стратегии Снижение цены повторных показов (за период).

При значении CP_DECREASED_PRICE_FOR_REPEATED_IMPRESSIONS в параметре BiddingStrategyType

WbAverageCpv

StrategyWbAverageCpv

Параметры стратегии Максимум просмотров видео (еженедельно).

При значении WB_AVERAGE_CPV в параметре BiddingStrategyType

CpAverageCpv

StrategyCpAverageCpv

Параметры стратегии Максимум просмотров видео (за период).

При значении CP_AVERAGE_CPV в параметре BiddingStrategyType

Структура 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

Продлевать период автоматически, чтобы использовать оставшийся бюджет.

Да
Предыдущая
update: параметры MobileAppCampaign
Следующая
Changes: проверка наличия изменений