update: DynamicTextCampaign parameters

Request structure in JSON format:

{
  "method": "update",
  "params": {
    "Campaigns": [{  /* CampaignUpdateItem */
      ...
      "DynamicTextCampaign": {  /* DynamicTextCampaignUpdateItem */
        "BiddingStrategy": {  /* DynamicTextCampaignStrategy */
          "Search": {  /* DynamicTextCampaignSearchStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "PlacementTypes" : {
              "SearchResults" : ( "YES" | "NO" ),
              "ProductGallery" : ( "YES" | "NO" ),
              "DynamicPlaces" : ( "YES" | "NO" )
            },
            "WbMaximumClicks": {  /* StrategyMaximumClicks */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "WbMaximumConversionRate": {  /* StrategyMaximumConversionRate */
              "WeeklySpendLimit": (long),
              "BidCeiling": (long), /* nillable */
              "GoalId": (long),
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            },
            "AverageCpc": {  /* StrategyAverageCpc */
              "AverageCpc": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
            },
            "AverageCpa": {  /* StrategyAverageCpa */
              "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" : { /* 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 */
              "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" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* 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" : { /* nillable */
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              }
            },
            "PayForConversionCrr": {  /* 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 */,
            },
            "PayForConversion" : { /* StrategyPayForConversion */
              "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": {  /* 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)
        },
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }
    }, ... ] /* 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 website (see Yandex Metrica: evaluate your ad performance in Yandex Direct Help).

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

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 these parameters, unlink the campaign from the portfolio strategy: specify a new value for BiddingStrategy and reset 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 Yandex Direct Help).

You can't add more than 30 priority goals.

No

NegativeKeywordSharedSetIds

ArrayOfLong, nillable

IDs of sets of negative keywords. Maximum of 3 items in the array.

To get the IDs of sets, use the NegativeKeywordSharedSets.get method.

No

DynamicTextCampaignSetting structure

Option

DynamicTextCampaignSettingsEnum

Setting name:

  • ADD_METRICA_TAG
  • ADD_OPENSTAT_TAG
  • ADD_TO_FAVORITES
  • ENABLE_AREA_OF_INTEREST_TARGETING
  • ENABLE_COMPANY_INFO
  • ENABLE_EXTENDED_AD_TITLE
  • ENABLE_SITE_MONITORING
  • REQUIRE_SERVICING

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

Yes

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.

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 cost 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:

  • HIGHEST_POSITION
  • WB_MAXIMUM_CLICKS
  • WB_MAXIMUM_CONVERSION_RATE
  • AVERAGE_CPC
  • AVERAGE_CPA
  • AVERAGE_ROI
  • AVERAGE_CRR
  • PAY_FOR_CONVERSION
  • PAY_FOR_CONVERSION_CRR
  • WEEKLY_CLICK_PACKAGE_TITLE

Yes

PlacementTypes

DynamicTextCampaignSearchStrategyPlacementTypes

Placements in search results.

No

WbMaximumClicks

StrategyMaximumClicks

Parameters of the Optimize clicks strategy. Limited by weekly budget.

When the BiddingStrategyType parameter is set to WB_MAXIMUM_CLICKS

WbMaximumConversionRate

StrategyMaximumConversionRate

Parameters of the Optimize conversions strategy without specifying the average CPA.

When the BiddingStrategyType parameter is set to WB_MAXIMUM_CONVERSION_RATE

AverageCpc

StrategyAverageCpc

Parameters of the Optimize clicks strategy. Limited by average CPC.

When the BiddingStrategyType parameter is set to AVERAGE_CPC

AverageCpa

StrategyAverageCpa

Parameters of the Optimize conversions strategy. Maintain the average CPA.

When the BiddingStrategyType parameter is set to AVERAGE_CPA

AverageRoi

StrategyAverageRoi

Parameters of the Optimize ROI strategy.

When the BiddingStrategyType parameter is set to AVERAGE_ROI

AverageCrr

StrategyAverageCrr

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

When the BiddingStrategyType parameter is set to AVERAGE_CRR

PayForConversionCrr

StrategyPayForConversionCrr

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

When the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR

PayForConversion

StrategyPayForConversion

Parameters of the Optimize conversions strategy. Pay per conversion.

When the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION

WeeklyClickPackage

StrategyWeeklyClickPackage

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

When the BiddingStrategyType parameter is set to WEEKLY_CLICK_PACKAGE

DynamicTextCampaignNetworkStrategy structure

BiddingStrategyType

DynamicTextCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks. Only one value is available: SERVING_OFF

Yes

DynamicTextCampaignSearchStrategyPlacementTypes structure

SearchResults

YesNoEnum

Search results.

No

ProductGallery

YesNoEnum

Product gallery.

No

DynamicPlaces

YesNoEnum

Dynamic placements in search results.

No

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

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.

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 the Yandex Metrica goal. For more information about goals, see Goals and conversions in 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.

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

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.

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

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.

No

BudgetType

BudgetTypeEnum

Type of budget:

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

If the budget type is changed while editing the campaign, the original type must be passed with a NULL value.

For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.

No

StrategyAverageCpa structure

AverageCpa

long

The average goal cost 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 the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help.

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

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.

No

BudgetType

BudgetTypeEnum

Type of budget:

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

If the budget type is changed while editing the campaign, the original type must be passed with a NULL value.

For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.

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 percentage 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 4 digits are reset to zero (which is the same as discarding extra decimal digits).

No

GoalId

long

ID of the Yandex Metrica goal. For more information about goals, see Goals and conversions in 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.

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

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.

No

BudgetType

BudgetTypeEnum

Type of budget:

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

If the budget type is changed while editing the campaign, the original type must be passed with a NULL value.

For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.

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

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 the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help.

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

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.

No

BudgetType

BudgetTypeEnum

Type of budget:

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

If the budget type is changed while editing the campaign, the original type must be passed with a NULL value.

For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.

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 the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help.

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

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.

No

BudgetType

BudgetTypeEnum

Type of budget:

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

If the budget type is changed while editing the campaign, the original type must be passed with a NULL value.

For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.

No

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

No

GoalId

long

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

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

No

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.

No

BudgetType

BudgetTypeEnum

Type of budget:

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

If the budget type is changed while editing the campaign, the original type must be passed with a NULL value.

For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field.

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 you've previously specified the BidCeiling parameter and now you want to set AverageCpc, 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 you've previously specified the AverageCpc parameter and now you want to set BidCeiling, 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.

CustomPeriodBudget structure

SpendLimit

long

Budget size for a custom period.

Yes

StartDate

string

Start of the budget period.

Yes

EndDate

string

End of the budget period.

Yes

AutoContinue

YesNoEnum

Flag to autocontinue the budget period.

Yes