add: UnifiedCampaign parameters
To manage a unified performance campaign, use this 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),
"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 */
}
},
"AverageCpaMultipleGoals" : {
"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")
}
},
"PayForConversionMultipleGoals" : {
"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"),
"DynamicPlaces" : ( "YES" | "NO" ),
"Maps" : ("YES"|"NO"),
"SearchOrganizationList" : ("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 */
}
},
"AverageCpaMultipleGoals" : {
"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)
},
"PayForConversionMultipleGoals" : {
"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"|"NETWORK_DEFAULT"|"SERVING_OFF"|"WB_MAXIMUM_CLICKS"|"AVERAGE_CRR"|"PAY_FOR_CONVERSION_CRR") /* required */,
"PlacementTypes" : {
"Network" : ("YES"|"NO"),
"Maps" : ("YES"|"NO")
}
}
},
"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"| "ALTERNATIVE_TEXTS_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 */,
"Maps" : ("YES"|"NO"),
"SearchOrganizationList" : ("YES"|"NO"),
"Network" : ("YES"|"NO") /* required */,
"DynamicPlaces" : ( "YES" | "NO" )
}
},
"NegativeKeywordSharedSetIds" : { /* nillable */
"Items" : [ (long) ] /* required */
}
}, ... ] /* required */
}
}
}
Parameter |
Type |
Description |
Required |
UnifiedCampaignAddItem structure |
|||
|
UnifiedCampaignStrategyAdd |
Display strategy. |
No if PackageBiddingStrategy is specified |
|
array of UnifiedCampaignSetting |
Array of settings that only accept the values YES or NO. |
No |
|
ArrayOfInteger |
The IDs of Yandex Metrica tags installed on the advertiser's website (see Yandex Metrica: evaluate your ad performance in Yandex Direct Help). |
No |
|
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 Yandex Direct Help). |
When passing the |
|
string |
URL parameters for templates. |
No |
|
AttributionModelEnum |
The attribution model used for optimizing conversions (see Attribution model in Yandex Direct Help). Possible values:
The default value is AUTO. |
No |
|
UnifiedCampaignPackageBiddingStrategyAdd |
Links a campaign to the specified strategy. You can't pass the following parameters in this field:
To pass these parameters, unlink the campaign from the portfolio strategy: specify a new value for |
No if BiddingStrategy is specified |
|
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 |
|||
|
UnifiedCampaignSettingsEnum |
Setting name:
|
Yes |
|
YesNoEnum |
Setting value. |
Yes |
UnifiedCampaignPackageBiddingStrategyAdd structure |
|||
|
long |
Portfolio strategy ID. |
No |
|
long |
ID of the campaign the portfolio strategy was created from. |
No |
|
UnifiedCampaignPlatforms |
Ad placement platform. |
Yes |
PriorityGoalsArray structure |
|||
|
array of PriorityGoalsItem |
A set of priority goals and corresponding conversion values. |
Yes |
PriorityGoalsItem structure |
|||
|
long |
ID of the Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see Goals and conversions in Yandex Metrica Help. 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 "Engaged sessions" goal. |
Yes |
|
long |
The conversion value is a monetary estimation of the advertiser's profit 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 |
|
YesNoEnum |
Priority goal value source: Yandex Metrica goal. The |
If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR |
UnifiedCampaignPlatforms structure |
|||
|
YesNoEnum |
Search results. |
Yes |
|
YesNoEnum |
Product gallery. |
Yes |
|
YesNoEnum |
Yandex Maps. |
No |
|
YesNoEnum |
List of organizations in search results. |
No |
|
YesNoEnum |
Yandex Advertising Network. |
Yes |
|
YesNoEnum |
Dynamic placements in search results. |
No |
UnifiedCampaignStrategyAdd structure |
|||
|
UnifiedCampaignSearchStrategyAdd |
Display strategy in search results. |
Yes |
|
UnifiedCampaignNetworkStrategyAdd |
Display strategy in ad networks. |
Yes |
UnifiedCampaignSearchStrategyAdd structure |
|||
|
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 |
|
UnifiedCampaignSearchStrategyPlacementTypes |
Placements in search results. Note When creating a campaign, the "Dynamic placements in search results" placement type takes the same value as the "Search results" type ( |
No |
|
StrategyMaximumClicksAdd |
Parameters of the Optimize clicks strategy. Limited by weekly budget. |
When the |
|
StrategyMaximumConversionRateAdd |
Parameters of the Optimize conversions strategy without specifying the average CPA. |
When the |
|
StrategyAverageCpcAdd |
Parameters of the Optimize clicks strategy. Limited by average CPC. |
When the |
|
StrategyAverageCpaAdd |
Parameters of the Optimize conversions strategy. Maintain the average CPA. |
When the |
|
StrategyAverageCpaMultipleGoalsAdd |
Parameters of the Maximize conversions pay-per-click strategy. Maintain the average CPA for multiple goals. |
When the |
|
StrategyAverageCrrAdd |
Parameters of the strategy Optimize cost revenue ratio. Maintain the average cost revenue ratio. |
When the |
|
StrategyPayForConversionCrrAdd |
Parameters of the strategy Optimize cost revenue ratio. Pay per conversion. |
When the |
|
StrategyPayForConversionAdd |
Parameters of the Optimize conversions strategy. Pay per conversion. |
When the |
|
StrategyPayForConversionMultipleGoalsAdd |
Parameters of the Maximize conversions pay-per-conversion strategy for each of the specified goals. |
When the |
UnifiedCampaignNetworkStrategyAdd structure |
|||
|
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 |
|
UnifiedCampaignNetworkStrategyPlacementTypes |
Placements in ad networks. |
No |
|
StrategyMaximumClicksAdd |
Parameters of the Optimize clicks strategy. Limited by weekly budget. |
When the |
|
StrategyMaximumConversionRateAdd |
Parameters of the Optimize conversions strategy without specifying the average CPA. |
When the |
|
StrategyAverageCpcAdd |
Parameters of the Optimize clicks strategy. Limited by average CPC. |
When the |
|
StrategyAverageCpaAdd |
Parameters of the Optimize conversions strategy. Maintain the average CPA. |
When the |
|
StrategyAverageCpaMultipleGoalsAdd |
Parameters of the Maximize conversions pay-per-click strategy. Maintain the average CPA for multiple goals. |
When the |
|
StrategyAverageCrrAdd |
Parameters of the strategy Optimize cost revenue ratio. Maintain the average cost revenue ratio. |
When the |
|
StrategyPayForConversionAdd |
Parameters of the Optimize conversions strategy. Pay per conversion. |
When the |
|
StrategyPayForConversionMultipleGoalsAdd |
Parameters of the Maximize conversions pay-per-conversion strategy for each of the specified goals. |
When the |
|
StrategyPayForConversionCrrAdd |
Parameters of the strategy Optimize cost revenue ratio. Pay per conversion. |
When the |
UnifiedCampaignNetworkStrategyPlacementTypes |
|||
|
YesNoEnum |
Ad networks. |
No |
|
YesNoEnum |
Yandex Maps. |
When the |
StrategyMaximumClicksAdd structure |
|||
|
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 |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
UnifiedCampaignSearchStrategyPlacementTypes structure |
|||
|
YesNoEnum |
Search results. |
No |
|
YesNoEnum |
Product gallery. |
No |
|
YesNoEnum |
Dynamic placements in search results. |
No |
|
YesNoEnum |
Yandex Maps. |
When the |
|
YesNoEnum |
List of organizations in search results. |
No |
StrategyMaximumConversionRateAdd structure |
|||
|
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 |
|
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 |
|
long |
ID of the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help. 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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
StrategyAverageCpcAdd structure |
|||
|
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 |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
StrategyAverageCpaAdd structure |
|||
|
long |
The average goal cost 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 |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
|
long |
ID of the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. |
Yes |
|
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 |
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 If |
No |
StrategyAverageCpaMultipleGoalsAdd structure |
|||
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
|
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 |
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 If |
No |
StrategyAverageCrrAdd structure |
|||
|
int |
Average cost revenue ratio. |
Yes |
|
long |
ID of the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. |
Yes |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
|
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 If |
No |
StrategyPayForConversionAdd structure |
|||
|
long |
The goal cost 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 |
|
long |
ID of the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. |
Yes |
|
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 |
No |
|
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 |
No |
PayForConversionMultipleGoals structure |
|||
|
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 |
No |
|
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 |
No |
StrategyPayForConversionCrrAdd structure |
|||
|
int |
Average cost revenue ratio. |
Yes |
|
long |
ID of the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. |
Yes |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
ExplorationBudget structure |
|||
|
long |
Minimum budget value. Acceptable value: between 0 and the weekly budget (if set). |
Yes, if the request includes the |
|
YesNoEnum |
A flag indicating a custom minimum budget. |
Yes, if the request includes the |
CustomPeriodBudget structure |
|||
|
long |
Budget size for a custom period. |
Yes |
|
string |
Start of the budget period. |
Yes |
|
string |
End of the budget period. |
Yes |
|
YesNoEnum |
Flag to autocontinue the budget period. |
Yes |