add: UnifiedCampaign parameters

Attention. All monetary campaign parameters (daily budget, weekly budget, and average price for automatic strategies) are passed via the Yandex Direct API as integer numbers. The passed value is a monetary value in the advertiser's currency, multiplied by 1,000,000.

To manage unified performance campaigns, use the URL: https://api.direct.yandex.com/v501/.

Request structure in JSON format:

{
  "method": "add",
  "params": {
    "Campaigns": [{  /* CampaignAddItem */
      ...
      "UnifiedCampaign" : {
        "BiddingStrategy" : {
            "Search" : { /* required */
                "WbMaximumClicks" : {
                    "WeeklySpendLimit" : (long) /* required */,
                    "BidCeiling" : (long),
                    "CustomPeriodBudget": {
                      "SpendLimit": (long),
                      "StartDate": (string),
                      "EndDate": (string),
                      "AutoContinue": ("YES" | "NO")
                    }
                },
                "WbMaximumConversionRate" : {
                    "WeeklySpendLimit" : (long) /* required */,
                    "BidCeiling" : (long),
                    "GoalId" : (long), /* required */
                    "CustomPeriodBudget": {
                      "SpendLimit": (long),
                      "StartDate": (string),
                      "EndDate": (string),
                      "AutoContinue": ("YES" | "NO")
                    },
                },
                "AverageCpc" : {
                    "AverageCpc" : (long) /* required */,
                    "WeeklySpendLimit" : (long)
                },
                "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"|"NO") /* required */
                    }
                },
                "PayForConversion" : {
                    "Cpa" : (long) /* required */,
                    "GoalId" : (long) /* required */,
                    "WeeklySpendLimit" : (long),
                    "CustomPeriodBudget": {
                      "SpendLimit": (long),
                      "StartDate": (string),
                      "EndDate": (string),
                      "AutoContinue": ("YES" | "NO")
                    }
                },
                "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"|"NO") /* required */
                    }
                },
                "PayForConversionCrr" : {
                    "Crr" : (integer) /* required */,
                    "GoalId" : (long) /* required */,
                    "WeeklySpendLimit" : (long),
                    "CustomPeriodBudget": {
                      "SpendLimit": (long),
                      "StartDate": (string),
                      "EndDate": (string),
                      "AutoContinue": ("YES" | "NO")
                    }
                },
                "BiddingStrategyType" : ("AVERAGE_CPC"|"AVERAGE_CPA"|"PAY_FOR_CONVERSION"|"WB_MAXIMUM_CONVERSION_RATE"|"HIGHEST_POSITION"|"SERVING_OFF"|"WB_MAXIMUM_CLICKS"|"AVERAGE_CRR"|"PAY_FOR_CONVERSION_CRR") /* required */,
                "PlacementTypes" : {
                    "SearchResults" : ("YES"|"NO"),
                    "ProductGallery" : ("YES"|"NO")
                }
            },
            "Network" : { /* required */
                "WbMaximumClicks" : {
                    "WeeklySpendLimit" : (long) /* required */,
                    "BidCeiling" : (long),
                    "CustomPeriodBudget": {
                      "SpendLimit": (long),
                      "StartDate": (string),
                      "EndDate": (string),
                      "AutoContinue": ("YES" | "NO")
                    },
                },
                "WbMaximumConversionRate" : {
                    "WeeklySpendLimit" : (long) /* required */,
                    "BidCeiling" : (long),
                    "GoalId" : (long), /* required */
                    "CustomPeriodBudget": {
                      "SpendLimit": (long),
                      "StartDate": (string),
                      "EndDate": (string),
                      "AutoContinue": ("YES" | "NO")
                    },
                },
                "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"|"NO") /* required */
                    }
                },
                "PayForConversion" : {
                    "Cpa" : (long) /* required */,
                    "GoalId" : (long) /* required */,
                    "WeeklySpendLimit" : (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"|"NO") /* required */
                    }
                },
                "PayForConversionCrr" : {
                    "Crr" : (integer) /* required */,
                    "GoalId" : (long) /* required */,
                    "WeeklySpendLimit" : (long),
                    "CustomPeriodBudget": {
                      "SpendLimit": (long),
                      "StartDate": (string),
                      "EndDate": (string),
                      "AutoContinue": ("YES" | "NO")
                    }
                },
                "BiddingStrategyType" : ("AVERAGE_CPC"|"AVERAGE_CPA"|"PAY_FOR_CONVERSION"|"WB_MAXIMUM_CONVERSION_RATE"|"NETWORK_DEFAULT"|"SERVING_OFF"|"WB_MAXIMUM_CLICKS"|"AVERAGE_CRR"|"PAY_FOR_CONVERSION_CRR") /* required */
            }
        },
        "Settings" : [{
            "Option" : ("ADD_METRICA_TAG"|"ADD_TO_FAVORITES"|"ENABLE_AREA_OF_INTEREST_TARGETING"|"ENABLE_SITE_MONITORING"|"REQUIRE_SERVICING"|"ENABLE_COMPANY_INFO"|"CAMPAIGN_EXACT_PHRASE_MATCHING_ENABLED") /* required */,
            "Value" : ("YES"|"NO") /* required */
        }, ... ],
        "CounterIds" : {
            "Items" : [ (integer) ] /* required */
        },
        "PriorityGoals" : {
            "Items" : [{ /* required */
                "GoalId" : (long) /* required */,
                "Value" : (long) /* required */,
                "IsMetrikaSourceOfValue" : ("YES"|"NO")
            }, ... ]
        },
        "TrackingParams" : (string),
        "AttributionModel" : ("LC"|"LSC"|"FC"|"LYDC"|"LSCCD"|"FCCD"|"LYDCCD"|"AUTO"),
        "PackageBiddingStrategy" : {
            "StrategyId" : (long),
            "StrategyFromCampaignId" : (long),
            "Platforms" : { /* required */
                "SearchResult" : ("YES"|"NO") /* required */,
                "ProductGallery" : ("YES"|"NO") /* required */,
                "Network" : ("YES"|"NO") /* required */
            }
        },
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }, ... ] /* required */
    }
  }
}
Parameter Type Description Required
UnifiedCampaignAddItem structure
BiddingStrategy UnifiedCampaignStrategyAdd Display strategy. No if PackageBiddingStrategy is specified
Settings array of UnifiedCampaignSetting Array of settings that only accept the values YES or NO. No
CounterIds ArrayOfInteger The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). No
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).

 No
