add: SmartCampaign 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.

Request structure in JSON format:

{
  "method": "add",
  "params": {
    "Campaigns": [{  /* CampaignAddItem */
      ...
      "SmartCampaign": { /* SmartCampaignAddItem */
        "BiddingStrategy": { /* SmartCampaignStrategyAdd */
          "Search": { /* SmartCampaignSearchStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMP" | ... | "SERVING_OFF" ), /* required */
            "AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaignAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "AverageCpcPerFilter": { /* StrategyAverageCpcPerFilterAdd */
              "FilterAverageCpc": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "AverageCpaPerCampaign" : { /* StrategyAverageCpaPerCampaignAdd */
              "AverageCpa": (long),
              "AverageCpc": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "AverageCpaPerFilter": {  /* StrategyAverageCpaPerFilterAdd */
              "FilterAverageCpa": (long),
              "FilterAverageCpc": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "AverageRoi": { /* StrategyAverageRoiAdd */
              "ReserveReturn": (int), /* required */
              "RoiCoef": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long),
              "Profitability": (long)
            },
            "PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaignAdd */
              "Cpa" : (long) /* required */,
              "GoalId" : (long) /* required */,
              "WeeklySpendLimit" : (long)
            }
          }, /* required */
          "Network": { /* SmartCampaignNetworkStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMP" | ... | "SERVING_OFF" ), /* required */
            "AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaignAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "AverageCpcPerFilter": { /* StrategyAverageCpcPerFilterAdd */
              "FilterAverageCpc": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "AverageCpaPerCampaign" : { /* StrategyAverageCpaPerCampaignAdd */
              "AverageCpa": (long),
              "AverageCpc": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "AverageCpaPerFilter": {  /* StrategyAverageCpaPerFilter */
              "FilterAverageCpa": (long),
              "FilterAverageCpc": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "AverageRoi": { /* StrategyAverageRoiAdd */
              "ReserveReturn": (int), /* required */
              "RoiCoef": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long),
              "Profitability": (long)
            },
            "PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaignAdd */
              "Cpa" : (long) /* required */,
              "GoalId" : (long) /* required */,
              "WeeklySpendLimit" : (long)
            },
            "NetworkDefault": {  /* StrategyNetworkDefaultAdd */
            }
          } /* required */
        }, /* required */
        "Settings": [{ /* SmartCampaignSetting */
          "Option": ( "ADD_TO_FAVORITES" | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterId": (long), /* required */
        "PriorityGoals": { /* PriorityGoalsArray */
          "Items": [{ /* PriorityGoalsItem */
            "GoalId": (long), /* required */ 
            "Value": (long) /* required */ 
          }, ... ] /* required */
        }
      }
    }, ... ] /* required */
  }
}
Parameter Type Description Required
SmartCampaignAddItem structure
BiddingStrategy SmartCampaignStrategyAdd Display strategy. Yes
Settings array of SmartCampaignSetting Array of settings that only accept the values YES or NO. No
CounterId long Yandex.ID of the Yandex.Metrica tag installed on the advertiser's site (see Yandex.Metrica: advertising campaign efficiency evaluation in the Help for Yandex.Direct). Yes
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
SmartCampaignSetting structure
Option SmartCampaignSettingsEnum

Setting name:

Yes
Value YesNoEnum Setting value. 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
SmartCampaignStrategyAdd structure
Network SmartCampaignNetworkStrategyAdd Display strategy in ad networks. Yes
SmartCampaignSearchStrategyAdd structure
BiddingStrategyType SmartCampaignSearchStrategyTypeEnum The type of display strategy in search results: Yes
AverageCpaPerCampaign StrategyAverageCpaPerCampaignAdd Parameters of the Optimizing the number of conversions strategy with CPC or CPA for the entire campaign. When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_CAMPAIGN
AverageCpaPerFilter StrategyAverageCpaPerFilterAdd Parameters of the Optimizing the number of conversions strategy with CPC or CPA for each filter. When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_FILTER
AverageCpcPerCampaign StrategyAverageCpсPerCampaignAdd Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign. When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_CAMPAIGN
AverageCpcPerFilter StrategyAverageCpсPerFilterAdd Parameters of the Optimizing the number of clicks strategy with CPC for each filter. When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_FILTER
AverageRoi StrategyAverageRoiAdd Parameters of the Optimize ROI strategy. When the BiddingStrategyType parameter has the value AVERAGE_ROI
PayForConversionPerCampaign StrategyPayForConversionPerCampaignAdd Parameters of the Optimizing the number of conversions strategy, pay per conversion. When the BiddingStrategyType parameter has the value PAY_FOR_CONVERSION_PER_CAMPAIGN.
SmartCampaignNetworkStrategyAdd structure
BiddingStrategyType SmartCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

Yes
AverageCpaPerCampaign StrategyAverageCpaPerCampaignAdd Parameters of the Optimizing the number of conversions strategy with CPC or CPA for the entire campaign. When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_CAMPAIGN
AverageCpaPerFilter StrategyAverageCpaPerFilterAdd Parameters of the Optimizing the number of conversions strategy with CPC or CPA for each filter. When the BiddingStrategyType parameter has the value AVERAGE_CPA_PER_FILTER
AverageCpcPerCampaign StrategyAverageCpсPerCampaignAdd Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign. When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_CAMPAIGN
AverageCpcPerFilter StrategyAverageCpсPerFilterAdd Parameters of the Optimizing the number of clicks strategy with CPC for each filter. When the BiddingStrategyType parameter has the value AVERAGE_CPC_PER_FILTER
AverageRoi StrategyAverageRoiAdd Parameters of the Optimize ROI strategy. When the BiddingStrategyType parameter has the value AVERAGE_ROI
PayForConversionPerCampaign StrategyPayForConversionPerCampaignAdd Parameters of the Optimizing the number of conversions strategy, pay per conversion. When the BiddingStrategyType parameter has the value PAY_FOR_CONVERSION_PER_CAMPAIGN.
NetworkDefault StrategyNetworkDefaultAdd

Settings for impressions in ad networks based on the settings for search. Pass an empty structure for this strategy.

When the BiddingStrategyType parameter has the value NETWORK_DEFAULT
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.

No
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
GoalId long

ID of a Yandex.Metrica goal (only non-composite goals are appropriate). 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
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
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.

No
FilterAverageCpc long

The default average CPC for each filter 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 (only non-composite goals are appropriate). 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
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
StrategyAverageCpcPerCampaignAdd structure
AverageCpс 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
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
FilterAverageCpс long

The default average CPC for each filter 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
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
StrategyAverageRoiAdd structure
ReserveReturn int

The maximum percent of saved funds that can be returned to advertising (spent) if the forecasted return on investment exceeds the value of the RoiCoef parameter.

A value from 0 to 100 as a multiple of ten: 0, 10, 20... 100.

Yes
RoiCoef long The desired average return on investment per week. The value represents the ratio of profit from sales to advertising expenses, multiplied by 1,000,000. The value must be an integer. If the value is not a multiple of 10,000, the last 4 digits are reset to zero (which is the same as discarding extra digits after the decimal point). Yes
GoalId long

ID of a Yandex.Metrica goal (only non-composite goals are appropriate). For more information about goals, see Goals and conversions in the Help for Yandex.Metrica.

The value 0 indicates all goals that are configured on the site (except multi-step goals).

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

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

Yes
WeeklySpendLimit long

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

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

No
BidCeiling long

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

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

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

The percentage of revenue that is the cost value of products or services.

The value is a percent multiplied by 1,000,000. The value must be an integer from 0 to 100,000,000 (which equals 100%). If the value is not a multiple of 10,000, the last 4 digits are reset to zero (which is the same as discarding extra digits after the decimal point).

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 (only non-composite goals are appropriate). For more information about goals, see Goals and conversions in the Help for Yandex.Metrica.

The value 0 indicates all goals that are configured on the site (except multi-step goals).

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