update: UnifiedCampaign parameters

To manage a unified performance campaign, use the URL: https://api.direct.yandex.com/v501/.

Request structure in JSON format:

{
  "method": "update",
  "params": {
    "Campaigns": [{  /* CampaignUpdateItem */
      ...
      "UnifiedCampaign": {  /* UnifiedCampaignUpdateItem */
        "BiddingStrategy": {  /* UnifiedCampaignStrategy */
          "Search": {  /* UnifiedCampaignSearchStrategy */
            "BiddingStrategyType" : ("AVERAGE_CPC"|"AVERAGE_CPA"|"PAY_FOR_CONVERSION"|"WB_MAXIMUM_CONVERSION_RATE"|"HIGHEST_POSITION"|"SERVING_OFF"|"WB_MAXIMUM_CLICKS"|"AVERAGE_CRR"|"PAY_FOR_CONVERSION_CRR"), /* required */
            "PlacementTypes" : {
              "SearchResults" : ( "YES" | "NO" ),
              "ProductGallery" : ( "YES" | "NO" ),
              "DynamicPlaces" : ( "YES" | "NO" ),
              "Maps" : ( "YES" | "NO" ),
              "SearchOrganizationList" : ( "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 */
              }
            },
            "AverageCpaMultipleGoals": {  /* StrategyAverageCpaMultipleGoals */
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "AverageCrr": {  /* StrategyAverageCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "ExplorationBudget" : { /* 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 */,
            },
            "PayForConversionMultipleGoals" : { /* StrategyPayForConversionMultipleGoals */
              "WeeklySpendLimit" : (long) /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            }
          },
          "Network": {  /* UnifiedCampaignNetworkStrategy */
            "BiddingStrategyType" : ("AVERAGE_CPC"|"AVERAGE_CPA"|"PAY_FOR_CONVERSION"|"WB_MAXIMUM_CONVERSION_RATE"|"NETWORK_DEFAULT"|"SERVING_OFF"|"WB_MAXIMUM_CLICKS"|"AVERAGE_CRR"|"PAY_FOR_CONVERSION_CRR"), /* required */
            "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 */
              }
            },
            "AverageCpaMultipleGoals": {  /* StrategyAverageCpaMultipleGoals */
              "WeeklySpendLimit": (long), /* nillable */
              "BidCeiling": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* required */
              }
            },
            "AverageCrr": {  /* StrategyAverageCrr */
              "Crr": (int),
              "GoalId": (long),
              "WeeklySpendLimit": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "ExplorationBudget" : { /* 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 */,
            },
            "PlacementTypes" : {  /* UnifiedCampaignNetworkStrategyPlacementTypes */
              "Network" : ("YES"|"NO"),
              "Maps" : ("YES"|"NO")
            },
            "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 */,
            },
            "PayForConversionMultipleGoals" : { /* StrategyPayForConversionMultipleGoals */
              "WeeklySpendLimit" : (long) /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              }
            }
          }
        },
        "Settings": [{  /* UnifiedCampaignSetting */
          "Option" : ("ADD_METRICA_TAG"|"ADD_TO_FAVORITES"|"ENABLE_AREA_OF_INTEREST_TARGETING"|"ENABLE_SITE_MONITORING"|"REQUIRE_SERVICING"|"ENABLE_COMPANY_INFO"|"CAMPAIGN_EXACT_PHRASE_MATCHING_ENABLED" | "ALTERNATIVE_TEXTS_ENABLED"), /* 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),
          "Platforms" : { /* required */
            "SearchResult" : ( "YES" | "NO" ) /* required */,
            "ProductGallery" : ( "YES" | "NO" ) /* required */,
            "Maps" : ( "YES" | "NO" ),
            "SearchOrganizationList" : ( "YES" | "NO" ),
            "Network" : ( "YES" | "NO" ) /* required */,
            "DynamicPlaces" : ( "YES" | "NO" )
          }
        },
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        }
      }
    }, ... ] /* required */
  }
}

Parameter

Type

Description

Required

UnifiedCampaignUpdateItem structure

Settings

array of UnifiedCampaignSetting

Array of settings that only accept the values YES or NO.

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

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

UnifiedCampaignPackageBiddingStrategyUpdate, 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

BiddingStrategy

UnifiedCampaignStrategy

Display strategy.

No

PriorityGoals

PriorityGoalsUpdateSetting, nillable

Priority goals for automatic bid adjustments.

null (nil) — Delete the set of priority goals. In this case, automatic bid adjustments are used to obtain the maximum number of engaged sessions (see Engaged session figures in Yandex Direct Help).

When passing the AverageCpaMultipleGoals or PayForConversionMultipleGoals parameter.

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

UnifiedCampaignSetting structure

Option

UnifiedCampaignSettingsEnum