TrackingParams string

URL parameters for templates.

 No
AttributionModel AttributionModelEnum

The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct).

Possible values:

  • FC — First click.
  • LC — Last click.
  • LSC — Last significant (non-direct) click.
  • LYDC — Last click from Yandex Direct.
  • FCCD – First cross-device click.
  • LSCCD – Last significant (non-direct) cross-device click.
  • LYDCCD – Last Yandex Direct cross-device click.
  • AUTO – Automatic attribution.

The default value is AUTO.

 No
PackageBiddingStrategy UnifiedCampaignPackageBiddingStrategyAdd

Links a campaign to the specified strategy.

You can't pass the following parameters in this field:

  • BiddingStrategy
  • PriorityGoals
  • CounterIds
  • AttributionModel

To pass those parameters, unlink the campaign from the portfolio strategy by specifying a new value for BiddingStrategy and resetting the PackageBiddingStrategy: null parameter value.

 No if BiddingStrategy is specified
NegativeKeywordSharedSetIds ArrayOfLong, nillable

IDs of sets of negative keywords. Maximum of 3 items in the array.

To get the IDs of sets, use the NegativeKeywordSharedSets.get method.

 No
UnifiedCampaignSetting structure
Option UnifiedCampaignSettingsEnum

Setting name:

 Yes
Value YesNoEnum Setting value. Yes
UnifiedCampaignPackageBiddingStrategyAdd structure
StrategyId long Portfolio strategy ID. No
StrategyFromCampaignId long ID of the campaign the portfolio strategy was created from. No
Platforms UnifiedCampaignPlatforms

Ad placement platform.

 Yes
PriorityGoalsArray structure
Items array of PriorityGoalsItem A set of priority goals and corresponding conversion values. Yes
PriorityGoalsItem structure
GoalId long

