---
metadata:
  - name: generator
    content: Diplodoc Platform v5.52.0
alternate:
  - https://yandex.com/dev/direct/doc/en/campaigns/get-text-campaign.md
  - https://yandex.com/dev/direct/doc/ru/campaigns/get-text-campaign.md
  - href: en/campaigns/get-text-campaign.md
    type: text/markdown
    title: Markdown version
  - href: ../llms.txt
    type: text/markdown
    title: llms.txt
sourcePath: en/ref-v5/campaigns/get-text-campaign.md
---
> **Documentation Index:** Fetch the complete configuration index at https://yandex.com/dev/direct/doc/en/llms.txt

# get: TextCampaign parameters

Response structure in JSON format:

```javascript translate=no
{
  "result": {
    "Campaigns": [{  /* CampaignGetItem */
      ...
      "TextCampaign": {  /* TextCampaignGetItem */
        "BiddingStrategy": {  /* TextCampaignStrategy */
          "Search": {  /* TextCampaignSearchStrategy */
            "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 */
              "BidCeiling": (long), /* nillable */
              "CustomPeriodBudget": { /* nillable */
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* 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 */
              }
            },
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "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" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* 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")
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
            },
            "MaxProfit" : { /* StrategyMaxProfit */
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
            }
          },
          "Network": {  /* TextCampaignNetworkStrategy */
            "BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
            "NetworkDefault": {  /* StrategyNetworkDefault */
              "LimitPercent": (int)
            },
            "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" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* 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 */
              }
            }
            "WeeklyClickPackage": {  /* StrategyWeeklyClickPackage */
              "ClicksPerWeek": (long),
              "AverageCpc": (long), /* nillable */
              "BidCeiling": (long) /* nillable */
            },
            "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" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES"| "NO") /* 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")
              },
            },
            "MaxProfit" : { /* StrategyMaxProfit */
              "WeeklySpendLimit" : (long),
              "CustomPeriodBudget": {
                "SpendLimit": (long),
                "StartDate": (string),
                "EndDate": (string),
                "AutoContinue": ("YES" | "NO")
              },
              "ExplorationBudget" : {
                "MinimumExplorationBudget" : (long) /* required */,
                "IsMinimumExplorationBudgetCustom" : ("YES") /* required */
              },
              "BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */
            }
          }
        }, 
        "Settings": [{  /* TextCampaignSettingGet */
          "Option": ( "ADD_METRICA_TAG" | ... | "SHARED_ACCOUNT_ENABLED" ), /* required */
          "Value": ( "YES" | "NO" ) /* required */
        }, ... ],
        "CounterIds": {  /* ArrayOfInteger */
          "Items": [(int), ... ] /* required */
        }, /* nillable */
        "RelevantKeywords": {  /* RelevantKeywordsSetting */
          "BudgetPercent": (int),
          "OptimizeGoalId": (long) /* nillable */
        }, /* nillable */
        "PriorityGoals": { /* PriorityGoalsArray */
          "Items": [{ /* PriorityGoalsItem */
            "GoalId": (long), /* required */
            "Value": (long), /* required */
            "IsMetrikaSourceOfValue": ( "YES" | "NO" )
          }, ... ] /* required */
        }, /* nillable */
        "TrackingParams": (string),
        "AttributionModel": ( "FCCD" | "LC" | "LSCCD" | "AUTO" ),
        "PackageBiddingStrategy" : { /* nillable */
          "StrategyId" : (long), /* required */
          "Platforms" : { /* required */
            "SearchResult" : ( "YES" | "NO" ) /* required */,
            "ProductGallery" : ( "YES" | "NO" ) /* required */,
            "Network" : ( "YES" | "NO" ) /* required */,
            "DynamicPlaces" : ( "YES" | "NO" )
          }
        },
        "CanBeUsedAsPackageBiddingStrategySource" : ( "YES" | "NO" ),
        "NegativeKeywordSharedSetIds" : { /* nillable */
          "Items" : [ (long) ] /* required */
        },
      }
    }, ... ],
    "LimitedBy": (long)
  }
}
```


