add: TextCampaign parameters
Manual bid management will be disabled for the Yandex Advertising Network. Learn more.
- Starting April 22, 2024, you will no longer be able to create new campaigns with a manual strategy. The "Network.BiddingStrategyType" parameter in the "add" and "update" methods will no longer support the MAXIMUM_COVERAGE strategy for TextCampaign and MobileAppCampaign campaigns. These campaigns will also cease to support the "resume" method. Attempting to use it will result in a validation error.
- Starting May 20, 2024, you will no longer be able to edit bids in active campaigns: the "set" method will no longer support the "Bids.ContextBid (KeywordBids.NetworkBid)" parameter. Attempting to use it will result in a validation error.
- In June, 2024, active campaigns will be stopped. Attempting to use the "resume" method for campaigns with the MAXIMUM_COVERAGE strategy specified in the "Network.BiddingStrategyType" parameter will return a validation error unless you switch to an available strategy. In the future, the strategy for these stopped and archived campaigns will be changed to "WB_MAXIMUM_CLICKS" (the campaigns themselves won't be re-launched or unarchived).
Request structure in JSON format:
{
"method": "add",
"params": {
"Campaigns": [{ /* CampaignAddItem */
...
"TextCampaign": { /* TextCampaignAddItem */
"BiddingStrategy": { /* TextCampaignStrategyAdd */
"Search": { /* TextCampaignSearchStrategyAdd */
"BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
"PlacementTypes" : {
"SearchResults" : ( "YES" | "NO" ),
"ProductGallery" : ( "YES" | "NO" )
},
"WbMaximumClicks": { /* StrategyMaximumClicksAdd */
"WeeklySpendLimit": (long), /* required */
"BidCeiling": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"WbMaximumConversionRate": { /* StrategyMaximumConversionRateAdd */
"WeeklySpendLimit": (long), /* required */
"BidCeiling": (long),
"GoalId": (long), /* required */
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCpc": { /* StrategyAverageCpcAdd */
"AverageCpc": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCpa": { /* StrategyAverageCpaAdd */
"AverageCpa": (long), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BidCeiling": (long),
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"WeeklyClickPackage": { /* StrategyWeeklyClickPackageAdd */
"ClicksPerWeek": (long), /* required */
"AverageCpc": (long),
"BidCeiling": (long)
},
"AverageRoi": { /* StrategyAverageRoiAdd */
"ReserveReturn": (int), /* required */
"RoiCoef": (long), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BidCeiling": (long),
"Profitability": (long),
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCrr": { /* StrategyAverageCrrAdd */
"Crr": (int), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionCrr" : { /* StrategyPayForConversionCrrAdd */
"Crr": (int), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"PayForConversion" : { /* StrategyPayForConversionAdd */
"Cpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
}
}, /* required */
"Network": { /* TextCampaignNetworkStrategyAdd */
"BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
"NetworkDefault": { /* StrategyNetworkDefaultAdd */
"LimitPercent": (int)
},
"WbMaximumClicks": { /* StrategyMaximumClicksAdd */
"WeeklySpendLimit": (long), /* required */
"BidCeiling": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
},
"WbMaximumConversionRate": { /* StrategyMaximumConversionRateAdd */
"WeeklySpendLimit": (long), /* required */
"BidCeiling": (long),
"GoalId": (long), /* required */
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
},
"AverageCpc": { /* StrategyAverageCpcAdd */
"AverageCpc": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCpa": { /* StrategyAverageCpaAdd */
"AverageCpa": (long), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BidCeiling": (long),
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"WeeklyClickPackage": { /* StrategyWeeklyClickPackageAdd */
"ClicksPerWeek": (long), /* required */
"AverageCpc": (long),
"BidCeiling": (long)
},
"AverageRoi": { /* StrategyAverageRoiAdd */
"ReserveReturn": (int), /* required */
"RoiCoef": (long), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BidCeiling": (long),
"Profitability": (long),
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCrr": { /* StrategyAverageCrrAdd */
"Crr": (int), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionCrr" : { /* StrategyPayForConversionCrrAdd */
"Crr": (int), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"PayForConversion" : { /* StrategyPayForConversionAdd */
"Cpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
}
} /* required */
}, /* required */
"Settings": [{ /* TextCampaignSetting */
"Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"CounterIds": { /* ArrayOfInteger */
"Items": [(int), ... ] /* required */
},
"RelevantKeywords": { /* RelevantKeywordsSettingAdd */
"BudgetPercent": (int), /* required */
"OptimizeGoalId": (long) /* nillable */
},
"PriorityGoals": { /* PriorityGoalsArray */
"Items": [{ /* PriorityGoalsItem */
"GoalId": (long), /* required */
"Value": (long), /* required */
"IsMetrikaSourceOfValue": ( "YES" | "NO" )
}, ... ] /* required */
},
"TrackingParams": (string),
"AttributionModel": ( "FC" | "LC" | "LSC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
"PackageBiddingStrategy": { /* TextCampaignPackageBiddingStrategyAdd */
"StrategyId": (long),
"StrategyFromCampaignId": (long),
"Platforms" : { /* required */
"SearchResult" : ( "YES" | "NO" ) /* required */,
"ProductGallery" : ( "YES" | "NO" ) /* required */,
"Network" : ( "YES" | "NO" ) /* required */
}
},
"NegativeKeywordSharedSetIds" : { /* nillable */
"Items" : [ (long) ] /* required */
}
}, ... ] /* required */
}
}
}
Parameter | Type | Description | Required |
TextCampaignAddItem structure | |||
---|---|---|---|
BiddingStrategy | TextCampaignStrategyAdd | Display strategy. | No if PackageBiddingStrategy is specified |
Settings | array of TextCampaignSetting | Array of settings that only accept the values YES or NO. | No |
CounterIds | ArrayOfInteger | The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). | No |
RelevantKeywords | RelevantKeywordsSettingAdd | Settings for displays for related keywords (see Impressions for related keywords in the Help for Yandex Direct). If this structure is omitted, displays for related keywords are disabled. Restriction. The parameter is deprecated and no longer supported. | No |
PriorityGoals | PriorityGoalsArray | Priority goals for automatic bid adjustments. If the array is omitted, automatic bid adjustments are used for obtaining the maximum number of engaged sessions (see Engaged session figures in the Help for Yandex Direct). You can't add more than 30 priority goals. | No |
TrackingParams | string | URL parameters for templates. | No |
AttributionModel | AttributionModelEnum | The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct). Possible values:
The default value is AUTO. | No |
PackageBiddingStrategy | TextCampaignPackageBiddingStrategyAdd | Links a campaign to the specified strategy. You can't pass the following parameters in this field:
To pass those parameters, unlink the campaign from the portfolio strategy by specifying a new value for BiddingStrategy and resetting the PackageBiddingStrategy: null parameter value. | No if BiddingStrategy is specified |
NegativeKeywordSharedSetIds | ArrayOfLong | 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 |
TextCampaignSetting structure | |||
Option | TextCampaignSettingsEnum | Setting name:
| Yes |
| No | ||
Value | YesNoEnum | Setting value. | Yes |
RelevantKeywordsSettingAdd structure | |||
BudgetPercent | int | Maximum percent of the budget to be spent on clicks on related keywords (from 1 to 100). | Yes |
OptimizeGoalId | long, nillable | The ID of a Yandex Metrica goal for optimizing related keywords. You can't set a specific goal during campaign creation. The following values are allowed:
If the parameter is omitted, the default value is 0. | No |
TextCampaignPackageBiddingStrategyAdd structure | |||
StrategyId | long | Portfolio strategy ID. | No |
StrategyFromCampaignId | long | ID of the campaign the portfolio strategy was created from. | No |
Platforms | TextCampaignPlatforms | Ad placement platform. | Yes |
PriorityGoalsArray structure | |||
Items | array of PriorityGoalsItem | A set of priority goals and corresponding conversion values. | Yes |
PriorityGoalsItem structure | |||
GoalId | long | ID of a Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. A value of 12 corresponds to the goal “Engaged sessions”. | Yes |
Value | long | The conversion value is a monetary estimation of the advertiser's profit when when the goal is completed, in the advertiser's currency, multiplied by 1,000,000. The higher the conversion value, the higher the priority to achieve conversions for this goal. | Yes |
IsMetrikaSourceOfValue | YesNoEnum | Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio. | If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR |
TextCampaignPlatforms structure | |||
SearchResult | YesNoEnum | Search results. | Yes |
ProductGallery | YesNoEnum | Product gallery. | Yes |
Network | YesNoEnum | Yandex Advertising Network. | Yes |
TextCampaignStrategyAdd structure | |||
Search | TextCampaignSearchStrategyAdd | Display strategy in search results. | Yes |
Network | TextCampaignNetworkStrategyAdd | Display strategy in ad networks. | Yes |
TextCampaignSearchStrategyAdd structure | |||
BiddingStrategyType | TextCampaignSearchStrategyTypeEnum | 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 |
PlacementTypes | TextCampaignSearchStrategyPlacementTypes | Placements in search results. | No |
WbMaximumClicks | StrategyMaximumClicksAdd | Parameters of the Optimize clicks strategy. Limit by weekly budget. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Parameters of the Optimize conversions strategy without specifying the average CPA. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpa | StrategyAverageCpaAdd | Parameters of the Optimize conversions strategy and keep the average CPA. | When the BiddingStrategyType parameter has the value AVERAGE_CPA |
AverageRoi | StrategyAverageRoiAdd | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrrAdd | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR |
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 |
PayForConversion | StrategyPayForConversionAdd | Parameters of the Optimizing conversions strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION |
TextCampaignNetworkStrategyAdd structure | |||
BiddingStrategyType | TextCampaignNetworkStrategyTypeEnum | 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 |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Parameters of the Optimize conversions strategy without specifying the average CPA. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpa | StrategyAverageCpaAdd | Parameters of the Optimize conversions strategy and keep the average CPA. | When the BiddingStrategyType parameter has the value AVERAGE_CPA |
AverageRoi | StrategyAverageRoiAdd | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrrAdd | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversion | StrategyPayForConversionAdd | Parameters of the Optimizing conversions strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR |
WeeklyClickPackage Restriction. The parameter is deprecated and no longer supported. | 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 |
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 |
TextCampaignSearchStrategyPlacementTypes structure | |||
SearchResults | YesNoEnum | Search results. | No |
ProductGallery | YesNoEnum | Product gallery. | No |
StrategyMaximumConversionRateAdd 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 |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
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 |
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 |
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 |
StrategyAverageCpaAdd structure | |||
AverageCpa | long | The average cost of a conversion (CPA) 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 |
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 |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings). To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageRoiAdd structure | |||
ReserveReturn | int | The maximum percent of saved funds that can be returned to advertising (spent) if the forecasted return on investment exceeds the value of the RoiCoef parameter. A value from 0 to 100 as a multiple of ten: 0, 10, 20... 100. | Yes |
RoiCoef | long | The desired average return on investment per week. The value represents the ratio between sales profits and ad costs multiplied by 1,000,000. The value must be an integer. If the value is not a multiple of 10,000, the last four digits are reset to zero, which is the same as discarding extra decimal digits. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
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 |
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 |
Profitability | long | The percentage of revenue that is the cost value of products or services. The value is a percent multiplied by 1,000,000. The value must be an integer from 0 to 100,000,000 (which equals 100%). If the value is not a multiple of 10,000, the last four digits are reset to zero, which is the same as discarding extra decimal digits. | No |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings). To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageCrrAdd structure | |||
Crr | int | Average cost revenue ratio. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings). To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyPayForConversionAdd structure | |||
Cpa | long | Cost of a conversion (CPA) in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum CPA values are listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
WeeklySpendLimit | long | The weekly budget in the advertiser's currency, multiplied by 1,000,000. The minimum weekly budget for each currency must be at least the value of the Cpaparameter, multiplied by 20. 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 |
StrategyPayForConversionCrrAdd structure | |||
Crr | int | Average cost revenue ratio. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
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 |
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. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them. | 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 |
ExplorationBudget structure | |||
MinimumExplorationBudget | long | Minimum budget value. Acceptable value: between 0 and the weekly budget (if set). | Yes, if the request includes the ExplorationBudget structure. |
IsMinimumExplorationBudgetCustom | YesNoEnum | A flag indicating a custom minimum budget. | Yes, if the request includes the ExplorationBudget structure. |
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 |
Parameter | Type | Description | Required |
TextCampaignAddItem structure | |||
---|---|---|---|
BiddingStrategy | TextCampaignStrategyAdd | Display strategy. | No if PackageBiddingStrategy is specified |
Settings | array of TextCampaignSetting | Array of settings that only accept the values YES or NO. | No |
CounterIds | ArrayOfInteger | The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). | No |
RelevantKeywords | RelevantKeywordsSettingAdd | Settings for displays for related keywords (see Impressions for related keywords in the Help for Yandex Direct). If this structure is omitted, displays for related keywords are disabled. Restriction. The parameter is deprecated and no longer supported. | No |
PriorityGoals | PriorityGoalsArray | Priority goals for automatic bid adjustments. If the array is omitted, automatic bid adjustments are used for obtaining the maximum number of engaged sessions (see Engaged session figures in the Help for Yandex Direct). You can't add more than 30 priority goals. | No |
TrackingParams | string | URL parameters for templates. | No |
AttributionModel | AttributionModelEnum | The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct). Possible values:
The default value is AUTO. | No |
PackageBiddingStrategy | TextCampaignPackageBiddingStrategyAdd | Links a campaign to the specified strategy. You can't pass the following parameters in this field:
To pass those parameters, unlink the campaign from the portfolio strategy by specifying a new value for BiddingStrategy and resetting the PackageBiddingStrategy: null parameter value. | No if BiddingStrategy is specified |
NegativeKeywordSharedSetIds | ArrayOfLong | 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 |
TextCampaignSetting structure | |||
Option | TextCampaignSettingsEnum | Setting name:
| Yes |
| No | ||
Value | YesNoEnum | Setting value. | Yes |
RelevantKeywordsSettingAdd structure | |||
BudgetPercent | int | Maximum percent of the budget to be spent on clicks on related keywords (from 1 to 100). | Yes |
OptimizeGoalId | long, nillable | The ID of a Yandex Metrica goal for optimizing related keywords. You can't set a specific goal during campaign creation. The following values are allowed:
If the parameter is omitted, the default value is 0. | No |
TextCampaignPackageBiddingStrategyAdd structure | |||
StrategyId | long | Portfolio strategy ID. | No |
StrategyFromCampaignId | long | ID of the campaign the portfolio strategy was created from. | No |
Platforms | TextCampaignPlatforms | Ad placement platform. | Yes |
PriorityGoalsArray structure | |||
Items | array of PriorityGoalsItem | A set of priority goals and corresponding conversion values. | Yes |
PriorityGoalsItem structure | |||
GoalId | long | ID of a Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. A value of 12 corresponds to the goal “Engaged sessions”. | Yes |
Value | long | The conversion value is a monetary estimation of the advertiser's profit when when the goal is completed, in the advertiser's currency, multiplied by 1,000,000. The higher the conversion value, the higher the priority to achieve conversions for this goal. | Yes |
IsMetrikaSourceOfValue | YesNoEnum | Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio. | If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR |
TextCampaignPlatforms structure | |||
SearchResult | YesNoEnum | Search results. | Yes |
ProductGallery | YesNoEnum | Product gallery. | Yes |
Network | YesNoEnum | Yandex Advertising Network. | Yes |
TextCampaignStrategyAdd structure | |||
Search | TextCampaignSearchStrategyAdd | Display strategy in search results. | Yes |
Network | TextCampaignNetworkStrategyAdd | Display strategy in ad networks. | Yes |
TextCampaignSearchStrategyAdd structure | |||
BiddingStrategyType | TextCampaignSearchStrategyTypeEnum | 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 |
PlacementTypes | TextCampaignSearchStrategyPlacementTypes | Placements in search results. | No |
WbMaximumClicks | StrategyMaximumClicksAdd | Parameters of the Optimize clicks strategy. Limit by weekly budget. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Parameters of the Optimize conversions strategy without specifying the average CPA. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpa | StrategyAverageCpaAdd | Parameters of the Optimize conversions strategy and keep the average CPA. | When the BiddingStrategyType parameter has the value AVERAGE_CPA |
AverageRoi | StrategyAverageRoiAdd | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrrAdd | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR |
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 |
PayForConversion | StrategyPayForConversionAdd | Parameters of the Optimizing conversions strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION |
TextCampaignNetworkStrategyAdd structure | |||
BiddingStrategyType | TextCampaignNetworkStrategyTypeEnum | 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 |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Parameters of the Optimize conversions strategy without specifying the average CPA. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpa | StrategyAverageCpaAdd | Parameters of the Optimize conversions strategy and keep the average CPA. | When the BiddingStrategyType parameter has the value AVERAGE_CPA |
AverageRoi | StrategyAverageRoiAdd | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrrAdd | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversion | StrategyPayForConversionAdd | Parameters of the Optimizing conversions strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR |
WeeklyClickPackage Restriction. The parameter is deprecated and no longer supported. | 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 |
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 |
TextCampaignSearchStrategyPlacementTypes structure | |||
SearchResults | YesNoEnum | Search results. | No |
ProductGallery | YesNoEnum | Product gallery. | No |
StrategyMaximumConversionRateAdd 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 |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
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 |
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 |
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 |
StrategyAverageCpaAdd structure | |||
AverageCpa | long | The average cost of a conversion (CPA) 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 |
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 |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings). To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageRoiAdd structure | |||
ReserveReturn | int | The maximum percent of saved funds that can be returned to advertising (spent) if the forecasted return on investment exceeds the value of the RoiCoef parameter. A value from 0 to 100 as a multiple of ten: 0, 10, 20... 100. | Yes |
RoiCoef | long | The desired average return on investment per week. The value represents the ratio between sales profits and ad costs multiplied by 1,000,000. The value must be an integer. If the value is not a multiple of 10,000, the last four digits are reset to zero, which is the same as discarding extra decimal digits. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
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 |
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 |
Profitability | long | The percentage of revenue that is the cost value of products or services. The value is a percent multiplied by 1,000,000. The value must be an integer from 0 to 100,000,000 (which equals 100%). If the value is not a multiple of 10,000, the last four digits are reset to zero, which is the same as discarding extra decimal digits. | No |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings). To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageCrrAdd structure | |||
Crr | int | Average cost revenue ratio. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings). To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyPayForConversionAdd structure | |||
Cpa | long | Cost of a conversion (CPA) in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum CPA values are listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
WeeklySpendLimit | long | The weekly budget in the advertiser's currency, multiplied by 1,000,000. The minimum weekly budget for each currency must be at least the value of the Cpaparameter, multiplied by 20. 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 |
StrategyPayForConversionCrrAdd structure | |||
Crr | int | Average cost revenue ratio. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
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 |
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. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them. | 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 |
ExplorationBudget structure | |||
MinimumExplorationBudget | long | Minimum budget value. Acceptable value: between 0 and the weekly budget (if set). | Yes, if the request includes the ExplorationBudget structure. |
IsMinimumExplorationBudgetCustom | YesNoEnum | A flag indicating a custom minimum budget. | Yes, if the request includes the ExplorationBudget structure. |
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 |