update: DynamicTextCampaign 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": "update",
  "params": {
    "Campaigns": [{  /* CampaignUpdateItem */
      ...
      "DynamicTextCampaign": {  /* DynamicTextCampaignUpdateItem */
        "BiddingStrategy": {  /* DynamicTextCampaignStrategy */
          "Search": {  /* DynamicTextCampaignSearchStrategy */
            "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 */
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "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 */
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "AverageCrr": {  /* StrategyAverageCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "ExplorationBudget" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "PayForConversionCrr": {  /* StrategyPayForConversionCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
            },
            "PayForConversion" : { /* StrategyPayForConversion */
              "Cpa" : (long),
              "GoalId" : (long),
              "WeeklySpendLimit" : (long) /* nillable */
            }
          },
          "Network": {  /* DynamicTextCampaignNetworkStrategy */
            "BiddingStrategyType": ( "SERVING_OFF" ) /* required */
          }
        },
        "Settings": [{  /* DynamicTextCampaignSetting */
          "Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "PlacementTypes": [{  /* DynamicTextCampaignPlacementTypes */
          "Type": ( "SEARCH_RESULTS" | "PRODUCT_GALLERY" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        }, /* nillable */
        "PriorityGoals": { /* PriorityGoalsUpdateSetting */
          "Items": [{ /* PriorityGoalsUpdateItem */
            "GoalId": (long), /* required */
            "Value": (long), /* required */ 
            "Operation": ( "SET" ), /* required */
            "IsMetrikaSourceOfValue": ( "YES" | "NO" )
          }, ... ] /* required */
        }, /* nillable */
        "TrackingParams" : (string),
        "AttributionModel": ( "FC" | "LC" | "LSC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
        "PackageBiddingStrategy": {
          "StrategyId": (long),
          "StrategyFromCampaignId": (long)
        }
      }
    }, ... ] /* required */
  }
}
Parameter Type Description Required
DynamicTextCampaignUpdateItem structure
Settings array of DynamicTextCampaignSetting Array of settings that only accept the values YES or NO. No
PlacementTypes array of DynamicTextCampaignPlacementTypes Ad placements in search results. No
CounterIds ArrayOfInteger, nillable The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). No
BiddingStrategy DynamicTextCampaignStrategy Display strategy. No
TrackingParams string

URL parameters for templates.

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.
  • FCCD – First cross-device click.
  • LSCCD – Last significant (non-direct) cross-device click.
  • LYDCCD – Last Yandex Direct cross-device click.
  • AUTO – Automatic attribution.
No
PackageBiddingStrategy DynamicTextCampaignPackageBiddingStrategyUpdate, nillable

Links a campaign to the specified strategy. If Null (nil), the campaign is unlinked from the portfolio strategy. In this case, be sure to pass a new value for BiddingStrategy.

You can't pass the following parameters in this field:

  • BiddingStrategy
  • PriorityGoals
  • CounterIds
  • AttributionModel

To pass those parameters, unlink the campaign from the portfolio strategy by specifying a new value for BiddingStrategy and resetting the PackageBiddingStrategy: null parameter value.

No
PriorityGoals PriorityGoalsUpdateSetting, 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).

You can't add more than 30 priority goals.

No
DynamicTextCampaignSetting structure
Option DynamicTextCampaignSettingsEnum

Setting name:

Yes
Value YesNoEnum Setting value. Yes
DynamicTextCampaignPlacementTypes structure
Type DynamicTextCampaignPlacementTypesEnum

Type of ad placement in search results:

  • SEARCH_RESULTS — In search results.
  • PRODUCT_GALLERY — In the product gallery.
Yes
Value YesNoEnum Setting value. Yes
PriorityGoalsUpdateSetting structure
Items array of PriorityGoalsUpdateItem A new set of priority goals and conversion values to replace the existing set. Yes
PriorityGoalsUpdateItem 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
Operation OperationEnum

Type of action with the set of priority goals. Currently, only the SET value is available.

Yes
IsMetrikaSourceOfValue YesNoEnum Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio. If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR
DynamicTextCampaignPackageBiddingStrategyUpdate structure
StrategyId long Portfolio strategy ID. No
StrategyFromCampaignId long ID of the campaign the portfolio strategy was created from. No
DynamicTextCampaignStrategy structure
Network DynamicTextCampaignNetworkStrategy Display strategy in ad networks. No
DynamicTextCampaignSearchStrategy structure
BiddingStrategyType DynamicTextCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