ID of a Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see Goals and conversions in the Help for Yandex Metrica.

To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API.

A value of 12 corresponds to the goal “Engaged sessions”.

 Yes
Value long The conversion value is a monetary estimation of the advertiser's profit when when the goal is completed, in the advertiser's currency, multiplied by 1,000,000. The higher the conversion value, the higher the priority to achieve conversions for this goal. Yes
IsMetrikaSourceOfValue YesNoEnum Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio. If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR
UnifiedCampaignPlatforms structure
SearchResult YesNoEnum Search results. Yes
ProductGallery YesNoEnum Product gallery. Yes
Network YesNoEnum Yandex Advertising Network. Yes
UnifiedCampaignStrategyAdd structure
Search UnifiedCampaignSearchStrategyAdd Display strategy in search results. Yes
Network UnifiedCampaignNetworkStrategyAdd Display strategy in ad networks. Yes
UnifiedCampaignSearchStrategyAdd structure
BiddingStrategyType UnifiedCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

For information about the compatibility of strategies in search results and ad networks, see the section Display strategies.

 Yes
PlacementTypes UnifiedCampaignSearchStrategyPlacementTypes

Placements in search results.

 No
WbMaximumClicks StrategyMaximumClicksAdd Parameters of the Optimize clicks strategy. Limit by weekly budget. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS
WbMaximumConversionRate StrategyMaximumConversionRateAdd Parameters of the Optimize conversions strategy without specifying the average CPA. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE
AverageCpc StrategyAverageCpcAdd Parameters of the Optimize clicks strategy. Limit by average CPC. When the BiddingStrategyType parameter has the value AVERAGE_CPC
AverageCpa StrategyAverageCpaAdd Parameters of the Optimize conversions strategy and keep the average CPA. When the BiddingStrategyType parameter has the value AVERAGE_CPA
AverageCrr StrategyAverageCrrAdd Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio When the BiddingStrategyType parameter is set to AVERAGE_CRR
PayForConversionCrr StrategyPayForConversionCrrAdd Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR
PayForConversion StrategyPayForConversionAdd Parameters of the Optimizing conversions strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION
UnifiedCampaignNetworkStrategyAdd structure
BiddingStrategyType UnifiedCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

For information about the compatibility of strategies in search results and ad networks, see the section Display strategies.

 Yes
WbMaximumClicks StrategyMaximumClicksAdd Parameters of the Optimize clicks strategy. Limit by weekly budget. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS
WbMaximumConversionRate StrategyMaximumConversionRateAdd Parameters of the Optimize conversions strategy without specifying the average CPA. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE
AverageCpc StrategyAverageCpcAdd Parameters of the Optimize clicks strategy. Limit by average CPC. When the BiddingStrategyType parameter has the value AVERAGE_CPC
AverageCpa StrategyAverageCpaAdd Parameters of the Optimize conversions strategy and keep the average CPA. When the BiddingStrategyType parameter has the value AVERAGE_CPA
AverageCrr StrategyAverageCrrAdd Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio When the BiddingStrategyType parameter is set to AVERAGE_CRR
PayForConversion StrategyPayForConversionAdd Parameters of the Optimizing conversions strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION
PayForConversionCrr StrategyPayForConversionCrrAdd Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR
StrategyMaximumClicksAdd structure
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 Yes
BidCeiling long

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
 No
CustomPeriodBudget CustomPeriodBudget

Budget for a custom period. For more information, see Yandex Direct Help.

When creating a campaign, you can't specify both this parameter and WeeklySpendLimit.

 No
UnifiedCampaignSearchStrategyPlacementTypes structure
SearchResults YesNoEnum

Search results.

 No
ProductGallery YesNoEnum

Product gallery.

 No
StrategyMaximumConversionRateAdd structure
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 Yes
BidCeiling long

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
 No
GoalId long

ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica.

The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions.

To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API.

 Yes
CustomPeriodBudget CustomPeriodBudget

Budget for a custom period. For more information, see Yandex Direct Help.

When creating a campaign, you can't specify both this parameter and WeeklySpendLimit.

 No
StrategyAverageCpcAdd structure
AverageCpc long

