update: SmartCampaign parameters
Request structure in JSON format:
{
"method": "update",
"params": {
"Campaigns": [{ /* CampaignUpdateItem */
...
"SmartCampaign": { /* SmartCampaignUpdateItem */
"CounterId": (long),
"TrackingParams" : (string),
"AttributionModel": ( "LC" | "LSC" | "FC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
"BiddingStrategy": { /* SmartCampaignStrategy */
"Search": { /* SmartCampaignSearchStrategy */
"BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
"AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
"AverageCpc": (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 */
},
"AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
"FilterAverageCpc": (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 */
},
"AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
"AverageCpa": (long),
"GoalId": (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 */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
"FilterAverageCpa": (long),
"GoalId": (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 */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageRoi": { /* StrategyAverageRoi */
"ReserveReturn": (int),
"RoiCoef": (long),
"GoalId": (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 */
"Profitability": (long), /* nillable */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCrr": { /* StrategyAverageCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionCrr": { /* StrategyPayForConversionCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
"Cpa" : (long),
"GoalId" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"PayForConversionPerFilter" : { /* StrategyPayForConversionPerFilter */
"Cpa" : (long),
"GoalId" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
}
},
"Network": { /* SmartCampaignNetworkStrategy */
"BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
"AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
"AverageCpc": (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 */
},
"AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
"FilterAverageCpc": (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 */
},
"AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
"AverageCpa": (long),
"GoalId": (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 */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
"FilterAverageCpa": (long),
"GoalId": (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 */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageRoi": { /* StrategyAverageRoi */
"ReserveReturn": (int),
"RoiCoef": (long),
"GoalId": (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 */
"Profitability": (long), /* nillable */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCrr": { /* StrategyAverageCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionCrr": { /* StrategyPayForConversionCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
"Cpa" : (long),
"GoalId" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"PayForConversionPerFilter" : { /* StrategyPayForConversionPerFilter */
"Cpa" : (long),
"GoalId" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"NetworkDefault": { /* StrategyNetworkDefault */
}
}
},
"Settings": [{ /* SmartCampaignSetting */
"Option": ( "ADD_TO_FAVORITES" | "REQUIRE_SERVICING" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"PriorityGoals": { /* PriorityGoalsUpdateSetting */
"Items": [{ /* PriorityGoalsUpdateItem */
"GoalId": (long), /* required */
"Value": (long), /* required */
"Operation": ( "SET" ), /* required */
"IsMetrikaSourceOfValue": ( "YES" | "NO" )
}, ... ] /* required */
}, /* nillable */
"PackageBiddingStrategy": { /* PackageBiddingStrategyUpdate */
"StrategyId": (long),
"StrategyFromCampaignId": (long),
"Platforms" : {
"Search" : ( "YES" | "NO" ) /* required */,
"Network" : ( "YES"| "NO" ) /* required */
}
}
}
}, ... ] /* required */
}
}
Parameter | Type | Description | Required |
SmartCampaignUpdateItem structure | |||
---|---|---|---|
CounterId | long | ID of the Yandex Metrica tag installed on the advertiser's site (see Yandex Metrica: Advertising campaign efficiency evaluation in the Help for Yandex Direct). | No |
TrackingParams | string | URL parameters for templates. | |
AttributionModel | AttributionModelEnum | The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct). Possible values:
| No |
BiddingStrategy | SmartCampaignStrategy | Display strategy. | No |
Settings | array of SmartCampaignSetting | Array of settings that only accept the values YES or NO. | No |
PriorityGoals | PriorityGoalsUpdateSetting, nillable | Priority goals for automatic bid adjustments. null (nil) — Delete the set of priority goals. In this case, automatic bid adjustments are used to obtain 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 |
PackageBiddingStrategy | SmartCampaignPackageBiddingStrategyUpdate, nillable | Links a campaign to the specified strategy. If Null (nil), the campaign is unlinked from the portfolio strategy. In this case, be sure to pass a new value for BiddingStrategy. 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 |
SmartCampaignSetting structure | |||
Option | SmartCampaignSettingsEnum | Setting name: | Yes |
Value | YesNoEnum | Setting value. | Yes |
PriorityGoalsUpdateSetting structure | |||
Items | array of PriorityGoalsUpdateItem | A new set of priority goals and conversion values to replace the existing set. | Yes |
PriorityGoalsUpdateItem 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 |
Operation | OperationEnum | Type of action with the set of priority goals. Currently, only the SET value is available. | 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 |
SmartCampaignPackageBiddingStrategyUpdate structure | |||
StrategyId | long | Portfolio strategy ID. | No |
StrategyFromCampaignId | long | ID of the campaign the portfolio strategy was created from. | No |
Platforms | SmartCampaignPlatforms | Ad placement platform. | No |
SmartCampaignPlatforms structure | |||
Search | YesNoEnum | Search results. | Yes |
Network | YesNoEnum | Yandex Advertising Network. | Yes |
SmartCampaignStrategy structure | |||
Search | SmartCampaignSearchStrategy | Display strategy in search results. | No |
Network | SmartCampaignNetworkStrategy | Display strategy in ad networks. | No |
SmartCampaignSearchStrategy structure | |||
BiddingStrategyType | SmartCampaignSearchStrategyTypeEnum | The type of display strategy in search results: | Yes |
AverageCpaPerCampaign | StrategyAverageCpaPerCampaign | Parameters of the Optimizing the number of conversions strategy with CPA for the entire campaign. | When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_CAMPAIGN |
AverageCpaPerFilter | StrategyAverageCpaPerFilter | Parameters of the Optimizing the number of conversions strategy with CPA for each filter. | When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_FILTER |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaign | Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign. | When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_CAMPAIGN |
AverageCpcPerFilter | StrategyAverageCpcPerFilter | Parameters of the Optimizing the number of clicks strategy with CPC for each filter. | When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_FILTER |
AverageRoi | StrategyAverageRoi | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrr | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversionCrr | StrategyPayForConversionCrr | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | With the BiddingStrategyType parameter set to PAY_FOR_CONVERSION_CRR |
PayForConversionPerCampaign | StrategyPayForConversionPerCampaign | Parameters of the Optimizing the number of conversions strategy, pay per conversion. | When the BiddingStrategyType parameter has the value PAY_FOR_CONVERSION_PER_CAMPAIGN. |
PayForConversionPerFilter | StrategyPayForConversionPerFilter | Parameters of the Optimizing the number of conversions strategy, pay per conversion for each filter. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_PER_FILTER |
SmartCampaignNetworkStrategy structure | |||
BiddingStrategyType | SmartCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks:
| Yes |
AverageCpaPerCampaign | StrategyAverageCpaPerCampaign | Parameters of the Optimizing the number of conversions strategy with CPA for the entire campaign. | When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_CAMPAIGN |
AverageCpaPerFilter | StrategyAverageCpaPerFilter | Parameters of the Optimizing the number of conversions strategy with CPA for each filter. | When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_FILTER |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaign | Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign. | When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_CAMPAIGN |
AverageCpcPerFilter | StrategyAverageCpcPerFilter | Parameters of the Optimizing the number of clicks strategy with CPC for each filter. | When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_FILTER |
AverageRoi | StrategyAverageRoi | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrr | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversionCrr | StrategyPayForConversionCrr | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | With the BiddingStrategyType parameter set to PAY_FOR_CONVERSION_CRR |
PayForConversionPerCampaign | StrategyPayForConversionPerCampaign | Parameters of the Optimizing the number of conversions strategy, pay per conversion. | When the BiddingStrategyType parameter has the value PAY_FOR_CONVERSION_PER_CAMPAIGN. |
PayForConversionPerFilter | StrategyPayForConversionPerFilter | Parameters of the Optimizing the number of conversions strategy, pay per conversion for each filter. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_PER_FILTER |
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. Pass an empty structure for this strategy. | When the BiddingStrategyType parameter has the value NETWORK_DEFAULT |
StrategyAverageCpaPerCampaign structure | |||
AverageCpa | long, nillable | 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. | 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. | 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:
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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is not set, the minimum budget won't change. To set the default value, pass ExplorationBudget=NULL. To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageCpaPerFilter structure | |||
FilterAverageCpa | long, nillable | The average cost of a conversion for each filter by default 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 |
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. | 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:
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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is not set, the minimum budget won't change. To set the default value, pass ExplorationBudget=NULL. To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageCpcPerCampaign 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:
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 |
StrategyAverageCpcPerFilter structure | |||
FilterAverageCpc | long | 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:
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 |
StrategyAverageRoi 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. | No |
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. | 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. | 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:
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 |
Profitability | long, nillable | 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 not set, the minimum budget won't change. To set the default value, pass ExplorationBudget=NULL. To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageCrr 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 |
BudgetType | BudgetTypeEnum | Type of budget:
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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is not set, the minimum budget won't change. To set the default value, pass ExplorationBudget=NULL. To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyPayForConversionCrr 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 |
BudgetType | BudgetTypeEnum | Type of budget:
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 |
StrategyPayForConversionPerCampaign 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. | 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. | No |
WeeklySpendLimit | long, nillable | 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 |
BudgetType | BudgetTypeEnum | Type of budget:
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 |
StrategyPayForConversionPerFilter 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. | 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. | No |
WeeklySpendLimit | long, nillable | 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 |
BudgetType | BudgetTypeEnum | Type of budget:
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 |
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 |
SmartCampaignUpdateItem structure | |||
---|---|---|---|
CounterId | long | ID of the Yandex Metrica tag installed on the advertiser's site (see Yandex Metrica: Advertising campaign efficiency evaluation in the Help for Yandex Direct). | No |
TrackingParams | string | URL parameters for templates. | |
AttributionModel | AttributionModelEnum | The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct). Possible values:
| No |
BiddingStrategy | SmartCampaignStrategy | Display strategy. | No |
Settings | array of SmartCampaignSetting | Array of settings that only accept the values YES or NO. | No |
PriorityGoals | PriorityGoalsUpdateSetting, nillable | Priority goals for automatic bid adjustments. null (nil) — Delete the set of priority goals. In this case, automatic bid adjustments are used to obtain 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 |
PackageBiddingStrategy | SmartCampaignPackageBiddingStrategyUpdate, nillable | Links a campaign to the specified strategy. If Null (nil), the campaign is unlinked from the portfolio strategy. In this case, be sure to pass a new value for BiddingStrategy. 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 |
SmartCampaignSetting structure | |||
Option | SmartCampaignSettingsEnum | Setting name: | Yes |
Value | YesNoEnum | Setting value. | Yes |
PriorityGoalsUpdateSetting structure | |||
Items | array of PriorityGoalsUpdateItem | A new set of priority goals and conversion values to replace the existing set. | Yes |
PriorityGoalsUpdateItem 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 |
Operation | OperationEnum | Type of action with the set of priority goals. Currently, only the SET value is available. | 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 |
SmartCampaignPackageBiddingStrategyUpdate structure | |||
StrategyId | long | Portfolio strategy ID. | No |
StrategyFromCampaignId | long | ID of the campaign the portfolio strategy was created from. | No |
Platforms | SmartCampaignPlatforms | Ad placement platform. | No |
SmartCampaignPlatforms structure | |||
Search | YesNoEnum | Search results. | Yes |
Network | YesNoEnum | Yandex Advertising Network. | Yes |
SmartCampaignStrategy structure | |||
Search | SmartCampaignSearchStrategy | Display strategy in search results. | No |
Network | SmartCampaignNetworkStrategy | Display strategy in ad networks. | No |
SmartCampaignSearchStrategy structure | |||
BiddingStrategyType | SmartCampaignSearchStrategyTypeEnum | The type of display strategy in search results: | Yes |
AverageCpaPerCampaign | StrategyAverageCpaPerCampaign | Parameters of the Optimizing the number of conversions strategy with CPA for the entire campaign. | When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_CAMPAIGN |
AverageCpaPerFilter | StrategyAverageCpaPerFilter | Parameters of the Optimizing the number of conversions strategy with CPA for each filter. | When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_FILTER |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaign | Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign. | When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_CAMPAIGN |
AverageCpcPerFilter | StrategyAverageCpcPerFilter | Parameters of the Optimizing the number of clicks strategy with CPC for each filter. | When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_FILTER |
AverageRoi | StrategyAverageRoi | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrr | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversionCrr | StrategyPayForConversionCrr | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | With the BiddingStrategyType parameter set to PAY_FOR_CONVERSION_CRR |
PayForConversionPerCampaign | StrategyPayForConversionPerCampaign | Parameters of the Optimizing the number of conversions strategy, pay per conversion. | When the BiddingStrategyType parameter has the value PAY_FOR_CONVERSION_PER_CAMPAIGN. |
PayForConversionPerFilter | StrategyPayForConversionPerFilter | Parameters of the Optimizing the number of conversions strategy, pay per conversion for each filter. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_PER_FILTER |
SmartCampaignNetworkStrategy structure | |||
BiddingStrategyType | SmartCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks:
| Yes |
AverageCpaPerCampaign | StrategyAverageCpaPerCampaign | Parameters of the Optimizing the number of conversions strategy with CPA for the entire campaign. | When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_CAMPAIGN |
AverageCpaPerFilter | StrategyAverageCpaPerFilter | Parameters of the Optimizing the number of conversions strategy with CPA for each filter. | When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_FILTER |
AverageCpcPerCampaign | StrategyAverageCpcPerCampaign | Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign. | When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_CAMPAIGN |
AverageCpcPerFilter | StrategyAverageCpcPerFilter | Parameters of the Optimizing the number of clicks strategy with CPC for each filter. | When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_FILTER |
AverageRoi | StrategyAverageRoi | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrr | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversionCrr | StrategyPayForConversionCrr | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | With the BiddingStrategyType parameter set to PAY_FOR_CONVERSION_CRR |
PayForConversionPerCampaign | StrategyPayForConversionPerCampaign | Parameters of the Optimizing the number of conversions strategy, pay per conversion. | When the BiddingStrategyType parameter has the value PAY_FOR_CONVERSION_PER_CAMPAIGN. |
PayForConversionPerFilter | StrategyPayForConversionPerFilter | Parameters of the Optimizing the number of conversions strategy, pay per conversion for each filter. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_PER_FILTER |
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. Pass an empty structure for this strategy. | When the BiddingStrategyType parameter has the value NETWORK_DEFAULT |
StrategyAverageCpaPerCampaign structure | |||
AverageCpa | long, nillable | 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. | 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. | 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:
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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is not set, the minimum budget won't change. To set the default value, pass ExplorationBudget=NULL. To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageCpaPerFilter structure | |||
FilterAverageCpa | long, nillable | The average cost of a conversion for each filter by default 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 |
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. | 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:
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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is not set, the minimum budget won't change. To set the default value, pass ExplorationBudget=NULL. To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageCpcPerCampaign 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:
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 |
StrategyAverageCpcPerFilter structure | |||
FilterAverageCpc | long | 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:
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 |
StrategyAverageRoi 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. | No |
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. | 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. | 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:
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 |
Profitability | long, nillable | 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 not set, the minimum budget won't change. To set the default value, pass ExplorationBudget=NULL. To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyAverageCrr 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 |
BudgetType | BudgetTypeEnum | Type of budget:
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 |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is not set, the minimum budget won't change. To set the default value, pass ExplorationBudget=NULL. To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES". If IsMinimumExplorationBudgetCustom is NO, the operation raises an error. | No |
StrategyPayForConversionCrr 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 |
BudgetType | BudgetTypeEnum | Type of budget:
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 |
StrategyPayForConversionPerCampaign 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. | 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. | No |
WeeklySpendLimit | long, nillable | 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 |
BudgetType | BudgetTypeEnum | Type of budget:
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 |
StrategyPayForConversionPerFilter 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. | 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. | No |
WeeklySpendLimit | long, nillable | 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 |
BudgetType | BudgetTypeEnum | Type of budget:
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 |
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 |