Yes
WbMaximumClicks StrategyMaximumClicks Parameters of the Optimize clicks strategy. Limit by weekly budget. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS
WbMaximumConversionRate StrategyMaximumConversionRate Parameters of the Optimize conversions strategy without specifying the average CPA. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE
AverageCpc StrategyAverageCpc Parameters of the Optimize clicks strategy. Limit by average CPC. When the BiddingStrategyType parameter has the value AVERAGE_CPC
AverageCpa StrategyAverageCpa Parameters of the Optimize conversions strategy and keep the average CPA. When the BiddingStrategyType parameter has the value AVERAGE_CPA
AverageRoi StrategyAverageRoi Parameters of the Optimize ROI strategy. When the BiddingStrategyType parameter has the value AVERAGE_ROI
AverageCrr StrategyAverageCrr Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio When the BiddingStrategyType parameter is set to AVERAGE_CRR
PayForConversionCrr StrategyPayForConversionCrr Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR
PayForConversion StrategyPayForConversion Parameters of the Optimizing conversions strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION
WeeklyClickPackage StrategyWeeklyClickPackage

Parameters of the Optimize clicks strategy. Limit by click package.

Restriction.

The parameter is deprecated and no longer supported.

When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE
DynamicTextCampaignNetworkStrategy structure
BiddingStrategyType DynamicTextCampaignNetworkStrategyTypeEnum The type of display strategy in ad networks. The only available value is SERVING_OFF. Yes
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.

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

No
GoalId long

ID of a Yandex Metrica goal. 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.

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

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

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

No
GoalId long

ID of a Yandex Metrica goal. 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.

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

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

Minimum budget. Read more in Yandex Direct Help.

If the field is not set, the minimum budget won't change.

To set the default value, pass ExplorationBudget=NULL.

To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES".

If IsMinimumExplorationBudgetCustom is NO, the operation raises an error.

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

No
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 four digits are reset to zero, which is the same as discarding extra decimal digits. No
GoalId long

ID of a Yandex Metrica goal. 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.

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

No
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.
No
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 four digits are reset to zero, which is the same as discarding extra decimal digits.

No
ExplorationBudget ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

If the field is not set, the minimum budget won't change.

To set the default value, pass ExplorationBudget=NULL.

To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES".

If IsMinimumExplorationBudgetCustom is NO, the operation raises an error.

No
StrategyAverageCrr structure
Crr int

Average cost revenue ratio.

Yes
GoalId long

ID of a Yandex Metrica goal. 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
ExplorationBudget ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

If the field is not set, the minimum budget won't change.

To set the default value, pass ExplorationBudget=NULL.

To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES".

If IsMinimumExplorationBudgetCustom is NO, the operation raises an error.

No
StrategyPayForConversionCrr structure
Crr int

Average cost revenue ratio.

Yes
GoalId long

ID of a Yandex Metrica goal. 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
StrategyPayForConversion 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.

No
GoalId long

ID of a Yandex Metrica goal. 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.

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

No
StrategyWeeklyClickPackage structure
ClicksPerWeek long Desired number of clicks per week. No
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. If the BidCeiling parameter was set previously and now you want to set AverageCpc, make sure to simultaneously pass null (nil) for BidCeiling.
No
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. If the AverageCpc parameter was set previously and now you want to set BidCeiling, make sure to simultaneously pass null (nil) for AverageCpc.
No
ExplorationBudget structure
MinimumExplorationBudget long

Minimum budget value.

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

Yes, if the request includes the ExplorationBudget structure.
IsMinimumExplorationBudgetCustom YesNoEnum A flag indicating a custom minimum budget. Yes, if the request includes the ExplorationBudget structure.
Parameter Type Description Required
DynamicTextCampaignUpdateItem structure
Settings array of DynamicTextCampaignSetting Array of settings that only accept the values YES or NO. No
PlacementTypes array of DynamicTextCampaignPlacementTypes Ad placements in search results. No
CounterIds ArrayOfInteger, nillable The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). No
BiddingStrategy DynamicTextCampaignStrategy Display strategy. No
TrackingParams string

URL parameters for templates.

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.
  • FCCD – First cross-device click.
  • LSCCD – Last significant (non-direct) cross-device click.
  • LYDCCD – Last Yandex Direct cross-device click.
  • AUTO – Automatic attribution.
No
PackageBiddingStrategy DynamicTextCampaignPackageBiddingStrategyUpdate, nillable

Links a campaign to the specified strategy. If Null (nil), the campaign is unlinked from the portfolio strategy. In this case, be sure to pass a new value for BiddingStrategy.

You can't pass the following parameters in this field:

  • BiddingStrategy
  • PriorityGoals
  • CounterIds
  • AttributionModel

To pass those parameters, unlink the campaign from the portfolio strategy by specifying a new value for BiddingStrategy and resetting the PackageBiddingStrategy: null parameter value.

No
PriorityGoals PriorityGoalsUpdateSetting, 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).

You can't add more than 30 priority goals.

No
DynamicTextCampaignSetting structure
Option DynamicTextCampaignSettingsEnum

Setting name:

Yes
Value YesNoEnum Setting value. Yes
DynamicTextCampaignPlacementTypes structure
Type DynamicTextCampaignPlacementTypesEnum

