update: MobileAppCampaign parameters

Request structure in JSON format:

{
  "method": "update",
  "params": {
    "Campaigns": [{  /* CampaignUpdateItem */
      ...
      "MobileAppCampaign": {  /* MobileAppCampaignUpdateItem */
        "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": { /* nillable */
                "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 */
              "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 */,
            }
          }
        },
        "Settings": [{  /* MobileAppCampaignSetting */
          "Option": ( "ADD_TO_FAVORITES" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }
    }, ....] /* required */
  }
}

Parameter	Type	Description	Required
MobileAppCampaignUpdateItem structure
`Settings`	array of MobileAppCampaignSetting	Array of settings that only accept the values YES or NO.	No
`BiddingStrategy`	MobileAppCampaignStrategy	Display strategy.	No
`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.get method.	No
MobileAppCampaignSetting structure
`Option`	MobileAppCampaignSettingsEnum	Setting name: ADD_TO_FAVORITES ENABLE_AREA_OF_INTEREST_TARGETING MAINTAIN_NETWORK_CPC REQUIRE_SERVICING	Yes
`Value`	YesNoEnum	Setting value.	Yes
MobileAppCampaignStrategy structure
`Search`	MobileAppCampaignSearchStrategy	Display strategy in search results.	No
`Network`	MobileAppCampaignNetworkStrategy	Display strategy in ad networks.	No
MobileAppCampaignSearchStrategy 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.	Yes
`WbMaximumClicks`	StrategyMaximumClicks	Parameters of the Optimize clicks strategy. Limited by weekly budget.	When the `BiddingStrategyType` parameter is set to WB_MAXIMUM_CLICKS
`WbMaximumAppInstalls`	StrategyMaximumAppInstalls	Parameters of the Optimize number of app installations strategy, without specifying the average CPI.	When the `BiddingStrategyType` parameter is set to WB_MAXIMUM_APP_INSTALLS
`AverageCpc`	StrategyAverageCpc	Parameters of the Optimize clicks strategy. Limited by average CPC.	When the `BiddingStrategyType` parameter is set to AVERAGE_CPC
`WeeklyClickPackage`	StrategyWeeklyClickPackage	Parameters of the Optimize clicks strategy. Limited by click package.	When the `BiddingStrategyType` parameter is set to WEEKLY_CLICK_PACKAGE
`AverageCpi`	StrategyAverageCpi	Parameters of the Optimize number of app installations strategy. Maintain the average CPI.	When the `BiddingStrategyType` parameter is set to AVERAGE_CPI
`PayForInstall`	StrategyPayForInstall	Parameters of the Optimize conversions strategy. Pay per install.	When the `BiddingStrategyType` parameter is set to PAY_FOR_INSTALL
MobileAppCampaignNetworkStrategy 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	Yes
`NetworkDefault`	StrategyNetworkDefault	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`	StrategyMaximumClicks	Parameters of the Optimize clicks strategy. Limited by weekly budget.	When the `BiddingStrategyType` parameter is set to WB_MAXIMUM_CLICKS
`WbMaximumAppInstalls`	StrategyMaximumAppInstalls	Parameters of the Optimize number of app installations strategy, without specifying the average CPI.	When the `BiddingStrategyType` parameter is set to WB_MAXIMUM_APP_INSTALLS
`AverageCpc`	StrategyAverageCpc	Parameters of the Optimize clicks strategy. Limited by average CPC.	When the `BiddingStrategyType` parameter is set to AVERAGE_CPC
`WeeklyClickPackage`	StrategyWeeklyClickPackage	Parameters of the Optimize clicks strategy. Limited by click package.	When the `BiddingStrategyType` parameter is set to WEEKLY_CLICK_PACKAGE
`AverageCpi`	StrategyAverageCpi	Parameters of the Optimize number of app installations strategy. Maintain the average CPI.	When the `BiddingStrategyType` parameter is set to AVERAGE_CPI
`PayForInstall`	StrategyPayForInstall	Parameters of the Optimize conversions strategy. Pay per install.	When the `BiddingStrategyType` parameter is set to PAY_FOR_INSTALL
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.	No
`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.	No
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.	No
`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`.	No
`BudgetType`	BudgetTypeEnum	Type of budget: WEEKLY_BUDGET — Weekly budget. CUSTOM_PERIOD_BUDGET — Budget for a custom period. If the budget type is changed while editing the campaign, the original type must be passed with a NULL value. For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.	No
`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.	No
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.	No
`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.	No
`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`.	No
`BudgetType`	BudgetTypeEnum	Type of budget: WEEKLY_BUDGET — Weekly budget. CUSTOM_PERIOD_BUDGET — Budget for a custom period. If the budget type is changed while editing the campaign, the original type must be passed with a NULL value. For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.	No
StrategyAverageCpi 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.	No
`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.	No
`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`.	No
`BudgetType`	BudgetTypeEnum	Type of budget: WEEKLY_BUDGET — Weekly budget. CUSTOM_PERIOD_BUDGET — Budget for a custom period. If the budget type is changed while editing the campaign, the original type must be passed with a NULL value. For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.	No
`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.	No
StrategyPayForInstall 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.	No
`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.	No
`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`.	No
`BudgetType`	BudgetTypeEnum	Type of budget: WEEKLY_BUDGET — Weekly budget. CUSTOM_PERIOD_BUDGET — Budget for a custom period. If the budget type is changed while editing the campaign, the original type must be passed with a NULL value. For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.	No
StrategyWeeklyClickPackage structure
`ClicksPerWeek`	long	Desired number of clicks per week.	No
`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. If you've previously specified the `BidCeiling` parameter and now you want to set `AverageCpc`, simultaneously pass null (nil) for `BidCeiling`.	No
`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. If you've previously specified the `AverageCpc` parameter and now you want to set `BidCeiling`, simultaneously pass null (nil) for `AverageCpc`.	No
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. If the strategy changes and this parameter if not specified, the default value is used — 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

Was the article helpful?

update: DynamicTextCampaign parameters

update: CpmBannerCampaign parameters