add: DynamicTextCampaign parameters
Request structure in JSON format:
{
"method": "add",
"params": {
"Campaigns": [{ /* CampaignAddItem */
...
"DynamicTextCampaign": { /* DynamicTextCampaignAddItem */
"BiddingStrategy": { /* DynamicTextCampaignStrategyAdd */
"Search": { /* DynamicTextCampaignSearchStrategyAdd */
"BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
"WbMaximumClicks": { /* StrategyMaximumClicksAdd */
"WeeklySpendLimit": (long), /* required */
"BidCeiling": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"WbMaximumConversionRate": { /* StrategyMaximumConversionRateAdd */
"WeeklySpendLimit": (long), /* required */
"BidCeiling": (long),
"GoalId": (long), /* required */
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCpc": { /* StrategyAverageCpcAdd */
"AverageCpc": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCpa": { /* StrategyAverageCpaAdd */
"AverageCpa": (long), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BidCeiling": (long),
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"WeeklyClickPackage": { /* StrategyWeeklyClickPackageAdd */
"ClicksPerWeek": (long), /* required */
"AverageCpc": (long),
"BidCeiling": (long)
},
"AverageRoi": { /* StrategyAverageRoiAdd */
"ReserveReturn": (int), /* required */
"RoiCoef": (long), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BidCeiling": (long),
"Profitability": (long),
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCrr": { /* StrategyAverageCrrAdd */
"Crr": (int), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit": (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"ExplorationBudget" : {
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionCrr" : { /* StrategyPayForConversionCrrAdd */
"Crr": (int), /* required */
"GoalId": (long), /* required */
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"PayForConversion" : { /* StrategyPayForConversionAdd */
"Cpa" : (long) /* required */,
"GoalId" : (long) /* required */,
"WeeklySpendLimit" : (long),
"CustomPeriodBudget": {
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
}
}, /* required */
"Network": { /* DynamicTextCampaignNetworkStrategyAdd */
"BiddingStrategyType": ( "SERVING_OFF" ) /* required */
} /* required */
}, /* 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 */
},
"PriorityGoals": { /* PriorityGoalsArray */
"Items": [{ /* PriorityGoalsItem */
"GoalId": (long), /* required */
"Value": (long), /* required */
"IsMetrikaSourceOfValue": ( "YES" | "NO" )
}, ... ] /* required */
},
"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 |
DynamicTextCampaignAddItem structure | |||
---|---|---|---|
BiddingStrategy | DynamicTextCampaignStrategyAdd | Display strategy. | No if PackageBiddingStrategy is specified |
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 | The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). | No |
PriorityGoals | PriorityGoalsArray | Priority goals for automatic bid adjustments. If the array is omitted, automatic bid adjustments are used for obtaining the maximum number of engaged sessions (see Engaged session figures in the Help for Yandex Direct). You can't add more than 30 priority goals. | No |
TrackingParams | string | URL parameters for templates. | |
AttributionModel | AttributionModelEnum | The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct). Possible values:
The default value is AUTO. | No |
PackageBiddingStrategy | DynamicTextCampaignPackageBiddingStrategyAdd | Links a campaign to the specified strategy. You can't pass the following parameters in this field:
To pass those parameters, unlink the campaign from the portfolio strategy by specifying a new value for BiddingStrategy and resetting the PackageBiddingStrategy: null parameter value. | No if BiddingStrategy is specified |
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:
| Yes |
| No | ||
Value | YesNoEnum | Setting value. | Yes |
DynamicTextCampaignPlacementTypes structure | |||
Type | DynamicTextCampaignPlacementTypesEnum | Type of ad placement in search results:
| Yes |
Value | YesNoEnum | Setting value. | Yes |
DynamicTextCampaignPackageBiddingStrategyAdd structure | |||
StrategyId | long | Portfolio strategy ID. | |
StrategyFromCampaignId | long | ID of the campaign the portfolio strategy was created from. | No |
PriorityGoalsArray structure | |||
Items | array of PriorityGoalsItem | A set of priority goals and corresponding conversion values. | Yes |
PriorityGoalsItem structure | |||
GoalId | long | ID of a Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. A value of 12 corresponds to the goal “Engaged sessions”. | Yes |
Value | long | The conversion value is a monetary estimation of the advertiser's profit when when the goal is completed, in the advertiser's currency, multiplied by 1,000,000. The higher the conversion value, the higher the priority to achieve conversions for this goal. | Yes |
IsMetrikaSourceOfValue | YesNoEnum | Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio. | If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR |
DynamicTextCampaignStrategyAdd structure | |||
Search | DynamicTextCampaignSearchStrategyAdd | Display strategy in search results. | Yes |
Network | DynamicTextCampaignNetworkStrategyAdd | Display strategy in ad networks. | Yes |
DynamicTextCampaignSearchStrategyAdd structure | |||
BiddingStrategyType | DynamicTextCampaignSearchStrategyTypeEnum | The type of display strategy in search results:
| Yes |
WbMaximumClicks | StrategyMaximumClicksAdd | Parameters of the Optimize clicks strategy. Limit by weekly budget. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Parameters of the Optimize conversions strategy without specifying the average CPA. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpa | StrategyAverageCpaAdd | Parameters of the Optimize conversions strategy and keep the average CPA. | When the BiddingStrategyType parameter has the value AVERAGE_CPA |
AverageRoi | StrategyAverageRoiAdd | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrrAdd | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversion | StrategyPayForConversionAdd | Parameters of the Optimizing conversions strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR |
WeeklyClickPackage | StrategyWeeklyClickPackageAdd | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. | When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE |
DynamicTextCampaignNetworkStrategyAdd structure | |||
BiddingStrategyType | DynamicTextCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks. The only available value is SERVING_OFF. | Yes |
StrategyMaximumClicksAdd 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. | Yes |
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 |
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 |
StrategyMaximumConversionRateAdd 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. | Yes |
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 |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
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 |
StrategyAverageCpcAdd 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. | 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 |
StrategyAverageCpaAdd structure | |||
AverageCpa | long | The average cost of a conversion (CPA) in the advertiser's currency, multiplied by 1,000,000. The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method. | 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 |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
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 |
StrategyAverageRoiAdd structure | |||
ReserveReturn | int | The maximum percent of saved funds that can be returned to advertising (spent) if the forecasted return on investment exceeds the value of the RoiCoef parameter. A value from 0 to 100 as a multiple of ten: 0, 10, 20... 100. | Yes |
RoiCoef | long | The desired average return on investment per week. The value represents the ratio between sales profits and ad costs multiplied by 1,000,000. The value must be an integer. If the value is not a multiple of 10,000, the last four digits are reset to zero, which is the same as discarding extra decimal digits. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
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 |
Profitability | long | The percentage of revenue that is the cost value of products or services. The value is a percent multiplied by 1,000,000. The value must be an integer from 0 to 100,000,000 (which equals 100%). If the value is not a multiple of 10,000, the last four digits are reset to zero, which is the same as discarding extra decimal digits. | No |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is 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 |
StrategyAverageCrrAdd structure | |||
Crr | int | Average cost revenue ratio. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
WeeklySpendLimit | long | The weekly budget in the advertiser's currency, multiplied by 1,000,000. The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. | No |
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 |
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 |
PayForConversionAdd structure | |||
Cpa | long | Cost of a conversion (CPA) in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum CPA values are listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
WeeklySpendLimit | long | The weekly budget in the advertiser's currency, multiplied by 1,000,000. The minimum weekly budget for each currency must be at least the value of the Cpaparameter, 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 |
StrategyPayForConversionCrrAdd structure | |||
Crr | int | Average cost revenue ratio. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
WeeklySpendLimit | long | The weekly budget in the advertiser's currency, multiplied by 1,000,000. The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. | No |
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 |
StrategyWeeklyClickPackageAdd structure | |||
ClicksPerWeek | long | Desired number of clicks per week. | Yes |
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. Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them. | 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 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 |
Parameter | Type | Description | Required |
DynamicTextCampaignAddItem structure | |||
---|---|---|---|
BiddingStrategy | DynamicTextCampaignStrategyAdd | Display strategy. | No if PackageBiddingStrategy is specified |
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 | The IDs of Yandex Metrica tags installed on the advertiser's site (see Yandex Metrica: advertising campaign efficiency evaluation in the Help for Yandex Direct). | No |
PriorityGoals | PriorityGoalsArray | Priority goals for automatic bid adjustments. If the array is omitted, automatic bid adjustments are used for obtaining the maximum number of engaged sessions (see Engaged session figures in the Help for Yandex Direct). You can't add more than 30 priority goals. | No |
TrackingParams | string | URL parameters for templates. | |
AttributionModel | AttributionModelEnum | The attribution model used for optimizing conversions (see Attribution model in the Help for Yandex Direct). Possible values:
The default value is AUTO. | No |
PackageBiddingStrategy | DynamicTextCampaignPackageBiddingStrategyAdd | Links a campaign to the specified strategy. You can't pass the following parameters in this field:
To pass those parameters, unlink the campaign from the portfolio strategy by specifying a new value for BiddingStrategy and resetting the PackageBiddingStrategy: null parameter value. | No if BiddingStrategy is specified |
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:
| Yes |
| No | ||
Value | YesNoEnum | Setting value. | Yes |
DynamicTextCampaignPlacementTypes structure | |||
Type | DynamicTextCampaignPlacementTypesEnum | Type of ad placement in search results:
| Yes |
Value | YesNoEnum | Setting value. | Yes |
DynamicTextCampaignPackageBiddingStrategyAdd structure | |||
StrategyId | long | Portfolio strategy ID. | |
StrategyFromCampaignId | long | ID of the campaign the portfolio strategy was created from. | No |
PriorityGoalsArray structure | |||
Items | array of PriorityGoalsItem | A set of priority goals and corresponding conversion values. | Yes |
PriorityGoalsItem structure | |||
GoalId | long | ID of a Yandex Metrica goal to prioritize when automatically adjusting bids. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. A value of 12 corresponds to the goal “Engaged sessions”. | Yes |
Value | long | The conversion value is a monetary estimation of the advertiser's profit when when the goal is completed, in the advertiser's currency, multiplied by 1,000,000. The higher the conversion value, the higher the priority to achieve conversions for this goal. | Yes |
IsMetrikaSourceOfValue | YesNoEnum | Priority goal value source: Yandex Metrica goal. The YES value is only used for strategies with an ad revenue ratio. | If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR |
DynamicTextCampaignStrategyAdd structure | |||
Search | DynamicTextCampaignSearchStrategyAdd | Display strategy in search results. | Yes |
Network | DynamicTextCampaignNetworkStrategyAdd | Display strategy in ad networks. | Yes |
DynamicTextCampaignSearchStrategyAdd structure | |||
BiddingStrategyType | DynamicTextCampaignSearchStrategyTypeEnum | The type of display strategy in search results:
| Yes |
WbMaximumClicks | StrategyMaximumClicksAdd | Parameters of the Optimize clicks strategy. Limit by weekly budget. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CLICKS |
WbMaximumConversionRate | StrategyMaximumConversionRateAdd | Parameters of the Optimize conversions strategy without specifying the average CPA. | When the BiddingStrategyType parameter has the value WB_MAXIMUM_CONVERSION_RATE |
AverageCpc | StrategyAverageCpcAdd | Parameters of the Optimize clicks strategy. Limit by average CPC. | When the BiddingStrategyType parameter has the value AVERAGE_CPC |
AverageCpa | StrategyAverageCpaAdd | Parameters of the Optimize conversions strategy and keep the average CPA. | When the BiddingStrategyType parameter has the value AVERAGE_CPA |
AverageRoi | StrategyAverageRoiAdd | Parameters of the Optimize ROI strategy. | When the BiddingStrategyType parameter has the value AVERAGE_ROI |
AverageCrr | StrategyAverageCrrAdd | Strategy parameters Optimize cost revenue ratio, maintain average cost revenue ratio | When the BiddingStrategyType parameter is set to AVERAGE_CRR |
PayForConversion | StrategyPayForConversionAdd | Parameters of the Optimizing conversions strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION |
PayForConversionCrr | StrategyPayForConversionCrrAdd | Parameters of the Optimize cost revenue ratio strategy. Pay per conversion. | If the BiddingStrategyType parameter is set to PAY_FOR_CONVERSION_CRR |
WeeklyClickPackage | StrategyWeeklyClickPackageAdd | Parameters of the Optimize clicks strategy. Limit by click package. Restriction. The parameter is deprecated and no longer supported. | When the BiddingStrategyType parameter has the value WEEKLY_CLICK_PACKAGE |
DynamicTextCampaignNetworkStrategyAdd structure | |||
BiddingStrategyType | DynamicTextCampaignNetworkStrategyTypeEnum | The type of display strategy in ad networks. The only available value is SERVING_OFF. | Yes |
StrategyMaximumClicksAdd 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. | Yes |
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 |
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 |
StrategyMaximumConversionRateAdd 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. | Yes |
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 |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
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 |
StrategyAverageCpcAdd 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. | 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 |
StrategyAverageCpaAdd structure | |||
AverageCpa | long | The average cost of a conversion (CPA) in the advertiser's currency, multiplied by 1,000,000. The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method. | 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 |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
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 |
StrategyAverageRoiAdd structure | |||
ReserveReturn | int | The maximum percent of saved funds that can be returned to advertising (spent) if the forecasted return on investment exceeds the value of the RoiCoef parameter. A value from 0 to 100 as a multiple of ten: 0, 10, 20... 100. | Yes |
RoiCoef | long | The desired average return on investment per week. The value represents the ratio between sales profits and ad costs multiplied by 1,000,000. The value must be an integer. If the value is not a multiple of 10,000, the last four digits are reset to zero, which is the same as discarding extra decimal digits. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. The value 13 indicates priority goals. Allowed if the PriorityGoals array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | 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 |
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 |
Profitability | long | The percentage of revenue that is the cost value of products or services. The value is a percent multiplied by 1,000,000. The value must be an integer from 0 to 100,000,000 (which equals 100%). If the value is not a multiple of 10,000, the last four digits are reset to zero, which is the same as discarding extra decimal digits. | No |
ExplorationBudget | ExplorationBudget | Minimum budget. Read more in Yandex Direct Help. If the field is 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 |
StrategyAverageCrrAdd structure | |||
Crr | int | Average cost revenue ratio. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
WeeklySpendLimit | long | The weekly budget in the advertiser's currency, multiplied by 1,000,000. The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. | No |
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 |
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 |
PayForConversionAdd structure | |||
Cpa | long | Cost of a conversion (CPA) in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum CPA values are listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
WeeklySpendLimit | long | The weekly budget in the advertiser's currency, multiplied by 1,000,000. The minimum weekly budget for each currency must be at least the value of the Cpaparameter, 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 |
StrategyPayForConversionCrrAdd structure | |||
Crr | int | Average cost revenue ratio. | Yes |
GoalId | long | ID of a Yandex Metrica goal. For more information about goals, see Goals and conversions in the Help for Yandex Metrica. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. | Yes |
WeeklySpendLimit | long | The weekly budget in the advertiser's currency, multiplied by 1,000,000. The minimum weekly budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. | No |
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 |
StrategyWeeklyClickPackageAdd structure | |||
ClicksPerWeek | long | Desired number of clicks per week. | Yes |
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. Note. The AverageCpc and BidCeiling parameters are mutually exclusive. You can't specify both of them. | 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 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 |