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

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

{
  "method": "update",
  "params": {
    "Campaigns": [{  /* CampaignUpdateItem */
      ...
      "MobileAppCampaign": {  /* MobileAppCampaignUpdateItem */
        "BiddingStrategy": {  /* MobileAppCampaignStrategy */
          "Search": {  /* MobileAppCampaignSearchStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPC" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long) /* nillable */
            },
            "WbMaximumAppInstalls": {  /* StrategyMaximumAppInstalls */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "AverageCpi": {  /* StrategyAverageCpi */
              "AverageCpi": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "BidCeiling": (long) /* nillable */
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "PayForInstall" : {  /* StrategyPayForInstall */
              "AverageCpi" : (long),
              "WeeklySpendLimit" : (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            }
          },
          "Network": {  /* MobileAppCampaignNetworkStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPC" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefault */
              "LimitPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long) /* nillable */
            },
            "WbMaximumAppInstalls": {  /* StrategyMaximumAppInstalls */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "AverageCpi": {  /* StrategyAverageCpi */
              "AverageCpi": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "BidCeiling": (long) /* nillable */
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "PayForInstall" : {  /* StrategyPayForInstall */
              "AverageCpi" : (long),
              "WeeklySpendLimit" : (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            }
          }
        },
        "Settings": [{  /* MobileAppCampaignSetting */
          "Option": ( "ADD_TO_FAVORITES" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }
    }, ....] /* required */
  }
}

Параметр

Тип

Описание

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

Структура MobileAppCampaignUpdateItem

Settings

array of MobileAppCampaignSetting

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

Нет

BiddingStrategy

MobileAppCampaignStrategy

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

Нет

NegativeKeywordSharedSetIds

ArrayOfLong, nillable

Идентификаторы наборов минус-фраз. Не более 3 элементов в массиве.

Получить идентификаторы наборов можно с помощью метода NegativeKeywordSharedSets.get.

Нет

Структура MobileAppCampaignSetting

Option

MobileAppCampaignSettingsEnum

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

  • ADD_TO_FAVORITES
  • ENABLE_AREA_OF_INTEREST_TARGETING
  • MAINTAIN_NETWORK_CPC
  • REQUIRE_SERVICING

Да

Value

YesNoEnum

Значение настройки.

Да

Структура MobileAppCampaignStrategy

Search

MobileAppCampaignSearchStrategy

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

Нет

Network

MobileAppCampaignNetworkStrategy

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

Нет

Структура MobileAppCampaignSearchStrategy

BiddingStrategyType

MobileAppCampaignSearchStrategyTypeEnum

Тип стратегии показа на поиске:

  • HIGHEST_POSITION
  • WB_MAXIMUM_CLICKS
  • WB_MAXIMUM_APP_INSTALLS
  • AVERAGE_CPC
  • AVERAGE_CPI
  • WEEKLY_CLICK_PACKAGE
  • PAY_FOR_INSTALL
  • SERVING_OFF

О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа.

Да

WbMaximumClicks

StrategyMaximumClicks

Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету.

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

WbMaximumAppInstalls

StrategyMaximumAppInstalls

Параметры стратегии Оптимизация количества установок приложения, без указания средней цены установки.

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

AverageCpc

StrategyAverageCpc

Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика.

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

WeeklyClickPackage

StrategyWeeklyClickPackage

Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов.

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

AverageCpi

StrategyAverageCpi

Параметры стратегии Оптимизация количества установок приложения, удерживать среднюю цену установки.

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

PayForInstall

StrategyPayForInstall

Параметры стратегии Оптимизация конверсий, оплата за установки.

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

Структура MobileAppCampaignNetworkStrategy

BiddingStrategyType

MobileAppCampaignNetworkStrategyTypeEnum

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

  • NETWORK_DEFAULT
  • MAXIMUM_COVERAGE
  • WB_MAXIMUM_CLICKS
  • WB_MAXIMUM_APP_INSTALLS
  • AVERAGE_CPC
  • AVERAGE_CPI
  • WEEKLY_CLICK_PACKAGE
  • PAY_FOR_INSTALL
  • SERVING_OFF

О совместимости стратегий на поиске и в сетях см. в разделе Стратегии показа

Да

NetworkDefault

StrategyNetworkDefault

Настройки показов в сетях в зависимости от настроек на поиске.

Если выбрана стратегия на поиске, отличная от HIGHEST_POSITION, передайте пустую структуру.

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

WbMaximumClicks

StrategyMaximumClicks

Параметры стратегии Оптимизация кликов, ограничивать по недельному бюджету.

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

WbMaximumAppInstalls

StrategyMaximumAppInstalls

Параметры стратегии Оптимизация количества установок приложения, без указания средней цены установки.

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

AverageCpc

StrategyAverageCpc

Параметры стратегии Оптимизация кликов, ограничивать по средней цене клика.

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

WeeklyClickPackage

StrategyWeeklyClickPackage

Параметры стратегии Оптимизация кликов, ограничивать по пакету кликов.

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

AverageCpi

StrategyAverageCpi

Параметры стратегии Оптимизация количества установок приложения, удерживать среднюю цену установки.

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

PayForInstall

StrategyPayForInstall

Параметры стратегии Оптимизация конверсий, оплата за установки.

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

Структура StrategyMaximumClicks

WeeklySpendLimit

long

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

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

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

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

Примечание

Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.

Нет

Структура StrategyMaximumAppInstalls

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

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

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

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

Примечание

Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.

Нет

Структура StrategyAverageCpc

AverageCpc

long

Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000.

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

Нет

WeeklySpendLimit

long, nillable

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

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

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

Структура StrategyAverageCpi

AverageCpi

long

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

Минимальное допустимое значение представлено в разделе Валютные параметры и ограничения.

Нет

WeeklySpendLimit

long, nillable

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

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

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

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

Примечание

Указывать максимальную ставку не рекомендуется — это может снизить эффективность работы стратегии.

Нет

Структура StrategyPayForInstall

AverageCpi

long

Цена за установку приложения в валюте рекламодателя, умноженная на 1 000 000.

Минимальные и максимальные допустимые значения представлены в разделе Валютные параметры и ограничения.

Нет

WeeklySpendLimit

long, nillable

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

Бюджет на период. Подробнее см. в справке Директа.

При создании кампании нельзя указать одновременно с WeeklySpendLimit.

Нет

BudgetType

BudgetTypeEnum

Тип бюджета:

  • WEEKLY_BUDGET – недельный бюджет.
  • CUSTOM_PERIOD_BUDGET – бюджет на период.

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

Например, если тип бюджета поменялся с недельного на периодный, поле WeeklySpendLimit должно быть передано со значением NULL.

Нет

Структура StrategyWeeklyClickPackage

ClicksPerWeek

long

Требуемое количество кликов в неделю.

Нет

AverageCpc

long, nillable

Средняя цена клика в валюте рекламодателя, умноженная на 1 000 000.

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

Примечание

Параметры AverageCpc и BidCeiling являются взаимоисключающими. Если ранее был задан параметр BidCeiling, то, чтобы задать AverageCpc, нужно одновременно передать null (nil) для BidCeiling.

Нет

BidCeiling

long, nillable

Максимальная ставка в валюте рекламодателя, умноженная на 1 000 000.

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

Примечание

Параметры AverageCpc и BidCeiling являются взаимоисключающими. Если ранее был задан параметр AverageCpc, то, чтобы задать BidCeiling, нужно одновременно передать null (nil) для AverageCpc.

Нет

Структура StrategyNetworkDefault

LimitPercent

int

Максимальный процент бюджета, расходуемый на показы в сетях. Значение кратно десяти: 10, 20, ..., 100.

В случае смены стратегии, если параметр не указан, устанавливается значение по умолчанию — 100.

Если выбрана стратегия на поиске, отличная от HIGHEST_POSITION, параметр не используется, переданное значение игнорируется.

Нет

Структура CustomPeriodBudget

SpendLimit

long

Значение бюджета на период.

Да

StartDate

string

Начало бюджетного периода.

Да

EndDate

string

Окончание бюджетного периода.

Да

AutoContinue

YesNoEnum

Признак автопродления бюджета.

Да