Setting name:

  • ADD_METRICA_TAG
  • ADD_TO_FAVORITES
  • CAMPAIGN_EXACT_PHRASE_MATCHING_ENABLED
  • ENABLE_AREA_OF_INTEREST_TARGETING
  • ENABLE_COMPANY_INFO
  • ENABLE_SITE_MONITORING
  • REQUIRE_SERVICING
  • ALTERNATIVE_TEXTS_ENABLED

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

UnifiedCampaignPackageBiddingStrategyUpdate structure

StrategyId

long

Portfolio strategy ID.

No

StrategyFromCampaignId

long

ID of the campaign the portfolio strategy was created from.

No

Platforms

UnifiedCampaignPlatforms

Ad placement platform.

No

UnifiedCampaignPlatforms structure

SearchResult

YesNoEnum

Search results.

Yes

ProductGallery

YesNoEnum

Product gallery.

Yes

Maps

YesNoEnum

Placement in Yandex Maps.

Yes

SearchOrganizationList

YesNoEnum

List of organizations in search results.

Yes

Network

YesNoEnum

Yandex Advertising Network.

Yes

DynamicPlaces

YesNoEnum

Dynamic placements in search results.

No

UnifiedCampaignStrategy structure

Search

UnifiedCampaignSearchStrategy

Display strategy in search results.

No

Network

UnifiedCampaignNetworkStrategy

Display strategy in ad networks.

No

UnifiedCampaignSearchStrategy structure

BiddingStrategyType

UnifiedCampaignSearchStrategyTypeEnum

The type of display strategy in search results:

  • WB_MAXIMUM_CLICKS
  • WB_MAXIMUM_CONVERSION_RATE
  • AVERAGE_CPC
  • AVERAGE_CPA
  • AVERAGE_CRR
  • HIGHEST_POSITION
  • PAY_FOR_CONVERSION
  • PAY_FOR_CONVERSION_CRR
  • SERVING_OFF

For information about the compatibility of strategies in search results and ad networks, see the section Display strategies.

Yes

PlacementTypes

UnifiedCampaignSearchStrategyPlacementTypes

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

AverageCpaMultipleGoals

StrategyAverageCpaMultipleGoalsAdd

Parameters of the Maximize conversions pay-per-click strategy. Maintain the average CPA for multiple goals.
Be sure to simultaneously pass the PriorityGoals array with at least two priority goals, and specify the target CPA for each goal as the Value.

When the BiddingStrategyType parameter is set to AVERAGE_CPA_MULTIPLE_GOALS

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

PayForConversionMultipleGoals

StrategyPayForConversionMultipleGoalsAdd

Parameters of the Maximize conversions pay-per-conversion strategy for each of the specified goals.
Be sure to simultaneously pass the PriorityGoals array with at least two priority goals, and specify the target CPA for each goal as the Value.

When the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION

UnifiedCampaignNetworkStrategy structure

BiddingStrategyType

UnifiedCampaignNetworkStrategyTypeEnum

The type of display strategy in ad networks:

  • NETWORK_DEFAULT
  • WB_MAXIMUM_CLICKS
  • WB_MAXIMUM_CONVERSION_RATE
  • AVERAGE_CPC
  • AVERAGE_CPA
  • AVERAGE_CRR
  • PAY_FOR_CONVERSION
  • PAY_FOR_CONVERSION_CRR
  • SERVING_OFF

For information about the compatibility of strategies in search results and ad networks, see the section Display strategies.

Yes

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

AverageCpaMultipleGoals

StrategyAverageCpaMultipleGoalsAdd

Parameters of the Maximize conversions pay-per-click strategy. Maintain the average CPA for multiple goals.
Be sure to simultaneously pass the PriorityGoals array with at least two priority goals, and specify the target CPA for each goal as the Value.

When the BiddingStrategyType parameter is set to AVERAGE_CPA_MULTIPLE_GOALS

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

PlacementTypes

UnifiedCampaignNetworkStrategyPlacementTypes

Placements in ad networks.

No

UnifiedCampaignSearchStrategyPlacementTypes structure

SearchResults

YesNoEnum

Search results.

No

ProductGallery

YesNoEnum

Product gallery.

No

DynamicPlaces

YesNoEnum

Dynamic placements in search results.

No

Maps

YesNoEnum

Placement in Yandex Maps.

When the BiddingStrategyNetworkPlacementTypesMaps parameter contains a value that isn't Null.

SearchOrganizationList

YesNoEnum

List of organizations 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

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

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

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

StrategyAverageCpaMultipleGoalsAdd 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

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

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

ExplorationBudget

ExplorationBudget

Minimum budget. Read more in Yandex Direct Help.

If the field is omitted, a default value is set for the strategy (it's calculated based on the strategy settings).

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

PayForConversionMultipleGoals structure

WeeklySpendLimit

long

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

UnifiedCampaignNetworkStrategyPlacementTypes structure

Network

YesNoEnum

Ad networks.

No

Maps

YesNoEnum

Yandex Maps.

When the BiddingStrategySearchPlacementTypesMaps parameter contains a value that isn't Null.

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