add: MobileAppCampaign parameters

Attention. All monetary campaign parameters (daily budget, weekly budget, and average price for automatic strategies) are passed via the Yandex.Direct API as integer numbers. The passed value is a monetary value in the advertiser's currency, multiplied by 1,000,000.

Request structure in JSON format:

{
  "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)
            },
            "AverageCpi": {  /* StrategyAverageCpiAdd */
              "AverageCpi": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            }
          }, /* required */
          "Network": {  /* MobileAppCampaignNetworkStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPC" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefaultAdd */
              "LimitPercent": (int),
              "BidPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "WbMaximumAppInstalls": {  /* StrategyMaximumAppInstallsAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long)
            },
            "AverageCpi": {  /* StrategyAverageCpiAdd */
              "AverageCpi": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            }
          } /* required */
        }, /* required */
        "Settings": [{  /* MobileAppCampaignSetting */
          "Option": ( "ADD_TO_FAVORITES" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
      }
    }, ...] /* required */
  }
}
ParameterTypeDescriptionRequired
MobileAppCampaignAddItem structure
Settingsarray of MobileAppCampaignSettingArray of settings that only accept the values YES or NO.No
BiddingStrategyMobileAppCampaignStrategyAddDisplay strategy.Yes
MobileAppCampaignSetting structure
OptionMobileAppCampaignSettingsEnum

Setting name:

Yes
ValueYesNoEnumSetting value.Yes
MobileAppCampaignStrategyAdd structure
NetworkMobileAppCampaignNetworkStrategyAddDisplay strategy in ad networks.Yes
MobileAppCampaignSearchStrategyAdd structure
BiddingStrategyTypeMobileAppCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

For information about the compatibility of strategies in search results and ad networks, see the section Display strategies.

Yes
WbMaximumClicksStrategyMaximumClicksAddParameters for the Weekly budget strategy (maximum clicks).When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS
WbMaximumAppInstallsStrategyMaximumAppInstallsAddParameters for the Weekly budget strategy (maximum number of installations).When the BiddingStrategyType parameter has the value WB_MAXIMUM_APP_INSTALLS
AverageCpcStrategyAverageCpcAddParameters for the Average CPC strategy.When the BiddingStrategyType parameter has the value AVERAGE_CPC
AverageCpiStrategyAverageCpiAddParameters for the Average price per app install strategy.When the BiddingStrategyType parameter has the value AVERAGE_CPI
WeeklyClickPackageStrategyWeeklyClickPackageAddParameters for the Weekly click package strategy.When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE
MobileAppCampaignNetworkStrategyAdd structure
BiddingStrategyTypeMobileAppCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

For information about the compatibility of strategies in search results and ad networks, see the section Display strategies

Yes
NetworkDefaultStrategyNetworkDefaultAddParameters for the “Manual bid management with optimization in ad networks” strategy (the bid is set relative to the bid in search results).When the BiddingStrategyType parameter has the value NETWORK_DEFAULT
WbMaximumClicksStrategyMaximumClicksAddParameters for the Weekly budget strategy (maximum clicks).When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS
WbMaximumAppInstallsStrategyMaximumAppInstallsAddParameters for the Weekly budget strategy (maximum number of installations).When the BiddingStrategyType parameter has the value WB_MAXIMUM_APP_INSTALLS
AverageCpcStrategyAverageCpcAddParameters for the Average CPC strategy.When the BiddingStrategyType parameter has the value AVERAGE_CPC
AverageCpiStrategyAverageCpiAddParameters for the Average price per app install strategy.When the BiddingStrategyType parameter has the value AVERAGE_CPI
WeeklyClickPackageStrategyWeeklyClickPackageAddParameters for the Weekly click package strategy.When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE
StrategyMaximumClicksAdd structure
WeeklySpendLimitlong

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Yes
BidCeilinglong

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
No
StrategyMaximumAppInstallsAdd structure
WeeklySpendLimitlong

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Yes
BidCeilinglong

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
No
StrategyAverageCpcAdd structure
AverageCpclong

The average CPC in the advertiser's currency, multiplied by 1,000,000.

The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Yes
WeeklySpendLimitlong

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

No
StrategyAverageCpiAdd structure
AverageCpilong

The average cost of an app installation in the advertiser's currency, multiplied by 1,000,000.

The minimum acceptable value is shown in the section Currency parameters and limits.

Yes
WeeklySpendLimitlong

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

No
BidCeilinglong

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
No
StrategyWeeklyClickPackageAdd structure
ClicksPerWeeklongDesired number of clicks per week.Yes
AverageCpclong

The average CPC in the advertiser's currency, multiplied by 1,000,000.

The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them.
No
BidCeilinglong

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
No
StrategyNetworkDefaultAdd structure
LimitPercentintThe maximum percentage of the budget to spend on displays in ad networks. The value is a multiple of ten: 10, 20, ..., 100. The default value is 100.No
BidPercentintThe limit on the bid in ad networks. Set as a percentage of the bid in search results. The value is a multiple of ten: 10, 20, ..., 100. The value 100 makes the bid in ad networks equal to the price in search results. The default value is 100.No