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

Response structure in JSON format:

{
  "result": {
    "Campaigns": [{  /* CampaignGetItem */
      ...
      "TextCampaign": {  /* TextCampaignGetItem */
        "BiddingStrategy": {  /* TextCampaignStrategy */
          "Search": {  /* TextCampaignSearchStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long) /* nillable */
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRate */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "GoalId": (long)
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long) /* nillable */
            },
            "AverageCpa": {  /* StrategyAverageCpa */
              "AverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "Profitability": (long) /* nillable */
            }
          }, 
          "Network": {  /* TextCampaignNetworkStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefault */
              "LimitPercent": (int)
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long) /* nillable */
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRate */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "GoalId": (long)
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long) /* nillable */
            },
            "AverageCpa": {  /* StrategyAverageCpa */
              "AverageCpa": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "AverageRoi": {  /* StrategyAverageRoi */
              "ReserveReturn": (int),
              "RoiCoef": (long),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "Profitability": (long) /* nillable */
            }
          } 
        },
        "Settings": [{  /* TextCampaignSettingGet */
          "Option": ( "ADD_METRICA_TAG" | ... | "SHARED_ACCOUNT_ENABLED" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        }, /* nillable */
        "RelevantKeywords": {  /* RelevantKeywordsSetting */
          "BudgetPercent": (int),
          "OptimizeGoalId": (long) /* nillable */
        }, /* nillable */
        "PriorityGoals": { /* PriorityGoalsArray */
          "Items": [{ /* PriorityGoalsItem */
            "GoalId": (long), /* required */ 
            "Value": (long) /* required */ 
          }, ... ] /* required */
        }, /* nillable */
        "AttributionModel": ( "FC" | "LC" | "LSC" | "LYDC" )
      }
    }, ... ],
    "LimitedBy": (long)
  }
}
Parameter Type Description
TextCampaignGetItem structure
Settings array of TextCampaignSettingGet Array of settings that only accept the values YES or NO.
CounterIds ArrayOfInteger, nillable 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.
RelevantKeywords RelevantKeywordsSetting, nillable 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.
BiddingStrategy TextCampaignStrategy Display strategy.
PriorityGoals PriorityGoalsArray, nillable

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

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.
TextCampaignSettingGet structure
Option TextCampaignSettingsGetEnum

Setting name:

Value YesNoEnum Setting value.
RelevantKeywordsSetting structure
BudgetPercent int

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

OptimizeGoalId long, nillable

ID of a Yandex.Metrica goal. Statistics on conversions for this goal are used for optimizing related keywords.

All goals available for the campaign can be used, including composite (multi-step) goals. 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.

The following values are also allowed:

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

  • null (nil) — No optimization.

Attention. If the campaign has the strategy WB_MAXIMUM_CONVERSION_RATE, AVERAGE_CPA or AVERAGE_ROI, optimization is performed for the goal (or all goals) indicated in the GoalId parameter in the strategy settings, regardless of the value of the OptimizeGoalId parameter.
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 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.
TextCampaignStrategy structure
Network TextCampaignNetworkStrategy Display strategy in ad networks.
TextCampaignSearchStrategy structure
BiddingStrategyType TextCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

WbMaximumClicks StrategyMaximumClicks Parameters of the Optimize clicks strategy. Limit by weekly budget.
WbMaximumConversionRate StrategyMaximumConversionRate Parameters of the Optimize conversions strategy without specifying the average CPA.
AverageCpc StrategyAverageCpc Parameters of the Optimize clicks strategy. Limit by average CPC.
AverageCpa StrategyAverageCpa Parameters of the Optimize conversions strategy and keep the average CPA.
AverageRoi StrategyAverageRoi Parameters of the Optimize ROI strategy.
WeeklyClickPackage StrategyWeeklyClickPackage Parameters of the Optimize clicks strategy. Limit by click package.
TextCampaignNetworkStrategy structure
BiddingStrategyType TextCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

NetworkDefault StrategyNetworkDefault

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

If a search strategy other than HIGHEST_POSITION is selected, this structure is not returned.

WbMaximumClicks StrategyMaximumClicks Parameters of the Optimize clicks strategy. Limit by weekly budget.
WbMaximumConversionRate StrategyMaximumConversionRate Parameters of the Optimize conversions strategy without specifying the average CPA.
AverageCpc StrategyAverageCpc Parameters of the Optimize clicks strategy. Limit by average CPC.
AverageCpa StrategyAverageCpa Parameters of the Optimize conversions strategy and keep the average CPA.
AverageRoi StrategyAverageRoi Parameters of the Optimize ROI strategy.
WeeklyClickPackage StrategyWeeklyClickPackage Parameters of the Optimize clicks strategy. Limit by click package.
StrategyMaximumClicks 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.

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

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

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

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.

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

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.

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

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

StrategyWeeklyClickPackage structure
ClicksPerWeek long Desired number of clicks per week.
AverageCpc long, nillable

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.
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. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them.
StrategyNetworkDefault 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.