#|
||
**Parameter**
|
**Type**
|
**Description**
||

||
**TextCampaignGetItem structure**
||
||
`Settings`
|
array of TextCampaignSettingGet
|
Array of settings that only accept the values YES or NO.
||
||
`CounterIds`
|
ArrayOfInteger, nillable
|
The IDs of Yandex Metrica tags installed on the user's website (see [Yandex Metrica: evaluate your promotion performance](https://yandex.ru/support/direct/en/statistics/metrika) in Yandex Direct Help).
||
||
`RelevantKeywords`
|
RelevantKeywordsSetting, nillable
|
Settings for impressions for related keywords (see [Impressions for related keywords](https://yandex.ru/support/direct/en/impression-criteria/autotargeting) in the Yandex Direct Help). If this structure is omitted, displays for related keywords are disabled.


||
||
`BiddingStrategy`
|
TextCampaignStrategy
|
Display strategy.
||
||
`PriorityGoals`
|
PriorityGoalsArray, nillable
|
Priority goals for automatic bid adjustments.

If the array is omitted, automatic bid adjustments are used for obtaining the maximum number of engaged sessions (see [Engaged session figures](https://yandex.ru/support/direct/en/statistics/report-wizard-engagement-rating) in the Yandex Direct Help).

You can't add more than 30 priority goals.
||
||
`TrackingParams`
|
string
|
URL parameters for templates.
||
||
`AttributionModel`
|
AttributionModelEnum
|
The attribution model used for optimizing conversions (see [Attribution model](https://yandex.ru/support/direct/en/statistics/attribution-model) in Yandex Direct Help).

<!-- source: en/_includes/attribution-note.md -->
{% note alert "Updates to attribution models in Yandex Direct and Yandex Metrica" %}

Active campaigns using legacy models LSC, FC, LYDC, LYDCCD have automatically switched to their closest available cross-device versions or automatic attribution. This model update won't trigger strategy retraining.

Methods using deprecated models will automatically upgrade to supported models (LSC to LSCCD, FC to FCCD, LYDC/LYDCCD to AUTO) and return a warning that a different model is in use.

{% endnote %}
<!-- endsource: en/_includes/attribution-note.md -->

Possible values:

<!-- source: en/_includes/attribution-models.md -->
- FCCD — First click (cross-device).
- LC — Last click.
- LSCCD — Last non-direct click (cross-device).
- AUTO — Automatic attribution.
<!-- endsource: en/_includes/attribution-models.md -->
||
||
`PackageBiddingStrategy`
|
TextCampaignPackageBiddingStrategyGet, nillable
|
Information about the portfolio strategy.

Null (nil): The campaign is not part of the portfolio strategy.
||
||
`CanBeUsedAsPackageBiddingStrategySource`
|
YesNoEnum
|
Shows if the strategy for this campaign can be portfolio.
||
||
`NegativeKeywordSharedSetIds`
|
ArrayOfLong, nillable
|
IDs of sets of negative keywords. Maximum of 3 items in the array.
||

||
**TextCampaignSettingGet structure**
||
||
`Option`
|
TextCampaignSettingsGetEnum
|
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
- EXCLUDE_PAUSED_COMPETING_ADS
- MAINTAIN_NETWORK_CPC
- REQUIRE_SERVICING
- SHARED_ACCOUNT_ENABLED
- DAILY_BUDGET_ALLOWED
- CAMPAIGN_EXACT_PHRASE_MATCHING_ENABLED
||
||
`Value`
|
YesNoEnum
|
Setting value.
||

||
**RelevantKeywordsSetting structure**
||
||
`BudgetPercent`
|
int
|
Maximum percent of the budget to be spent on clicks on related keywords (from 1 to 100).
||
||
`OptimizeGoalId`
|
long, nillable
|
ID of a Yandex Metrica goal. Statistics on conversions for this goal are used for optimizing related keywords.

All goals available for the campaign can be used, including composite (multi-step) goals. For more information about goals, see [Goals and conversions](https://yandex.ru/support/metrica/en/general/goals.html) in the Yandex Metrica Help. To get the list of goals, use the [GetStatGoals](https://yandex.ru/dev/direct/doc/dg-v4/en/live/GetStatGoals) method in version 4 or Live 4 of the API.

The following values are also allowed:

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

- null (nil) — No optimization.

{% note alert %}

If the strategy of your campaign is WB_MAXIMUM_CONVERSION_RATE, AVERAGE_CPA, or AVERAGE_ROI, the optimization will use the goal (or goals) you set in the `GoalId` parameter, no matter what `OptimizeGoalId` is set to.

{% endnote %}
||

||
**PriorityGoalsArray structure**
||
||
`Items`
|
array of PriorityGoalsItem
|
A set of priority goals and corresponding conversion values.
||

||
**TextCampaignPackageBiddingStrategyGet structure**
||
||
`StrategyId`
|
long
|
Portfolio strategy ID.
||
||
`Platforms`
|
TextCampaignPlatforms
|
Ad placement platform.
||

||
**PriorityGoalsItem structure**
||
||
`GoalId`
|
long
|
ID of a Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see [Goals and conversions](https://yandex.ru/support/metrica/en/general/goals.html) in the Yandex Metrica Help.

To get the list of goals, use the [GetStatGoals](https://yandex.ru/dev/direct/doc/dg-v4/en/live/GetStatGoals) method in version 4 or Live 4 of the API.

A value of 12 corresponds to the "Engaged sessions" goal.
||
||
`Value`
|
long
|
Depending on the strategy, it can represent:
* For `MaxProfit`, profit per conversion. This is the average profit from a single conversion after variable costs (product cost, contractor fees, payment processing fees, and other costs), but excluding promotion expenses. Specified in the advertiser's currency, multiplied by 1,000,000.
* For other strategies, conversion value. This is a monetary estimation of the advertiser's profit from a completed conversion. Specified 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.
||
||
`IsMetrikaSourceOfValue`
|
YesNoEnum
|
Priority goal value source: Yandex Metrica goal. The `YES` value can only be used for strategies with cost revenue ratio.
||

||
**TextCampaignPlatforms structure**
||
||
`SearchResult`
|
YesNoEnum
|
Search results.
||
||
`ProductGallery`
|
YesNoEnum
|
Product gallery.
||
||
`Network`
|
YesNoEnum
|
Yandex Advertising Network.
||
||
`DynamicPlaces`
|
YesNoEnum
|
Dynamic placements in search results.
||

||
**TextCampaignStrategy structure**
||
||
`Search`
|
TextCampaignSearchStrategy
|
Display strategy in search results.
||
||
`Network`
|
TextCampaignNetworkStrategy
|
Display strategy in ad networks.
||

||
**TextCampaignSearchStrategy structure**
||
||
`BiddingStrategyType`
|
TextCampaignSearchStrategyTypeEnum
|
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
- SERVING_OFF
- UNKNOWN
||
||
`PlacementTypes`
|
TextCampaignSearchStrategyPlacementTypes
|
Placements in search results.
||
||
`WbMaximumClicks`
|
StrategyMaximumClicks
|
Parameters of the [Optimize clicks](https://yandex.ru/support/direct/en/strategies/average-cpc) strategy. Limited by weekly budget.
||
||
`WbMaximumConversionRate`
|
StrategyMaximumConversionRate
|
Parameters of the [Optimize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) strategy without specifying the average CPA.
||
||
`AverageCpc`
|
StrategyAverageCpc
|
Parameters of the [Optimize clicks](https://yandex.ru/support/direct/en/strategies/average-cpc) strategy. Limited by average CPC.
||
||
`AverageCpa`
|
StrategyAverageCpa
|
Parameters of the [Optimize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) strategy. Maintain the average CPA.
||
||
`AverageCpaMultipleGoals`
|
StrategyAverageCpaMultipleGoals
|
Parameters of the [Maximize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) 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`.
||
||
`AverageCrr`
|
StrategyAverageCrr
|
Parameters of the strategy [Optimize cost revenue ratio](https://yandex.ru/support/direct/en/strategies/average-cpa). Maintain the average cost revenue ratio.
||
||
`PayForConversionCrr`
|
StrategyPayForConversionCrr
|
Parameters of the strategy [Optimize cost revenue ratio](https://yandex.ru/support/direct/en/strategies/average-cpa). Pay per conversion.
||
||
`PayForConversion`
|
StrategyPayForConversion
|
Parameters of the [Optimize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) strategy. Pay per conversion.
||
||
`PayForConversionMultipleGoals`
|
StrategyPayForConversionMultipleGoals
|
Parameters of the [Maximize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) 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`.
||
||
`MaxProfit`
|
StrategyMaxProfit
|
Parameters of the "Maximize profit" strategy. The optimal CPA is selected and continuously updated based on the profit per conversion metric, allowing your business to maximize its actual profit.
Be sure to simultaneously pass the `PriorityGoals` array and specify the target profit per conversion as the `Value`.
||
||
`WeeklyClickPackage`
|
StrategyWeeklyClickPackage
|
Parameters of the [Optimize clicks](https://yandex.ru/support/direct/en/strategies/average-cpc.html) strategy. Limited by click package.


||

||
**TextCampaignNetworkStrategy structure**
||
||
`BiddingStrategyType`
|
TextCampaignNetworkStrategyTypeEnum
|
The type of display strategy in ad networks:

- NETWORK_DEFAULT
- MAXIMUM_COVERAGE
- 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
- SERVING_OFF
- UNKNOWN
||
||
`NetworkDefault`

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

If a search strategy other than HIGHEST_POSITION is selected, this structure is not returned.
||
||
`WbMaximumClicks`
|
StrategyMaximumClicks
|
Parameters of the [Optimize clicks](https://yandex.ru/support/direct/en/strategies/average-cpc) strategy. Limited by weekly budget.
||
||
`WbMaximumConversionRate`
|
StrategyMaximumConversionRate
|
Parameters of the [Optimize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) strategy without specifying the average CPA.
||
||
`AverageCpc`
|
StrategyAverageCpc
|
Parameters of the [Optimize clicks](https://yandex.ru/support/direct/en/strategies/average-cpc) strategy. Limited by average CPC.
||
||
`AverageCpa`
|
StrategyAverageCpa
|
Parameters of the [Optimize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) strategy. Maintain the average CPA.
||
||
`AverageCpaMultipleGoals`
|
StrategyAverageCpaMultipleGoalsAdd
|
Parameters of the [Maximize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) 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`.
||
||
`AverageCrr`
|
StrategyAverageCrr
|
Parameters of the strategy [Optimize cost revenue ratio](https://yandex.ru/support/direct/en/strategies/average-cpa.html). Maintain the average cost revenue ratio.
||
||
`PayForConversionCrr`
|
StrategyPayForConversionCrr
|
Parameters of the strategy [Optimize cost revenue ratio](https://yandex.ru/support/direct/en/strategies/average-cpa.html). Pay per conversion.
||
||
`PayForConversion`
|
StrategyPayForConversion
|
Parameters of the [Optimize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) strategy. Pay per conversion.
||
||
`PayForConversionMultipleGoals`
|
StrategyPayForConversionMultipleGoals
|
Parameters of the [Maximize conversions](https://yandex.ru/support/direct/en/strategies/average-cpa) 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`.
||
||
`MaxProfit`
|
StrategyMaxProfit
|
Parameters of the "Maximize profit" strategy. The optimal CPA is selected and continuously updated based on the profit per conversion metric, allowing your business to maximize its actual profit.
Be sure to simultaneously pass the `PriorityGoals` array and specify the target profit per conversion as the `Value`.
||
||
`WeeklyClickPackage`
|
StrategyWeeklyClickPackage
|
Parameters of the [Optimize clicks](https://yandex.ru/support/direct/en/strategies/average-cpc.html) strategy. Limited by click package.


||

||
**TextCampaignSearchStrategyPlacementTypes structure**
||
||
`SearchResults`
|
YesNoEnum
|
Search results.
||
||
`ProductGallery`
|
YesNoEnum
|
Product gallery.
||
||
`DynamicPlaces`
|
YesNoEnum
|
Dynamic placements in search results.
||

||
**StrategyMaximumClicks structure**
||
||
`WeeklySpendLimit`
|
long
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`BidCeiling`
|
long, nillable
|
The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.


{% note info %}

We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.

{% endnote %}
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||

||
**StrategyMaximumConversionRate structure**
||
||
`WeeklySpendLimit`
|
long
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`BidCeiling`
|
long, nillable
|
The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.


{% note info %}

We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.

{% endnote %}
||
||
`GoalId`
|
long
|
ID of a Yandex Metrica goal. For more information about goals, see [Goals and conversions](https://yandex.ru/support/metrica/en/general/goals.html) in the 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](https://yandex.ru/dev/direct/doc/dg-v4/en/live/GetStatGoals) method in version 4 or Live 4 of the API.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||

||
**StrategyAverageCpc structure**
||
||
`AverageCpc`
|
long
|
The average CPC in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`WeeklySpendLimit`
|
long, nillable
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||
||
`BudgetType`
|
BudgetTypeEnum
|
Type of budget:

- WEEKLY_BUDGET — Weekly budget.
- CUSTOM_PERIOD_BUDGET — Budget for a custom period.
||

||
**StrategyAverageCpa structure**
||
||
`AverageCpa`
|
long
|
The average cost per conversion (CPA) in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`GoalId`
|
long
|
ID of a Yandex Metrica goal. For more information about goals, see [Goals and conversions](https://yandex.ru/support/metrica/en/general/goals.html) in the Yandex Metrica Help.

To get the list of goals, use the [GetStatGoals](https://yandex.ru/dev/direct/doc/dg-v4/en/live/GetStatGoals) method in version 4 or Live 4 of the API.
||
||
`WeeklySpendLimit`
|
long, nillable
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||
||
`BudgetType`
|
BudgetTypeEnum
|
Type of budget:

- WEEKLY_BUDGET — Weekly budget.
- CUSTOM_PERIOD_BUDGET — Budget for a custom period.
||
||
`BidCeiling`
|
long, nillable
|
The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.


{% note info %}

We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.

{% endnote %}
||
||
`ExplorationBudget`
|
ExplorationBudget
|
Minimum budget. Read more in [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/minimal-budget).
||
||
**StrategyAverageCpaMultipleGoalsAdd structure**
||
||
`WeeklySpendLimit`
|
long
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||
||
`BidCeiling`
|
long
|
The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.


{% note info %}

We don't recommend setting the maximum bid, as this may reduce the effectiveness of the strategy.

{% endnote %}
||
||
`ExplorationBudget`
|
ExplorationBudget
|
Minimum budget. Read more in [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/minimal-budget).

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

||
**StrategyAverageCrr structure**
||
||
`Crr`
|
int
|
Average cost revenue ratio.
||
||
`GoalId`
|
long
|
ID of a Yandex Metrica goal. For more information about goals, see [Goals and conversions](https://yandex.ru/support/metrica/en/general/goals.html) in the Yandex Metrica Help.

To get the list of goals, use the [GetStatGoals](https://yandex.ru/dev/direct/doc/dg-v4/en/live/GetStatGoals) method in version 4 or Live 4 of the API.
||
||
`WeeklySpendLimit`
|
long
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||
||
`BudgetType`
|
BudgetTypeEnum
|
Type of budget:

- WEEKLY_BUDGET — Weekly budget.
- CUSTOM_PERIOD_BUDGET — Budget for a custom period.
||
||
`ExplorationBudget`
|
ExplorationBudget
|
Minimum budget. Read more in [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/minimal-budget).
||

||
**StrategyPayForConversionCrr structure**
||
||
`Crr`
|
int
|
Average cost revenue ratio.
||
||
`GoalId`
|
long
|
ID of a Yandex Metrica goal. For more information about goals, see [Goals and conversions](https://yandex.ru/support/metrica/en/general/goals.html) in the Yandex Metrica Help.

To get the list of goals, use the [GetStatGoals](https://yandex.ru/dev/direct/doc/dg-v4/en/live/GetStatGoals) method in version 4 or Live 4 of the API.
||
||
`WeeklySpendLimit`
|
long
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||
||
`BudgetType`
|
BudgetTypeEnum
|
Type of budget:

- WEEKLY_BUDGET — Weekly budget.
- CUSTOM_PERIOD_BUDGET — Budget for a custom period.
||

||
**StrategyPayForConversion structure**
||
||
`Cpa`
|
long
|
Cost per conversion (CPA) in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`GoalId`
|
long
|
ID of a Yandex Metrica goal. For more information about goals, see [Goals and conversions](https://yandex.ru/support/metrica/en/general/goals.html) in the Yandex Metrica Help.

To get the list of goals, use the [GetStatGoals](https://yandex.ru/dev/direct/doc/dg-v4/en/live/GetStatGoals) method in version 4 or Live 4 of the API.
||
||
`WeeklySpendLimit`
|
long, nillable
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||
||
`BudgetType`
|
BudgetTypeEnum
|
Type of budget:

- WEEKLY_BUDGET — Weekly budget.
- CUSTOM_PERIOD_BUDGET — Budget for a custom period.
||

||
**PayForConversionMultipleGoals structure**
||
||
`WeeklySpendLimit`
|
long
|
The weekly budget in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||

||
**MaxProfit 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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.
||
||
`CustomPeriodBudget`
|
CustomPeriodBudget
|
Budget for a custom period. For more information, see [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/budgets-in-strategies).

When creating a campaign, you can't specify both this parameter and `WeeklySpendLimit`.
||
||
`ExplorationBudget`
|
ExplorationBudget
|
Minimum budget. Read more in [Yandex Direct Help](https://yandex.ru/support/direct/en/strategies/minimal-budget).

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.
||
||
`BudgetType`
|
BudgetTypeEnum
|
Type of budget:

- WEEKLY_BUDGET — Weekly budget.
- CUSTOM_PERIOD_BUDGET — Budget for a custom period.
||


||
**StrategyWeeklyClickPackage structure**
||
||
`ClicksPerWeek`
|
long
|
Desired number of clicks per week.
||
||
`AverageCpc`
|
long, nillable
|
The average CPC in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.


{% note info %}

The `AverageCpc` and `BidCeiling` parameters are mutually exclusive. You can't specify both of them.

{% endnote %}
||
||
`BidCeiling`
|
long, nillable
|
The maximum bid in the user'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](https://yandex.com/dev/direct/doc/en/dictionaries/dictionaries.md).[get](https://yandex.com/dev/direct/doc/en/dictionaries/get.md) method.


{% note info %}

The `AverageCpc` and `BidCeiling` parameters are mutually exclusive. You can't specify both of them.

{% endnote %}
||

||
**StrategyNetworkDefault structure**
||
||
`LimitPercent`
|
int
|
The maximum percentage of the budget to spend on displays in ad networks. The value is a multiple of ten: 10, 20, ..., 100.
||

||
**ExplorationBudget structure**
||
||
`MinimumExplorationBudget`
|
long
|
Minimum budget value.

Acceptable value: between 0 and the weekly budget (if set).
||
||
`IsMinimumExplorationBudgetCustom`
|
YesNoEnum
|
A flag indicating a custom minimum budget.
||

||
**CustomPeriodBudget structure**
||
||
`SpendLimit`
|
long
|
Budget size for a custom period.
||
||
`StartDate`
|
string
|
Start of the budget period.
||
||
`EndDate`
|
string
|
End of the budget period.
||
||
`AutoContinue`
|
YesNoEnum
|
Flag to autocontinue the budget period.
||
|#

