--- metadata: - name: generator content: Diplodoc Platform v5.57.3 alternate: - https://yandex.com/dev/direct/doc/en/campaigns/add-mobile-app-campaign.md - https://yandex.com/dev/direct/doc/ru/campaigns/add-mobile-app-campaign.md - href: https://yandex.com/dev/direct/doc/en/campaigns/add-mobile-app-campaign.md type: text/markdown title: Markdown version - href: https://yandex.com/dev/direct/doc/en/llms.txt type: text/markdown title: llms.txt sourcePath: en/ref-v5/campaigns/add-mobile-app-campaign.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/en/llms.txt # add: MobileAppCampaign parameters Request structure in JSON format: ```javascript translate=no { "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 */ } } ``` #| || **Parameter** | **Type** | **Description** | **Required** || || **MobileAppCampaignAddItem structure** || || `Settings` | array of MobileAppCampaignSetting | Array of settings that only accept the values YES or NO. | No || || `BiddingStrategy` | MobileAppCampaignStrategyAdd | Display strategy. | Yes || || `NegativeKeywordSharedSetIds` | ArrayOfLong, nillable | IDs of sets of negative keywords. Maximum of 3 items in the array. To get the IDs of sets, use the [NegativeKeywordSharedSets](https://yandex.com/dev/direct/doc/en/negativekeywordsharedsets/negativekeywordsharedsets.md).[get](https://yandex.com/dev/direct/doc/en/negativekeywordsharedsets/get.md) method. | No || || **MobileAppCampaignSetting structure** || || `Option` | MobileAppCampaignSettingsEnum | Setting name: - ADD_TO_FAVORITES - ENABLE_AREA_OF_INTEREST_TARGETING - MAINTAIN_NETWORK_CPC - REQUIRE_SERVICING | Yes || || - CAMPAIGN_EXACT_PHRASE_MATCHING_ENABLED | No || || `Value` | YesNoEnum | Setting value. | Yes || || **MobileAppCampaignStrategyAdd structure** || || `Search` | MobileAppCampaignSearchStrategyAdd | Display strategy in search results. | Yes || || `Network` | MobileAppCampaignNetworkStrategyAdd | Display strategy in ad networks. | Yes || || **MobileAppCampaignSearchStrategyAdd structure** || || `BiddingStrategyType` | MobileAppCampaignSearchStrategyTypeEnum | The type of display strategy in search results: - HIGHEST_POSITION - WB_MAXIMUM_CLICKS - WB_MAXIMUM_APP_INSTALLS - AVERAGE_CPC - AVERAGE_CPI - WEEKLY_CLICK_PACKAGE - PAY_FOR_INSTALL - SERVING_OFF For information about the compatibility of strategies in search results and ad networks, see the section [Display strategies](https://yandex.com/dev/direct/doc/objects/campaign-strategies.html). | Yes || || `WbMaximumClicks` | StrategyMaximumClicksAdd | Parameters of the [Optimize clicks](https://yandex.com/support/direct/en/strategies/weekly-budget.html) strategy. Limited by weekly budget. | When the `BiddingStrategyType` parameter is set to WB_MAXIMUM_CLICKS || || `WbMaximumAppInstalls` | StrategyMaximumAppInstallsAdd | Parameters of the [Optimize number of app installations](https://yandex.com/support/direct/en/strategies/weekly-budget.html) strategy, without specifying the average CPI. | When the `BiddingStrategyType` parameter is set to WB_MAXIMUM_APP_INSTALLS || || `AverageCpc` | StrategyAverageCpcAdd | Parameters of the [Optimize clicks](https://yandex.com/support/direct/en/strategies/average-cpc.html) strategy. Limited by average CPC. | When the `BiddingStrategyType` parameter is set to AVERAGE_CPC || || `AverageCpi` | StrategyAverageCpiAdd | Parameters of the [Optimize number of app installations](https://yandex.com/support/direct/en/strategies/average-cpa-mobile-apps#fix-cpi) strategy. Maintain the average CPI. | When the `BiddingStrategyType` parameter is set to AVERAGE_CPI || || `PayForInstall` | StrategyPayForInstallAdd | Parameters of the [Optimize conversions](https://yandex.com/support/direct/en/strategies/average-cpa-mobile-apps.html#average-cpa-mobile-apps__fix-cpi) strategy. Pay per install. | When the `BiddingStrategyType` parameter is set to PAY_FOR_INSTALL || || `WeeklyClickPackage` | StrategyWeeklyClickPackageAdd | Parameters of the [Optimize clicks](https://yandex.com/support/direct/en/strategies/average-cpc) strategy. Limited by click package. | When the `BiddingStrategyType` parameter is set to WEEKLY_CLICK_PACKAGE || || **MobileAppCampaignNetworkStrategyAdd structure** || || `BiddingStrategyType` | MobileAppCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks: - NETWORK_DEFAULT - MAXIMUM_COVERAGE - WB_MAXIMUM_CLICKS - WB_MAXIMUM_APP_INSTALLS - AVERAGE_CPC - AVERAGE_CPI - WEEKLY_CLICK_PACKAGE - PAY_FOR_INSTALL - SERVING_OFF For information about the compatibility of strategies in search results and ad networks, see the section [Display strategies](https://yandex.com/dev/direct/doc/objects/campaign-strategies.html) | Yes || || `NetworkDefault` | StrategyNetworkDefaultAdd | Settings for impressions in ad networks based on the settings for search. If a search strategy other than HIGHEST_POSITION is selected, pass an empty structure. | When the `BiddingStrategyType` parameter is set to NETWORK_DEFAULT || || `WbMaximumClicks` | StrategyMaximumClicksAdd | Parameters of the [Optimize clicks](https://yandex.com/support/direct/en/strategies/weekly-budget.html) strategy. Limited by weekly budget. | When the `BiddingStrategyType` parameter is set to WB_MAXIMUM_CLICKS || || `WbMaximumAppInstalls` | StrategyMaximumAppInstallsAdd | Parameters of the [Optimize number of app installations](https://yandex.com/support/direct/en/strategies/weekly-budget.html) strategy, without specifying the average CPI. | When the `BiddingStrategyType` parameter is set to WB_MAXIMUM_APP_INSTALLS || || `AverageCpc` | StrategyAverageCpcAdd | Parameters of the [Optimize clicks](https://yandex.com/support/direct/en/strategies/average-cpc.html) strategy. Limited by average CPC. | When the `BiddingStrategyType` parameter is set to AVERAGE_CPC || || `AverageCpi` | StrategyAverageCpiAdd | Parameters of the [Optimize number of app installations](https://yandex.ru/support/direct/en/strategies/average-cpa-mobile-apps#fix-cpi) strategy. Maintain the average CPI. | When the `BiddingStrategyType` parameter is set to AVERAGE_CPI || || `PayForInstall` | StrategyPayForInstallAdd | Parameters of the [Optimize conversions](https://yandex.com/support/direct/en/strategies/average-cpa-mobile-apps.html#average-cpa-mobile-apps__fix-cpi) strategy. Pay per install. | When the `BiddingStrategyType` parameter is set to PAY_FOR_INSTALL || || `WeeklyClickPackage` | StrategyWeeklyClickPackageAdd | Parameters of the [Optimize clicks](https://yandex.ru/support/direct/en/strategies/average-cpc) strategy. Limited by click package. | When the `BiddingStrategyType` parameter is set to WEEKLY_CLICK_PACKAGE || || **StrategyMaximumClicksAdd structure** || || `WeeklySpendLimit` | long | The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. | Yes || || `BidCeiling` | long | The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. {% note info %} We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy. {% endnote %} | No || || **StrategyMaximumAppInstallsAdd structure** || || `WeeklySpendLimit` | long | The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. | Yes || || `BidCeiling` | long | The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. {% note info %} We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy. {% endnote %} | No || || **StrategyAverageCpcAdd structure** || || `AverageCpc` | long | The average CPC in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. | Yes || || `WeeklySpendLimit` | long | The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. | No || || `CustomPeriodBudget` | CustomPeriodBudget | Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.com/support/direct/en/strategies/budgets-in-strategies.html). When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`. | No || || **StrategyAverageCpiAdd structure** || || `AverageCpi` | long | The average cost per app install in the user's currency, multiplied by 1,000,000. The minimum acceptable value is shown in the section [Currency parameters and limits](https://yandex.com/dev/direct/doc/objects/campaign.html). | Yes || || `WeeklySpendLimit` | long | The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. | No || || `CustomPeriodBudget` | CustomPeriodBudget | Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.com/support/direct/en/strategies/budgets-in-strategies.html). When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`. | No || || `BidCeiling` | long | The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. {% note info %} We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy. {% endnote %} | No || || **StrategyPayForInstallAdd structure** || || `AverageCpi` | long | Cost per app install in the user's currency, multiplied by 1,000,000. The minimum and maximum acceptable values are shown in [Currency parameters and restrictions](https://yandex.com/dev/direct/doc/objects/campaign.html). | Yes || || `WeeklySpendLimit` | long | The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. | No || || `CustomPeriodBudget` | CustomPeriodBudget | Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.com/support/direct/en/strategies/budgets-in-strategies.html). When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`. | No || || **StrategyWeeklyClickPackageAdd structure** || || `ClicksPerWeek` | long | Desired number of clicks per week. | Yes || || `AverageCpc` | long | The average CPC in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. {% note info %} The `AverageCpc` and `BidCeiling` parameters are mutually exclusive. You can't specify both of them. {% endnote %} | No || || `BidCeiling` | long | The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method. {% note info %} We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy. {% endnote %} | No || || **StrategyNetworkDefaultAdd structure** || || `LimitPercent` | int | The 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. If a search strategy other than HIGHEST_POSITION is selected, the parameter is not used and the passed value is ignored. | No || || **CustomPeriodBudget structure** || || `SpendLimit` | long | Budget size for a custom period. | Yes || || `StartDate` | string | Start of the budget period. | Yes || || `EndDate` | string | End of the budget period. | Yes || || `AutoContinue` | YesNoEnum | Flag to autocontinue the budget period. | Yes || |#