add. Yandex Direct API. Version 5

Strategies: operations with portfolio strategies

add

Creates a portfolio strategy.

Request

Request structure in JSON format:


    "params" : { /* required */
        "Strategies" : [{ /* required */
            "AttributionModel" : ("LC"|"LSC"|"FC"|"LYDC"|"LSCCD"|"FCCD"|"LYDCCD"),
            "Name" : (string) /* required */,
            "CounterIds" : {
                "Items" : [ (long) ] /* required */
            },
            "PriorityGoals" : {
                "Items" : [{ /* required */
                    "GoalId" : (long) /* required */,
                    "Value" : (long) /* required */,
                    "IsMetrikaSourceOfValue" : ("YES"|"NO")
                } ]
            },
            "WbMaximumClicks" : {
                "WeeklySpendLimit" : (long) /* required */,
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
                "BidCeiling" : (long)
            },
            "WbMaximumConversionRate" : {
                "WeeklySpendLimit" : (long) /* required */,
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
                "BidCeiling" : (long),
                "GoalId" : (long) /* required */
            },
            "AverageCpc" : {
                "AverageCpc" : (long) /* required */,
                "WeeklySpendLimit" : (long),
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
            },
            "AverageCpa" : {
                "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 */
                }
            },
            "PayForConversion" : {
                "Cpa" : (long) /* required */,
                "GoalId" : (long) /* required */,
                "WeeklySpendLimit" : (long),
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
            },
            "AverageCpaPerCampaign" : {
                "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 */
                }
            },
            "PayForConversionPerCampaign" : {
                "Cpa" : (long) /* required */,
                "GoalId" : (long) /* required */,
                "WeeklySpendLimit" : (long),
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
            },
            "PayForConversionPerFilter" : {
                "Cpa" : (long) /* required */,
                "GoalId" : (long) /* required */,
                "WeeklySpendLimit" : (long),
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
            },
            "AverageCpaPerFilter" : {
                "FilterAverageCpa" : (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 */
                }
            },
            "AverageCpcPerCampaign" : {
                "AverageCpc" : (long) /* required */,
                "WeeklySpendLimit" : (long),
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
                "BidCeiling" : (long)
            },
            "AverageCpcPerFilter" : {
                "FilterAverageCpc" : (long),
                "WeeklySpendLimit" : (long),
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
                "BidCeiling" : (long)
            },
            "AverageCrr" : {
                "Crr" : (integer) /* required */,
                "GoalId" : (long) /* required */,
                "WeeklySpendLimit" : (long),
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
                "ExplorationBudget" : {
                  "MinimumExplorationBudget" : (long) /* required */,
                  "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
                }
            },
            "PayForConversionCrr" : {
                "Crr" : (integer) /* required */,
                "GoalId" : (long) /* required */,
                "WeeklySpendLimit" : (long),
                "CustomPeriodBudget": {
                  "SpendLimit": (long),
                  "StartDate": (string),
                  "EndDate": (string),
                  "AutoContinue": ("YES" | "NO")
                },
            }
        } ]
    }


