get: SmartCampaign parameters

Response structure in JSON format:

{
  "result": {
    "Campaigns": [{  /* CampaignGetItem */
      ...
      "SmartCampaign": {  /* SmartCampaignGetItem */
        "CounterId": (long),
        "TrackingParams" : (string),
        "AttributionModel": ( "LC" | "LSC" | "FC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
        "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 */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
              "AverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long), /* nillable */
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
              "FilterAverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long), /* nillable */
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long), /* nillable */
              "Profitability": (long), /* nillable */
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "PayForConversionCrr": {  /* StrategyAverageCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
            },
            "AverageCrr": {  /* StrategyPayForConversionCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
            },
            "PayForConversionPerFilter" : { /* StrategyPayForConversionPerFilter */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
            }
          },
          "Network": {  /* SmartCampaignNetworkStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
            "AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
              "FilterAverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
              "AverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long), /* nillable */
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
              "FilterAverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long), /* nillable */
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "BidCeiling": (long), /* nillable */
              "Profitability": (long), /* nillable */
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "AverageCrr": {  /* StrategyAverageCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "PayForConversionCrr": {  /* StrategyAverageCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
            },
            "PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
            },
            "PayForConversionPerFilter" : { /* StrategyPayForConversionPerFilter */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* 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 */
       }, ... ],
       "PriorityGoals": { /* PriorityGoalsArray */
         "Items": [{ /* PriorityGoalsItem */
           "GoalId": (long), /* required */
           "Value": (long), /* required */
           "IsMetrikaSourceOfValue": ( "YES" | "NO" )
         }, ... ] /* required */
       }, /* nillable */
       "PackageBiddingStrategy" : { /* nillable */
          "StrategyId" : (long), /* required */
          "Platforms" : { /* required */
            "Search" : ( "YES" | "NO" ) /* required */,
            "Network" : ( "YES"| "NO" ) /* required */
          }
        },
       "CanBeUsedAsPackageBiddingStrategySource" : ( "YES" | "NO" )
      }
    }, ... ],
    "LimitedBy": (long)
  }
}

Parameter

Type

Description

SmartCampaignGetItem structure

CounterId

long

ID of the Yandex.Metrica tag installed on the advertiser's site (see Metrica: Advertising campaign performance evaluation).

TrackingParams

string

URL parameters for templates.

AttributionModel

AttributionModelEnum

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

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 cross-device click from Yandex Direct.
  • AUTO – Automatic attribution.

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 to obtain the maximum number of engaged sessions (see Engaged session figures in the Yandex Direct Help).

You can't add more than 30 priority goals.

PackageBiddingStrategy

SmartCampaignPackageBiddingStrategyGet, nillable

Information about the portfolio strategy.

Null (nil): The campaign is not part of the portfolio strategy.

CanBeUsedAsPackageBiddingStrategySource

string

Shows if the strategy for this campaign can be portfolio.

SmartCampaignSettingGet structure

Option

SmartCampaignSettingsGetEnum

Setting name:

  • ADD_TO_FAVORITES
  • REQUIRE_SERVICING
  • SHARED_ACCOUNT_ENABLED
  • DAILY_BUDGET_ALLOWED
  • ENABLE_AREA_OF_INTEREST_TARGETING

value

YesNoEnum

Setting value.

PriorityGoalsArray structure

Items

array of PriorityGoalsItem

A set of priority goals and corresponding conversion values.

SmartCampaignPackageBiddingStrategyGet structure

StrategyId

long

Portfolio strategy ID.

Platforms

SmartCampaignPlatforms

Ad placement platform.

SmartCampaignPlatforms structure

Search

YesNoEnum

Search results.

Network

YesNoEnum

Yandex Advertising Network.

PriorityGoalsItem structure

GoalId

long

ID of the Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see Goals and conversions in the 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 goal “Engaged sessions”.

value

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.

IsMetrikaSourceOfValue

YesNoEnum

Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio.

SmartCampaignStrategy structure

Search

SmartCampaignSearchStrategy

Display strategy in search results.

Network

SmartCampaignNetworkStrategy

Display strategy in ad networks.

SmartCampaignSearchStrategy structure

BiddingStrategyType

SmartCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

  • AVERAGE_CPA_PER_CAMPAIGN
  • AVERAGE_CPA_PER_FILTER
  • AVERAGE_CPC_PER_CAMPAIGN
  • AVERAGE_CPC_PER_FILTER
  • AVERAGE_ROI
  • AVERAGE_CRR
  • PAY_FOR_CONVERSION_CRR
  • PAY_FOR_CONVERSION_PER_CAMPAIGN
  • PAY_FOR_CONVERSION_PER_FILTER
  • SERVING_OFF
  • UNKNOWN

AverageCpaPerCampaign

StrategyAverageCpaPerCampaign

Parameters of the Optimizing the number of conversions strategy with per-campaign CPA.

AverageCpaPerFilter

StrategyAverageCpaPerFilter

Parameters of the Optimizing the number of conversions strategy with per-filter CPA.

AverageCpcPerCampaign

