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

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

{
  "method": "add",
  "params": {
    "Campaigns": [{  /* CampaignAddItem */
      ...
      "MobileAppCampaign": {  /* MobileAppCampaignAddItem */
        "BiddingStrategy": {  /* MobileAppCampaignStrategyAdd */
          "Search": {  /* MobileAppCampaignSearchStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPC" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "WbMaximumAppInstalls": {  /* StrategyMaximumAppInstallsAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "AverageCpi": {  /* StrategyAverageCpiAdd */
              "AverageCpi": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            },
            "PayForInstall" : {  /* StrategyPayForInstallAdd */
              "AverageCpi" : (long) /* required */,
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            }
          }, /* required */
          "Network": {  /* MobileAppCampaignNetworkStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPC" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefaultAdd */
              "LimitPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "WbMaximumAppInstalls": {  /* StrategyMaximumAppInstallsAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "AverageCpi": {  /* StrategyAverageCpiAdd */
              "AverageCpi": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            },
            "PayForInstall" : {  /* StrategyPayForInstallAdd */
              "AverageCpi" : (long) /* required */,
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            }
          } /* required */
        }, /* required */
        "Settings": [{  /* MobileAppCampaignSetting */
          "Option": ( "ADD_TO_FAVORITES" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }
    }, ...] /* required */
  }
}

Параметр

Тип

Описание

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

Структура MobileAppCampaignAddItem

Settings

array of MobileAppCampaignSetting

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

Нет

BiddingStrategy

MobileAppCampaignStrategyAdd

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

Да

NegativeKeywordSharedSetIds

ArrayOfLong, nillable

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

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

Нет

Структура MobileAppCampaignSetting

Option

MobileAppCampaignSettingsEnum

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

  • ADD_TO_FAVORITES

  • ENABLE_AREA_OF_INTEREST_TARGETING

  • MAINTAIN_NETWORK_CPC

  • REQUIRE_SERVICING

Да

  • CAMPAIGN_EXACT_PHRASE_MATCHING_ENABLED

Нет

Value

YesNoEnum

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

Да

Структура MobileAppCampaignStrategyAdd

Search

MobileAppCampaignSearchStrategyAdd

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

Да

Network

MobileAppCampaignNetworkStrategyAdd

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

Да

Структура MobileAppCampaignSearchStrategyAdd

BiddingStrategyType

MobileAppCampaignSearchStrategyTypeEnum

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

  • HIGHEST_POSITION

  • WB_MAXIMUM_CLICKS

  • WB_MAXIMUM_APP_INSTALLS

  • AVERAGE_CPC

  • AVERAGE_CPI

  • WEEKLY_CLICK_PACKAGE

  • PAY_FOR_INSTALL

  • SERVING_OFF

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

Да

WbMaximumClicks

StrategyMaximumClicksAdd

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

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

WbMaximumAppInstalls

StrategyMaximumAppInstallsAdd

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

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

AverageCpc

StrategyAverageCpcAdd

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

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

AverageCpi

StrategyAverageCpiAdd

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

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

PayForInstall

StrategyPayForInstallAdd

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

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

WeeklyClickPackage

StrategyWeeklyClickPackageAdd

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

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

Структура MobileAppCampaignNetworkStrategyAdd

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

StrategyNetworkDefaultAdd

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

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

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

WbMaximumClicks

StrategyMaximumClicksAdd

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

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

WbMaximumAppInstalls

StrategyMaximumAppInstallsAdd

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

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

AverageCpc

StrategyAverageCpcAdd

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

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

AverageCpi

StrategyAverageCpiAdd

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

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

PayForInstall

StrategyPayForInstallAdd

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

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

WeeklyClickPackage

StrategyWeeklyClickPackageAdd

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

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

Структура StrategyMaximumClicksAdd

WeeklySpendLimit

long

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

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

Да

BidCeiling

long

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

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

Примечание

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

Нет

Структура StrategyMaximumAppInstallsAdd

WeeklySpendLimit

long

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

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

Да

BidCeiling

long

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

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

Примечание

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

Нет

Структура StrategyAverageCpcAdd

AverageCpc

long

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

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

Да

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

Структура StrategyAverageCpiAdd

AverageCpi

long

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

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

Да

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

BidCeiling

long

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

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

Примечание

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

Нет

Структура StrategyPayForInstallAdd

AverageCpi

long

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

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

Да

WeeklySpendLimit

long

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

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

Нет

CustomPeriodBudget

CustomPeriodBudget

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

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

Нет

Структура StrategyWeeklyClickPackageAdd

ClicksPerWeek

long

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

Да

AverageCpc

long

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

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

Примечание

Параметры AverageCpc и BidCeiling являются взаимоисключающими: нельзя указывать оба.

Нет

BidCeiling

long

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

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

Примечание

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

Нет

Структура StrategyNetworkDefaultAdd

LimitPercent

int

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

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

Нет

Структура CustomPeriodBudget

SpendLimit

long

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

Да

StartDate

string

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

Да

EndDate

string

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

Да

AutoContinue

YesNoEnum

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

Да