Type of ad placement in search results:

  • SEARCH_RESULTS — In search results.
  • PRODUCT_GALLERY — In the product gallery.
Yes
Value YesNoEnum Setting value. Yes
PriorityGoalsUpdateSetting structure
Items array of PriorityGoalsUpdateItem A new set of priority goals and conversion values to replace the existing set. Yes
PriorityGoalsUpdateItem 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
Operation OperationEnum

Type of action with the set of priority goals. Currently, only the SET value is available.

Yes
IsMetrikaSourceOfValue YesNoEnum Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio. If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR
DynamicTextCampaignPackageBiddingStrategyUpdate structure
StrategyId long Portfolio strategy ID. No
StrategyFromCampaignId long ID of the campaign the portfolio strategy was created from. No
DynamicTextCampaignStrategy structure
Search DynamicTextCampaignSearchStrategy Display strategy in search results. No
Network DynamicTextCampaignNetworkStrategy Display strategy in ad networks. No
DynamicTextCampaignSearchStrategy structure
BiddingStrategyType DynamicTextCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

Yes
WbMaximumClicks StrategyMaximumClicks Parameters of the Optimize clicks strategy. Limit by weekly budget. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS
WbMaximumConversionRate StrategyMaximumConversionRate Parameters of the Optimize conversions strategy without specifying the average CPA. When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE
AverageCpc StrategyAverageCpc Parameters of the Optimize clicks strategy. Limit by average CPC. When the BiddingStrategyType parameter has the value AVERAGE_CPC
AverageCpa StrategyAverageCpa Parameters of the Optimize conversions strategy and keep the average CPA. When the BiddingStrategyType parameter has the value AVERAGE_CPA
AverageRoi StrategyAverageRoi Parameters of the Optimize ROI strategy. When the BiddingStrategyType parameter has the value AVERAGE_ROI
AverageCrr StrategyAverageCrr Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio When the BiddingStrategyType parameter is set to AVERAGE_CRR
PayForConversionCrr StrategyPayForConversionCrr Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR
PayForConversion StrategyPayForConversion Parameters of the Optimizing conversions strategy. Pay per conversion. If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION
WeeklyClickPackage StrategyWeeklyClickPackage

Parameters of the Optimize clicks strategy. Limit by click package.

Restriction.

The parameter is deprecated and no longer supported.

When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE
DynamicTextCampaignNetworkStrategy structure
BiddingStrategyType DynamicTextCampaignNetworkStrategyTypeEnum The type of display strategy in ad networks. The only available value is SERVING_OFF. Yes
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.

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

No
GoalId long

ID of a Yandex Metrica goal. 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.

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

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

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

No
GoalId long

ID of a Yandex Metrica goal. 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.

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

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

Minimum budget. Read more in Yandex Direct Help.

If the field is not set, the minimum budget won't change.

To set the default value, pass ExplorationBudget=NULL.

To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES".

If IsMinimumExplorationBudgetCustom is NO, the operation raises an error.

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

No
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 four digits are reset to zero, which is the same as discarding extra decimal digits. No
GoalId long

ID of a Yandex Metrica goal. 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.

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

No
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.
No
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 four digits are reset to zero, which is the same as discarding extra decimal digits.

No
ExplorationBudget ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

If the field is not set, the minimum budget won't change.

To set the default value, pass ExplorationBudget=NULL.

To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES".

If IsMinimumExplorationBudgetCustom is NO, the operation raises an error.

No
StrategyAverageCrr structure
Crr int

Average cost revenue ratio.

Yes
GoalId long

ID of a Yandex Metrica goal. 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
ExplorationBudget ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

If the field is not set, the minimum budget won't change.

To set the default value, pass ExplorationBudget=NULL.

To set a custom minimum budget, use the MinimumExplorationBudget parameter and set IsMinimumExplorationBudgetCustom="YES".

If IsMinimumExplorationBudgetCustom is NO, the operation raises an error.

No
StrategyPayForConversionCrr structure
Crr int

Average cost revenue ratio.

Yes
GoalId long

ID of a Yandex Metrica goal. 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
StrategyPayForConversion 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.

No
GoalId long

ID of a Yandex Metrica goal. 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.

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

No
StrategyWeeklyClickPackage structure
ClicksPerWeek long Desired number of clicks per week. No
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. If the BidCeiling parameter was set previously and now you want to set AverageCpc, make sure to simultaneously pass null (nil) for BidCeiling.
No
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. If the AverageCpc parameter was set previously and now you want to set BidCeiling, make sure to simultaneously pass null (nil) for AverageCpc.
No
ExplorationBudget structure
MinimumExplorationBudget long

Minimum budget value.

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

Yes, if the request includes the ExplorationBudget structure.
IsMinimumExplorationBudgetCustom YesNoEnum A flag indicating a custom minimum budget. Yes, if the request includes the ExplorationBudget structure.