add: MobileAppCampaign parameters
In 2023, we are going to disable manual bid management in YAN. Follow our news.
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)
},
"PayForInstall" : { /* StrategyPayForInstallAdd */
"AverageCpi" : (long) /* required */,
"WeeklySpendLimit" : (long)
}
}, /* 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)
},
"AverageCpi": { /* StrategyAverageCpiAdd */
"AverageCpi": (long), /* required */
"WeeklySpendLimit": (long),
"BidCeiling": (long)
},
"WeeklyClickPackage": { /* StrategyWeeklyClickPackageAdd */
"ClicksPerWeek": (long), /* required */
"AverageCpc": (long),
"BidCeiling": (long)
},
"PayForInstall" : { /* StrategyPayForInstallAdd */
"AverageCpi" : (long) /* required */,
"WeeklySpendLimit" : (long)
}
} /* required */
}, /* required */
"Settings": [{ /* MobileAppCampaignSetting */
"Option": ( "ADD_TO_FAVORITES" | ... | "REQUIRE_SERVICING" ), /* required */
"Value": ( "YES" | "NO" ) /* 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 |
MobileAppCampaignSetting structure | |||
Option | MobileAppCampaignSettingsEnum | Setting name:
| Yes |
| 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:
For information about the compatibility of strategies in search results and ad networks, see the section Display strategies. | Yes |
WbMaximumClicks | StrategyMaximumClicksAdd | Parameters of the Optimize clicks strategy. Limit by weekly budget. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS |
WbMaximumAppInstalls | StrategyMaximumAppInstallsAdd | Parameters of the Optimize number of app installations strategy without specifying the average CPI. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_APP_INSTALLS |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpi | StrategyAverageCpiAdd | Parameters of the Optimize number of app installations strategy and keep the average CPI. | When the BiddingStrategyType parameter has the value AVERAGE_CPI |
PayForInstall | StrategyPayForInstallAdd | Parameters of the Optimizing conversions strategy. Pay per installation. | If the BiddingStrategyType parameter is set to PAY_FOR_INSTALL |
WeeklyClickPackage | StrategyWeeklyClickPackageAdd | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. | When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE |
MobileAppCampaignNetworkStrategyAdd structure | |||
BiddingStrategyType | MobileAppCampaignNetworkStrategyTypeEnum | 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 |
NetworkDefault Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | 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 has the value NETWORK_DEFAULT |
WbMaximumClicks | StrategyMaximumClicksAdd | Parameters of the Optimize clicks strategy. Limit by weekly budget. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS |
WbMaximumAppInstalls | StrategyMaximumAppInstallsAdd | Parameters of the Optimize number of app installations strategy without specifying the average CPI. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_APP_INSTALLS |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpi | StrategyAverageCpiAdd | Parameters of the Optimize number of app installations strategy and keep the average CPI. | When the BiddingStrategyType parameter has the value AVERAGE_CPI |
PayForInstall | StrategyPayForInstallAdd | Parameters of the Optimizing conversions strategy. Pay per installation. | If the BiddingStrategyType parameter is set to PAY_FOR_INSTALL |
WeeklyClickPackage | StrategyWeeklyClickPackageAdd | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. | When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE |
StrategyMaximumClicksAdd structure | |||
WeeklySpendLimit | long | 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 |
BidCeiling | long | 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 | |||
WeeklySpendLimit | long | 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 |
BidCeiling | long | 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 | |||
AverageCpc | long | 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 |
WeeklySpendLimit | long | 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 | |||
AverageCpi | long | The average cost per app install in the advertiser's currency, multiplied by 1,000,000. The minimum acceptable value is shown in the section Currency parameters and limits. | Yes |
WeeklySpendLimit | long | 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 |
BidCeiling | long | 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 |
StrategyPayForInstallAdd structure | |||
AverageCpi | long | Cost per app install in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum acceptable values are shown in Currency parameters and restrictions. | Yes |
WeeklySpendLimit | long | 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 |
StrategyWeeklyClickPackageAdd structure | |||
ClicksPerWeek | long | Desired number of clicks per week. | Yes |
AverageCpc | long | 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 |
BidCeiling | long | 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 | |||
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 |
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 |
MobileAppCampaignSetting structure | |||
Option | MobileAppCampaignSettingsEnum | Setting name:
| Yes |
| 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:
For information about the compatibility of strategies in search results and ad networks, see the section Display strategies. | Yes |
WbMaximumClicks | StrategyMaximumClicksAdd | Parameters of the Optimize clicks strategy. Limit by weekly budget. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS |
WbMaximumAppInstalls | StrategyMaximumAppInstallsAdd | Parameters of the Optimize number of app installations strategy without specifying the average CPI. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_APP_INSTALLS |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpi | StrategyAverageCpiAdd | Parameters of the Optimize number of app installations strategy and keep the average CPI. | When the BiddingStrategyType parameter has the value AVERAGE_CPI |
PayForInstall | StrategyPayForInstallAdd | Parameters of the Optimizing conversions strategy. Pay per installation. | If the BiddingStrategyType parameter is set to PAY_FOR_INSTALL |
WeeklyClickPackage | StrategyWeeklyClickPackageAdd | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. | When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE |
MobileAppCampaignNetworkStrategyAdd structure | |||
BiddingStrategyType | MobileAppCampaignNetworkStrategyTypeEnum | 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 |
NetworkDefault Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | 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 has the value NETWORK_DEFAULT |
WbMaximumClicks | StrategyMaximumClicksAdd | Parameters of the Optimize clicks strategy. Limit by weekly budget. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS |
WbMaximumAppInstalls | StrategyMaximumAppInstallsAdd | Parameters of the Optimize number of app installations strategy without specifying the average CPI. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_APP_INSTALLS |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpi | StrategyAverageCpiAdd | Parameters of the Optimize number of app installations strategy and keep the average CPI. | When the BiddingStrategyType parameter has the value AVERAGE_CPI |
PayForInstall | StrategyPayForInstallAdd | Parameters of the Optimizing conversions strategy. Pay per installation. | If the BiddingStrategyType parameter is set to PAY_FOR_INSTALL |
WeeklyClickPackage | StrategyWeeklyClickPackageAdd | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. | When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE |
StrategyMaximumClicksAdd structure | |||
WeeklySpendLimit | long | 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 |
BidCeiling | long | 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 | |||
WeeklySpendLimit | long | 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 |
BidCeiling | long | 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 | |||
AverageCpc | long | 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 |
WeeklySpendLimit | long | 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 | |||
AverageCpi | long | The average cost per app install in the advertiser's currency, multiplied by 1,000,000. The minimum acceptable value is shown in the section Currency parameters and limits. | Yes |
WeeklySpendLimit | long | 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 |
BidCeiling | long | 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 |
StrategyPayForInstallAdd structure | |||
AverageCpi | long | Cost per app install in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum acceptable values are shown in Currency parameters and restrictions. | Yes |
WeeklySpendLimit | long | 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 |
StrategyWeeklyClickPackageAdd structure | |||
ClicksPerWeek | long | Desired number of clicks per week. | Yes |
AverageCpc | long | 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 |
BidCeiling | long | 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 | |||
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 |