Params structure (for JSON) / AddRequest structure (for SOAP)
Parameter	Type	Description	Required
Strategies	array for StrategiesAddItem	Portfolio strategy	Yes
StrategiesAddItem structure
`AttributionModel`	AttributionModelEnum	The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct). Possible values: FC — First click. LC — Last click. LSC — Last significant (non-direct) click. LYDC — Last click from Yandex Direct. LSCCD — Last significant (non-direct) cross-device click. FCCD — First cross-device click. LYDCCD — Last Yandex Direct cross-device click. The default value is LYDC.	No
`Name`	String	Portfolio strategy name.	Yes
`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
`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
`WbMaximumClicks`	StrategyMaximumClicksAdd	Parameters of the Optimize clicks strategy. Limit by weekly budget.	No
`WbMaximumConversionRate`	StrategyMaximumConversionRateAdd	Parameters of the Optimize conversions strategy without specifying the average CPA.	No
`AverageCpc`	StrategyAverageCpcAdd	Parameters of the Optimize clicks strategy. Limit by average CPC.	No
`AverageCpa`	StrategyAverageCpaAdd	Parameters of the Optimize conversions strategy and keep the average CPA.	No
`PayForConversion`	StrategyPayForConversionAdd	Parameters of the Optimizing conversions strategy. Pay per conversion.	No
`AverageCpaPerCampaign`	StrategyAverageCpaPerCampaignAdd	Parameters of the Optimizing the number of conversions strategy with CPA for the entire campaign.	No
`PayForConversionPerCampaign`	StrategyPayForConversionPerCampaignAdd	Parameters of the Optimizing the number of conversions strategy, pay per conversion.	No
`PayForConversionPerFilter`	StrategyPayForConversionPerFilterAdd	Parameters of the Optimizing the number of conversions strategy, pay per conversion.	No
`AverageCpaPerFilter`	StrategyAverageCpaPerFilterAdd	Parameters of the Optimizing the number of conversions strategy with CPA for each filter.	No
`AverageCpcPerCampaign`	StrategyAverageCpcPerCampaignAdd	Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign.	No
`AverageCpcPerFilter`	StrategyAverageCpcPerFilterAdd	Parameters of the Optimizing the number of clicks strategy with CPC for each filter.	No
`AverageCrr`	StrategyAverageCrrAdd	Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio	No
`PayForConversionCrr`	StrategyPayForConversionCrrAdd	Parameters of the Optimize cost revenue ratio strategy. Pay per conversion.	No
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
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
`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
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
`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
`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
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
StrategyAverageCpaPerCampaignAdd 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
`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
`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
StrategyPayForConversionPerCampaignAdd 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
StrategyPayForConversionPerFilterAdd 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
StrategyAverageCpaPerFilterAdd structure
`FilterAverageCpa`	long	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.	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
`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
StrategyAverageCpcPerCampaignAdd 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
`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
StrategyAverageCpcPerFilterAdd structure
`FilterAverageCpc`	long		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
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
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


Params structure (for JSON) / AddRequest structure (for SOAP)
Parameter	Type	Description	Required
Strategies	array for StrategiesAddItem	Portfolio strategy	Yes
StrategiesAddItem structure
`AttributionModel`	AttributionModelEnum	The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct). Possible values: FC — First click. LC — Last click. LSC — Last significant (non-direct) click. LYDC — Last click from Yandex Direct. LSCCD — Last significant (non-direct) cross-device click. FCCD — First cross-device click. LYDCCD — Last Yandex Direct cross-device click. The default value is LYDC.	No
`Name`	String	Portfolio strategy name.	Yes
`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
`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
`WbMaximumClicks`	StrategyMaximumClicksAdd	Parameters of the Optimize clicks strategy. Limit by weekly budget.	No
`WbMaximumConversionRate`	StrategyMaximumConversionRateAdd	Parameters of the Optimize conversions strategy without specifying the average CPA.	No
`AverageCpc`	StrategyAverageCpcAdd	Parameters of the Optimize clicks strategy. Limit by average CPC.	No
`AverageCpa`	StrategyAverageCpaAdd	Parameters of the Optimize conversions strategy and keep the average CPA.	No
`PayForConversion`	StrategyPayForConversionAdd	Parameters of the Optimizing conversions strategy. Pay per conversion.	No
`AverageCpaPerCampaign`	StrategyAverageCpaPerCampaignAdd	Parameters of the Optimizing the number of conversions strategy with CPA for the entire campaign.	No
`PayForConversionPerCampaign`	StrategyPayForConversionPerCampaignAdd	Parameters of the Optimizing the number of conversions strategy, pay per conversion.	No
`PayForConversionPerFilter`	StrategyPayForConversionPerFilterAdd	Parameters of the Optimizing the number of conversions strategy, pay per conversion.	No
`AverageCpaPerFilter`	StrategyAverageCpaPerFilterAdd	Parameters of the Optimizing the number of conversions strategy with CPA for each filter.	No
`AverageCpcPerCampaign`	StrategyAverageCpcPerCampaignAdd	Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign.	No
`AverageCpcPerFilter`	StrategyAverageCpcPerFilterAdd	Parameters of the Optimizing the number of clicks strategy with CPC for each filter.	No
`AverageCrr`	StrategyAverageCrrAdd	Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio	No
`PayForConversionCrr`	StrategyPayForConversionCrrAdd	Parameters of the Optimize cost revenue ratio strategy. Pay per conversion.	No
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
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
`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
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
`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
`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
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
StrategyAverageCpaPerCampaignAdd 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
`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
`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
StrategyPayForConversionPerCampaignAdd 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
StrategyPayForConversionPerFilterAdd 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
StrategyAverageCpaPerFilterAdd structure
`FilterAverageCpa`	long	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.	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
`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
StrategyAverageCpcPerCampaignAdd 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
`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
StrategyAverageCpcPerFilterAdd structure
`FilterAverageCpc`	long		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
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
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

Response

Response structure in JSON format:

{
  "result" : { /* required */
        "AddResults" : [{
            "Warnings" : [{
                "Code" : (integer) /* required */,
                "Message" : (string) /* required */,
                "Details" : (string)
            } ],
            "Errors" : [{
                "Code" : (integer) /* required */,
                "Message" : (string) /* required */,
                "Details" : (string)
            } ],
            "Id" : (long)
        } ]
    }
}


Result structure (for JSON) / AddResponse structure (for SOAP)
Parameter	Type	Description
`AddResults`	array of ActionResult	What happens when a portfolio strategy is added.
ActionResult structure
`Id`	long	ID of the portfolio strategy that was created. Returned if there are no errors, see Operations on object arrays.
`Warnings`	array of ExceptionNotification	Warnings that occurred during the operation.
`Errors`	array of ExceptionNotification	Errors that occurred during the operation.


Result structure (for JSON) / AddResponse structure (for SOAP)
Parameter	Type	Description
`AddResults`	array of ActionResult	What happens when a portfolio strategy is added.
ActionResult structure
`Id`	long	ID of the portfolio strategy that was created. Returned if there are no errors, see Operations on object arrays.
`Warnings`	array of ExceptionNotification	Warnings that occurred during the operation.
`Errors`	array of ExceptionNotification	Errors that occurred during the operation.

Was the article useful?

Please tell us what you didn't like about this article:

Strategies: operations with portfolio strategies