get: 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.

Response structure in JSON format:

{
  "result": {
    "Campaigns": [{  /* CampaignGetItem */
      ...
      "SmartCampaign": {  /* SmartCampaignGetItem */
        "CounterId": (long),
        "AttributionModel": ( "LC" | "LSC" | "FC" | "LYDC" ),
        "BiddingStrategy": {  /* SmartCampaignStrategy */
          "Search": {  /* SmartCampaignSearchStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
            "AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
              "FilterAverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
              "AverageCpa": (long), /* nillable */
              "AverageCpc": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
              "FilterAverageCpa": (long), /* nillable */
              "FilterAverageCpc": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "Profitability": (long) /* nillable */
            },
            "PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long) /* nillable */
            }
          },
          "Network": {  /* SmartCampaignNetworkStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
            "AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
              "FilterAverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
              "AverageCpa": (long), /* nillable */
              "AverageCpc": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
              "FilterAverageCpa": (long), /* nillable */
              "FilterAverageCpc": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "Profitability": (long) /* nillable */
            },
            "PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long) /* nillable */
            }
          } 
        },
       "Settings": [{ /* SmartCampaignSettingGet */
         "Option": ( "ADD_TO_FAVORITES" | "REQUIRE_SERVICING" | "SHARED_ACCOUNT_ENABLED" | "DAILY_BUDGET_ALLOWED" | "ENABLE_AREA_OF_INTEREST_TARGETING" ) /* required */,
         "Value" : ("YES"|"NO") /* required */
       }, .. (unbounded)],
       "PriorityGoals": { /* PriorityGoalsArray */
         "Items": [{ /* PriorityGoalsItem */
           "GoalId": (long), /* required */ 
           "Value": (long) /* required */ 
         }, ... ] /* required */
       } /* nillable */
      }
    }, ... ],
    "LimitedBy": (long)
  }
}
Parameter Type Description
SmartCampaignGetItem structure
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).
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.
BiddingStrategy SmartCampaignStrategy Display strategy.
Settings array of SmartCampaignSettingGet Array of settings that only accept the values YES or NO.
PriorityGoals PriorityGoalsArray, nillable

Priority goals for automatic bid adjustments.

null (nil) — Delete the set of priority goals. In this case, automatic bid adjustments are used for obtaining the maximum number of engaged sessions (see Engaged session figures in the Help for Yandex.Direct).

SmartCampaignSettingGet structure
Option SmartCampaignSettingsGetEnum

Setting name:

Value YesNoEnum Setting value.
PriorityGoalsArray structure
Items array of PriorityGoalsItem A set of priority goals and corresponding conversion values.
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”.

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.
SmartCampaignStrategy structure
Network SmartCampaignNetworkStrategy Display strategy in ad networks.
SmartCampaignSearchStrategy structure
BiddingStrategyType SmartCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

AverageCpaPerCampaign StrategyAverageCpaPerCampaign Parameters of the Optimizing the number of conversions strategy with CPA for the entire campaign.
AverageCpaPerFilter StrategyAverageCpaPerFilter Parameters of the Optimizing the number of conversions strategy with CPA for each filter.
AverageCpcPerCampaign StrategyAverageCpсPerCampaign Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign.
AverageCpcPerFilter StrategyAverageCpсPerFilter Parameters of the Optimizing the number of clicks strategy with CPC for each filter.
AverageRoi StrategyAverageRoi Parameters of the Optimize ROI strategy.
PayForConversionPerCampaign StrategyPayForConversionPerCampaign Parameters of the Optimizing the number of conversions strategy, pay per conversion.
SmartCampaignNetworkStrategy structure
BiddingStrategyType SmartCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

AverageCpaPerCampaign StrategyAverageCpaPerCampaign Parameters of the Optimizing the number of conversions strategy with CPA for the entire campaign.
AverageCpaPerFilter StrategyAverageCpaPerFilter Parameters of the Optimizing the number of conversions strategy with CPA for each filter.
AverageCpcPerCampaign StrategyAverageCpсPerCampaign Parameters of the Optimizing the number of clicks strategy with CPC for the entire campaign.
AverageCpcPerFilter StrategyAverageCpсPerFilter Parameters of the Optimizing the number of clicks strategy with CPC for each filter.
AverageRoi StrategyAverageRoi Parameters of the Optimize ROI strategy.
PayForConversionPerCampaign PayForConversionPerCampaign Parameters of the Optimizing the number of conversions strategy, pay per conversion.
StrategyAverageCpaPerCampaign structure
AverageCpa long, nillable

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

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

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.

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.

WeeklySpendLimit long, nillable

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

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

BidCeiling long, nillable

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

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

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
StrategyAverageCpaPerFilter structure
FilterAverageCpa long, nillable

The average cost of a conversion for each filter by default in the advertiser's currency, multiplied by 1,000,000.

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

FilterAverageCpc long
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.

WeeklySpendLimit long, nillable

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

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

BidCeiling long, nillable

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

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

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
StrategyAverageCpcPerCampaign 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.

WeeklySpendLimit long, nillable

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

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

BidCeiling long, nillable

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

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

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
StrategyAverageCpcPerFilter structure
FilterAverageCpс long
WeeklySpendLimit long, nillable

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

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

BidCeiling long, nillable

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

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

Note. We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.
StrategyAverageRoi structure
ReserveReturn int

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

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

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).
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 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.

WeeklySpendLimit long, nillable

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

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

BidCeiling long, nillable

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

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

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

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

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

StrategyPayForConversionPerCampaign structure
Cpa long

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

The minimum and maximum CPA values are listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

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.

WeeklySpendLimit long, nillable

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

The minimum weekly budget for each currency must be at least the value of the Cpaparameter, multiplied by 20. To get the list of currencies, use the Dictionaries.get method.