get: MobileAppCampaign parameters
Response structure in JSON format:
{
"result": {
"Campaigns": [{ /* CampaignGetItem */
...
"MobileAppCampaign": { /* MobileAppCampaignGetItem */
"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": {
"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 */
"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": [{ /* MobileAppCampaignSettingGet */
"Option": ( "ADD_TO_FAVORITES" | ... | "SHARED_ACCOUNT_ENABLED" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"PackageBiddingStrategy" : { /* nillable */
"StrategyId" : (long), /* required */
},
"CanBeUsedAsPackageBiddingStrategySource" : ( "YES" | "NO" ),
"NegativeKeywordSharedSetIds" : { /* nillable */
"Items" : [ (long) ] /* required */
},
}
}
}, ... ],
"LimitedBy": (long)
}
}
Parameter | Type | Description |
MobileAppCampaignGetItem structure | ||
---|---|---|
Settings | array of MobileAppCampaignSettingGet | Array of settings that only accept the values YES or NO. |
BiddingStrategy | MobileAppCampaignStrategy | Display strategy. |
PackageBiddingStrategy | MobileAppCampaignPackageBiddingStrategyGet, nillable, deprecated | Information about the portfolio strategy. Null (nil): The campaign is not part of the portfolio strategy. |
CanBeUsedAsPackageBiddingStrategySource | string, deprecated | Shows if the strategy for this campaign can be portfolio. |
NegativeKeywordSharedSetIds | ArrayOfLong, nillable | IDs of sets of negative keywords. Maximum of 3 items in the array. |
MobileAppCampaignSettingGet structure | ||
Option | MobileAppCampaignSettingsEnum | Setting name:
|
Value | YesNoEnum | Setting value. |
MobileAppCampaignPackageBiddingStrategyGet structure | ||
StrategyId | long | Portfolio strategy ID. |
MobileAppCampaignStrategy structure | ||
Search | MobileAppCampaignSearchStrategy | Display strategy in search results. |
Network | MobileAppCampaignNetworkStrategy | Display strategy in ad networks. |
MobileAppCampaignSearchStrategy structure | ||
BiddingStrategyType | MobileAppCampaignSearchStrategyTypeEnum | The type of display strategy in search results:
|
WbMaximumClicks | StrategyMaximumClicks | Parameters of the Optimize clicks strategy. Limit by weekly budget. |
WbMaximumAppInstalls | StrategyMaximumAppInstalls | Parameters of the Optimize number of app installations strategy without specifying the average CPI. |
AverageCpc | StrategyAverageCpc | Parameters of the Optimize clicks strategy. Limit by average CPC. |
WeeklyClickPackage | StrategyWeeklyClickPackage | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. |
AverageCpi | StrategyAverageCpi | Parameters of the Optimize number of app installations strategy and keep the average CPI. |
PayForInstall | StrategyPayForInstall | Parameters of the Optimizing conversions strategy. Pay per installation. |
MobileAppCampaignNetworkStrategy structure | ||
BiddingStrategyType | MobileAppCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks:
|
NetworkDefault Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | StrategyNetworkDefault | Settings for impressions in ad networks based on the settings for search. If a search strategy other than HIGHEST_POSITION is selected, this structure is not returned. |
WbMaximumClicks | StrategyMaximumClicks | Parameters of the Optimize clicks strategy. Limit by weekly budget. |
WbMaximumAppInstalls | StrategyMaximumAppInstalls | Parameters of the Optimize number of app installations strategy without specifying the average CPI. |
AverageCpc | StrategyAverageCpc | Parameters of the Optimize clicks strategy. Limit by average CPC. |
WeeklyClickPackage | StrategyWeeklyClickPackage | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. |
AverageCpi | StrategyAverageCpi | Parameters of the Optimize number of app installations strategy and keep the average CPI. |
PayForInstall | StrategyPayForInstall | Parameters of the Optimizing conversions strategy. Pay per installation. |
StrategyMaximumClicks 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. |
BidCeiling | long, nillable | 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. |
StrategyMaximumAppInstalls 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. |
BidCeiling | long, nillable | 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. |
StrategyAverageCpc 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. |
WeeklySpendLimit | long, nillable | 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. |
CustomPeriodBudget | CustomPeriodBudget | Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Type of budget:
|
StrategyAverageCpi structure | ||
AverageCpi | long | 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. |
WeeklySpendLimit | long, nillable | 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. |
CustomPeriodBudget | CustomPeriodBudget | Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Type of budget:
|
BidCeiling | long, nillable | 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. |
StrategyWeeklyClickPackage structure | ||
ClicksPerWeek | long | Desired number of clicks per week. |
AverageCpc | long, nillable | 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. |
BidCeiling | long, nillable | 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. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them. |
StrategyPayForInstall structure | ||
AverageCpi | long | Cost of an app installation in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum acceptable values are shown in Currency parameters and restrictions. |
WeeklySpendLimit | long, nillable | 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. |
CustomPeriodBudget | CustomPeriodBudget | Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Type of budget:
|
StrategyNetworkDefault 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. |
CustomPeriodBudget structure | ||
SpendLimit | long | Budget size for a custom period. |
StartDate | string | Start of the budget period. |
EndDate | string | End of the budget period. |
AutoContinue | YesNoEnum | Flag to autocontinue the budget period. |
Parameter | Type | Description |
MobileAppCampaignGetItem structure | ||
---|---|---|
Settings | array of MobileAppCampaignSettingGet | Array of settings that only accept the values YES or NO. |
BiddingStrategy | MobileAppCampaignStrategy | Display strategy. |
PackageBiddingStrategy | MobileAppCampaignPackageBiddingStrategyGet, nillable, deprecated | Information about the portfolio strategy. Null (nil): The campaign is not part of the portfolio strategy. |
CanBeUsedAsPackageBiddingStrategySource | string, deprecated | Shows if the strategy for this campaign can be portfolio. |
NegativeKeywordSharedSetIds | ArrayOfLong, nillable | IDs of sets of negative keywords. Maximum of 3 items in the array. |
MobileAppCampaignSettingGet structure | ||
Option | MobileAppCampaignSettingsEnum | Setting name:
|
Value | YesNoEnum | Setting value. |
MobileAppCampaignPackageBiddingStrategyGet structure | ||
StrategyId | long | Portfolio strategy ID. |
MobileAppCampaignStrategy structure | ||
Search | MobileAppCampaignSearchStrategy | Display strategy in search results. |
Network | MobileAppCampaignNetworkStrategy | Display strategy in ad networks. |
MobileAppCampaignSearchStrategy structure | ||
BiddingStrategyType | MobileAppCampaignSearchStrategyTypeEnum | The type of display strategy in search results:
|
WbMaximumClicks | StrategyMaximumClicks | Parameters of the Optimize clicks strategy. Limit by weekly budget. |
WbMaximumAppInstalls | StrategyMaximumAppInstalls | Parameters of the Optimize number of app installations strategy without specifying the average CPI. |
AverageCpc | StrategyAverageCpc | Parameters of the Optimize clicks strategy. Limit by average CPC. |
WeeklyClickPackage | StrategyWeeklyClickPackage | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. |
AverageCpi | StrategyAverageCpi | Parameters of the Optimize number of app installations strategy and keep the average CPI. |
PayForInstall | StrategyPayForInstall | Parameters of the Optimizing conversions strategy. Pay per installation. |
MobileAppCampaignNetworkStrategy structure | ||
BiddingStrategyType | MobileAppCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks:
|
NetworkDefault Restriction. The NETWORK_DEFAULT parameter is not supported for the HIGHEST_POSITION manual strategy. | StrategyNetworkDefault | Settings for impressions in ad networks based on the settings for search. If a search strategy other than HIGHEST_POSITION is selected, this structure is not returned. |
WbMaximumClicks | StrategyMaximumClicks | Parameters of the Optimize clicks strategy. Limit by weekly budget. |
WbMaximumAppInstalls | StrategyMaximumAppInstalls | Parameters of the Optimize number of app installations strategy without specifying the average CPI. |
AverageCpc | StrategyAverageCpc | Parameters of the Optimize clicks strategy. Limit by average CPC. |
WeeklyClickPackage | StrategyWeeklyClickPackage | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. |
AverageCpi | StrategyAverageCpi | Parameters of the Optimize number of app installations strategy and keep the average CPI. |
PayForInstall | StrategyPayForInstall | Parameters of the Optimizing conversions strategy. Pay per installation. |
StrategyMaximumClicks 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. |
BidCeiling | long, nillable | 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. |
StrategyMaximumAppInstalls 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. |
BidCeiling | long, nillable | 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. |
StrategyAverageCpc 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. |
WeeklySpendLimit | long, nillable | 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. |
CustomPeriodBudget | CustomPeriodBudget | Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Type of budget:
|
StrategyAverageCpi structure | ||
AverageCpi | long | 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. |
WeeklySpendLimit | long, nillable | 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. |
CustomPeriodBudget | CustomPeriodBudget | Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Type of budget:
|
BidCeiling | long, nillable | 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. |
StrategyWeeklyClickPackage structure | ||
ClicksPerWeek | long | Desired number of clicks per week. |
AverageCpc | long, nillable | 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. |
BidCeiling | long, nillable | 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. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them. |
StrategyPayForInstall structure | ||
AverageCpi | long | Cost of an app installation in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum acceptable values are shown in Currency parameters and restrictions. |
WeeklySpendLimit | long, nillable | 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. |
CustomPeriodBudget | CustomPeriodBudget | Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and WeeklySpendLimit. |
BudgetType | BudgetTypeEnum | Type of budget:
|
StrategyNetworkDefault 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. |
CustomPeriodBudget structure | ||
SpendLimit | long | Budget size for a custom period. |
StartDate | string | Start of the budget period. |
EndDate | string | End of the budget period. |
AutoContinue | YesNoEnum | Flag to autocontinue the budget period. |