StrategyAverageCpcPerCampaign

Parameters of the Optimizing the number of clicks strategy with per-campaign CPC.

AverageCpcPerFilter

StrategyAverageCpcPerFilter

Parameters of the Optimizing the number of clicks strategy with per-filter CPC.

AverageRoi

StrategyAverageRoi

Parameters of the Optimize ROI strategy.

AverageCrr

StrategyAverageCrr

Parameters of the strategy Optimize cost revenue ratio. Maintain the average cost revenue ratio.

PayForConversionCrr

StrategyPayForConversionCrr

Parameters of the strategy Optimize cost revenue ratio. Pay per conversion.

PayForConversionPerCampaign

StrategyPayForConversionPerCampaign

Parameters of the Optimizing the number of conversions strategy. Pay per conversion.

PayForConversionPerFilter

StrategyPayForConversionPerFilter

Parameters of the Optimizing the number of conversions strategy. Pay per conversion per filter.

SmartCampaignNetworkStrategy structure

BiddingStrategyType

SmartCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

  • AVERAGE_CPA_PER_CAMPAIGN
  • AVERAGE_CPA_PER_FILTER
  • AVERAGE_CPC_PER_CAMPAIGN
  • AVERAGE_CPC_PER_FILTER
  • AVERAGE_ROI
  • AVERAGE_CRR
  • PAY_FOR_CONVERSION_CRR
  • NETWORK_DEFAULT
  • PAY_FOR_CONVERSION_PER_CAMPAIGN
  • PAY_FOR_CONVERSION_PER_FILTER
  • SERVING_OFF
  • UNKNOWN

AverageCpaPerCampaign

StrategyAverageCpaPerCampaign

Parameters of the Optimizing the number of conversions strategy with per-campaign CPA.

AverageCpaPerFilter

StrategyAverageCpaPerFilter

Parameters of the Optimizing the number of conversions strategy with per-filter CPA.

AverageCpcPerCampaign

StrategyAverageCpcPerCampaign

Parameters of the Optimizing the number of clicks strategy with per-campaign CPC.

AverageCpcPerFilter

StrategyAverageCpcPerFilter

Parameters of the Optimizing the number of clicks strategy with per-filter CPC.

AverageRoi

StrategyAverageRoi

Parameters of the Optimize ROI strategy.

AverageCrr

StrategyAverageCrr

Parameters of the strategy Optimize cost revenue ratio. Maintain the average cost revenue ratio.

PayForConversionCrr

StrategyPayForConversionCrr

Parameters of the strategy Optimize cost revenue ratio. Pay per conversion.

PayForConversionPerCampaign

PayForConversionPerCampaign

Parameters of the Optimizing the number of conversions strategy. Pay per conversion.

PayForConversionPerFilter

PayForConversionPerFilter

Parameters of the Optimizing the number of conversions strategy. Pay per conversion per filter.

StrategyAverageCpaPerCampaign structure

AverageCpa

long

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

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

GoalId

long

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

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.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

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.

ExplorationBudget

ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

StrategyAverageCpaPerFilter structure

FilterAverageCpa

long

The average default goal cost per filter in the advertiser's currency, multiplied by 1,000,000.

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

GoalId

long

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

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.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

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.

ExplorationBudget

ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

StrategyAverageCpcPerCampaign structure

AverageCpc

long

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

The minimum value for the average CPC 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.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

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

FilterAverageCpc

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.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

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 between sales profits and ad costs, 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 decimal digits).

GoalId

long

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

The value 13 indicates priority goals. Allowed if the 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.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

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 percentage multiplied by 1,000,000. The value must be an integer between 0 and 100,000,000 (which corresponds to 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 decimal digits).

ExplorationBudget

ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

StrategyAverageCrr structure

Crr

int

Average cost revenue ratio.

GoalId

long

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

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

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.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

ExplorationBudget

ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

StrategyPayForConversionCrr structure

Crr

int

Average cost revenue ratio.

GoalId

long

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

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

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.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

StrategyPayForConversionPerCampaign structure

Cpa

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.

GoalId

long

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

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 Cpa parameter, multiplied by 20. To get the list of currencies, use the Dictionaries.get method.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

StrategyPayForConversionPerFilter structure

Cpa

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.

GoalId

long

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

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 Cpa parameter, multiplied by 20. To get the list of currencies, use the Dictionaries.get method.

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.

BudgetType

BudgetTypeEnum

Type of budget:

  • WEEKLY_BUDGET — Weekly budget.
  • CUSTOM_PERIOD_BUDGET — Budget for a custom period.

ExplorationBudget structure

MinimumExplorationBudget

long

Minimum budget value.

Acceptable value: between 0 and the weekly budget (if set).

IsMinimumExplorationBudgetCustom

YesNoEnum

A flag indicating a custom minimum budget.

CustomPeriodBudget structure

SpendLimit

long

Budget size for a custom period.

StartDate

string

Start of the budget period.

EndDate

string

End of the budget period.

AutoContinue

YesNoEnum

Flag to autocontinue the budget period.