add: TextCampaign 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 */
      ...
      "TextCampaign": {  /* TextCampaignAddItem */
        "BiddingStrategy": {  /* TextCampaignStrategyAdd */
          "Search": {  /* TextCampaignSearchStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRateAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long),
              "GoalId": (long) /* required */
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long)
            },
            "AverageCpa": {  /* StrategyAverageCpaAdd */
              "AverageCpa": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            },
            "AverageRoi": {  /* StrategyAverageRoiAdd */
              "ReserveReturn": (int), /* required */
              "RoiCoef": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long),
              "Profitability": (long)
            }
          }, /* required */
          "Network": {  /* TextCampaignNetworkStrategyAdd */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefaultAdd */
              "LimitPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicksAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long)
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRateAdd */
              "WeeklySpendLimit": (long), /* required */
              "BidCeiling": (long),
              "GoalId": (long) /* required */
            },
            "AverageCpc": {  /* StrategyAverageCpcAdd */
              "AverageCpc": (long), /* required */
              "WeeklySpendLimit": (long)
            },
            "AverageCpa": {  /* StrategyAverageCpaAdd */
              "AverageCpa": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long)
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackageAdd */
              "ClicksPerWeek": (long), /* required */
              "AverageCpc": (long),
              "BidCeiling": (long)
            },
            "AverageRoi": {  /* StrategyAverageRoiAdd */
              "ReserveReturn": (int), /* required */
              "RoiCoef": (long), /* required */
              "GoalId": (long), /* required */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long),
              "Profitability": (long)
            }
          } /* required */
        }, /* required */
        "Settings": [{  /* TextCampaignSetting */
          "Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        },
        "RelevantKeywords": {  /* RelevantKeywordsSettingAdd */
          "BudgetPercent": (int), /* required */
          "OptimizeGoalId": (long) /* nillable */
        },
        "PriorityGoals": { /* PriorityGoalsArray */
          "Items": [{ /* PriorityGoalsItem */
            "GoalId": (long), /* required */ 
            "Value": (long) /* required */ 
          }, ... ] /* required */
        },
        "AttributionModel": ( "FC" | "LC" | "LSC" | "LYDC" )
      }
    }, ... ] /* required */
  }
}
Parameter Type Description Required
TextCampaignAddItem structure
BiddingStrategy TextCampaignStrategyAdd Display strategy. Yes
Settings array of TextCampaignSetting Array of settings that only accept the values YES or NO. No
CounterIds ArrayOfInteger IDs of Yandex.Metrica tags installed on the advertiser's website (see Yandex.Metrica: advertising campaign efficiency evaluation in the Help for Yandex.Direct). Maximum of 5 items in the array. No
RelevantKeywords RelevantKeywordsSettingAdd Settings for displays for related keywords (see Impressions for related keywords in the Help for Yandex.Direct). If this structure is omitted, displays for related keywords are disabled. 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
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 on Yandex.Direct ads.

The default value is LYDC.

No
TextCampaignSetting structure
Option TextCampaignSettingsEnum

Setting name:

Yes
Value YesNoEnum Setting value. Yes
RelevantKeywordsSettingAdd structure
BudgetPercent int

Maximum percent of the budget to be spent on clicks on related keywords (from 1 to 100).

Yes
OptimizeGoalId long, nillable

The ID of a Yandex.Metrica goal for optimizing related keywords.

You can't set a specific goal during campaign creation. The following values are allowed:

  • 0 — Related keywords are optimized for all the goals available for the campaign.

  • null (nil) — No optimization.

If the parameter is omitted, the default value is 0.

No
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 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
TextCampaignStrategyAdd structure
Network TextCampaignNetworkStrategyAdd Display strategy in ad networks. Yes
TextCampaignSearchStrategyAdd structure
BiddingStrategyType TextCampaignSearchStrategyTypeEnum

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
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
AverageRoi StrategyAverageRoiAdd Parameters of the Optimize ROI strategy. When the BiddingStrategyType parameter has the value AVERAGE_ROI
WeeklyClickPackage StrategyWeeklyClickPackageAdd Parameters of the Optimize clicks strategy. Limit by click package. When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE
TextCampaignNetworkStrategyAdd structure
BiddingStrategyType TextCampaignNetworkStrategyTypeEnum

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
NetworkDefault StrategyNetworkDefaultAdd

Settings for impressions in ad networks based on the settings for search.

If a search strategy other than HIGHEST_POSITION is selected, pass an empty structure.

When the BiddingStrategyType parameter has the value NETWORK_DEFAULT
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
AverageRoi StrategyAverageRoiAdd Parameters of the Optimize ROI strategy. When the BiddingStrategyType parameter has the value AVERAGE_ROI
WeeklyClickPackage StrategyWeeklyClickPackageAdd Parameters of the Optimize clicks strategy. Limit by click package. When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE
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
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 (only non-composite goals are appropriate). For more information about goals, see Goals and conversions in the Help for Metrica.

The value of 0 is all goals set on the site (except composite goals).

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

Yes
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
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
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 Metrica.

The value of 0 is all goals set on the site (except composite goals).

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

The value of 0 is all goals set on the site (except composite 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 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
StrategyWeeklyClickPackageAdd structure
ClicksPerWeek long Desired number of clicks per week. Yes
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.

Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them.
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. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them.
No
StrategyNetworkDefaultAdd structure
LimitPercent int

The maximum percentage of the budget to spend on displays in ad networks. The value is a multiple of ten: 10, 20, ..., 100. The default value is 100.

If a search strategy other than HIGHEST_POSITION is selected, the parameter is not used and the passed value is ignored.

No