The average CPC in the advertiser's currency, multiplied by 1,000,000.

The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 Yes
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 No
CustomPeriodBudget CustomPeriodBudget

Budget for a custom period. For more information, see Yandex Direct Help.

When creating a campaign, you can't specify both this parameter and WeeklySpendLimit.

 No
StrategyAverageCpaAdd structure
AverageCpa long

The average cost of a conversion (CPA) in the advertiser's currency, multiplied by 1,000,000.

The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 Yes
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 No
CustomPeriodBudget CustomPeriodBudget

Budget for a custom period. For more information, see Yandex Direct Help.

When creating a campaign, you can't specify both this parameter and WeeklySpendLimit.

 No
GoalId long

ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica.

To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API.

 Yes
BidCeiling long

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
 No
ExplorationBudget ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings).

To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES".

If IsMinimumExplorationBudgetCustom is NO, the operation raises an error.

 No
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
Parameter Type Description Required
UnifiedCampaignAddItem structure
BiddingStrategy UnifiedCampaignStrategyAdd Display strategy. No if PackageBiddingStrategy is specified
Settings array of UnifiedCampaignSetting Array of settings that only accept the values YES or NO. No
CounterIds ArrayOfInteger The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). No
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).

 No
TrackingParams string

URL parameters for templates.

 No
AttributionModel AttributionModelEnum

The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct).

Possible values:

  • FC — First click.
  • LC — Last click.
  • LSC — Last significant (non-direct) click.
  • LYDC — Last click from Yandex Direct.
  • FCCD – First cross-device click.
  • LSCCD – Last significant (non-direct) cross-device click.
  • LYDCCD – Last Yandex Direct cross-device click.
  • AUTO – Automatic attribution.

The default value is AUTO.

 No
PackageBiddingStrategy UnifiedCampaignPackageBiddingStrategyAdd

Links a campaign to the specified strategy.

You can't pass the following parameters in this field:

  • BiddingStrategy
  • PriorityGoals
  • CounterIds
  • AttributionModel

To pass those parameters, unlink the campaign from the portfolio strategy by specifying a new value for BiddingStrategy and resetting the PackageBiddingStrategy: null parameter value.

 No if BiddingStrategy is specified
NegativeKeywordSharedSetIds ArrayOfLong, nillable

IDs of sets of negative keywords. Maximum of 3 items in the array.

To get the IDs of sets, use the NegativeKeywordSharedSets.get method.

 No
UnifiedCampaignSetting structure
Option UnifiedCampaignSettingsEnum

Setting name:

 Yes
Value YesNoEnum Setting value. Yes
UnifiedCampaignPackageBiddingStrategyAdd structure
StrategyId long Portfolio strategy ID. No
StrategyFromCampaignId long ID of the campaign the portfolio strategy was created from. No
Platforms UnifiedCampaignPlatforms

Ad placement platform.

 Yes
PriorityGoalsArray structure
Items array of PriorityGoalsItem A set of priority goals and corresponding conversion values. Yes
PriorityGoalsItem structure
GoalId long

ID of a Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see Goals and conversions in the Help for Yandex Metrica.

To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API.

A value of 12 corresponds to the goal “Engaged sessions”.

 Yes
Value long The conversion value is a monetary estimation of the advertiser's profit when when the goal is completed, in the advertiser's currency, multiplied by 1,000,000. The higher the conversion value, the higher the priority to achieve conversions for this goal. Yes
IsMetrikaSourceOfValue YesNoEnum Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio. If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR
UnifiedCampaignPlatforms structure
SearchResult YesNoEnum Search results. Yes
ProductGallery YesNoEnum Product gallery. Yes
Network YesNoEnum Yandex Advertising Network. Yes
UnifiedCampaignStrategyAdd structure
Search UnifiedCampaignSearchStrategyAdd Display strategy in search results. Yes
Network UnifiedCampaignNetworkStrategyAdd Display strategy in ad networks. Yes
UnifiedCampaignSearchStrategyAdd structure
BiddingStrategyType UnifiedCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

For information about the compatibility of strategies in search results and ad networks, see the section Display strategies.

 Yes
PlacementTypes UnifiedCampaignSearchStrategyPlacementTypes

Placements in search results.

 No
WbMaximumClicks StrategyMaximumClicksAdd Parameters of the Optimize clicks strategy. Limit by weekly budget. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS
WbMaximumConversionRate StrategyMaximumConversionRateAdd Parameters of the Optimize conversions strategy without specifying the average CPA. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE
AverageCpc StrategyAverageCpcAdd Parameters of the Optimize clicks strategy. Limit by average CPC. When the BiddingStrategyType parameter has the value AVERAGE_CPC
AverageCpa StrategyAverageCpaAdd Parameters of the Optimize conversions strategy and keep the average CPA. When the BiddingStrategyType parameter has the value AVERAGE_CPA
AverageCrr StrategyAverageCrrAdd Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio When the BiddingStrategyType parameter is set to AVERAGE_CRR
PayForConversionCrr StrategyPayForConversionCrrAdd Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR
PayForConversion StrategyPayForConversionAdd Parameters of the Optimizing conversions strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION
UnifiedCampaignNetworkStrategyAdd structure
BiddingStrategyType UnifiedCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

For information about the compatibility of strategies in search results and ad networks, see the section Display strategies.

 Yes
WbMaximumClicks StrategyMaximumClicksAdd Parameters of the Optimize clicks strategy. Limit by weekly budget. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS
WbMaximumConversionRate StrategyMaximumConversionRateAdd Parameters of the Optimize conversions strategy without specifying the average CPA. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE
AverageCpc StrategyAverageCpcAdd Parameters of the Optimize clicks strategy. Limit by average CPC. When the BiddingStrategyType parameter has the value AVERAGE_CPC
AverageCpa StrategyAverageCpaAdd Parameters of the Optimize conversions strategy and keep the average CPA. When the BiddingStrategyType parameter has the value AVERAGE_CPA
AverageCrr StrategyAverageCrrAdd Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio When the BiddingStrategyType parameter is set to AVERAGE_CRR
PayForConversion StrategyPayForConversionAdd Parameters of the Optimizing conversions strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION
PayForConversionCrr StrategyPayForConversionCrrAdd Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR
StrategyMaximumClicksAdd structure
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 Yes
BidCeiling long

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
 No
CustomPeriodBudget CustomPeriodBudget

Budget for a custom period. For more information, see Yandex Direct Help.

When creating a campaign, you can't specify both this parameter and WeeklySpendLimit.

 No
UnifiedCampaignSearchStrategyPlacementTypes structure
SearchResults YesNoEnum

Search results.

 No
ProductGallery YesNoEnum

Product gallery.

 No
StrategyMaximumConversionRateAdd structure
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 Yes
BidCeiling long

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
 No
GoalId long

ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica.

The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions.

To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API.

 Yes
CustomPeriodBudget CustomPeriodBudget

Budget for a custom period. For more information, see Yandex Direct Help.

When creating a campaign, you can't specify both this parameter and WeeklySpendLimit.

 No
StrategyAverageCpcAdd structure
AverageCpc long

The average CPC in the advertiser's currency, multiplied by 1,000,000.

The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 Yes
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 No
CustomPeriodBudget CustomPeriodBudget

Budget for a custom period. For more information, see Yandex Direct Help.

When creating a campaign, you can't specify both this parameter and WeeklySpendLimit.

 No
StrategyAverageCpaAdd structure
AverageCpa long

The average cost of a conversion (CPA) in the advertiser's currency, multiplied by 1,000,000.

The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 Yes
WeeklySpendLimit long

The weekly budget in the advertiser's currency, multiplied by 1,000,000.

The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

 No
CustomPeriodBudget CustomPeriodBudget

Budget for a custom period. For more information, see Yandex Direct Help.

When creating a campaign, you can't specify both this parameter and WeeklySpendLimit.

 No
GoalId long

ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica.

To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API.

 Yes
BidCeiling long

The maximum bid in the advertiser's currency, multiplied by 1,000,000.

The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
 No
ExplorationBudget ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings).

To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES".

If IsMinimumExplorationBudgetCustom is NO, the operation raises an error.

 No
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