update: DynamicTextCampaign parameters
Request structure in JSON format:
{
"method": "update",
"params": {
"Campaigns": [{ /* CampaignUpdateItem */
...
"DynamicTextCampaign": { /* DynamicTextCampaignUpdateItem */
"BiddingStrategy": { /* DynamicTextCampaignStrategy */
"Search": { /* DynamicTextCampaignSearchStrategy */
"BiddingStrategyType": ( "AVERAGE_CPA" | ... | "WEEKLY_CLICK_PACKAGE" ), /* required */
"PlacementTypes" : {
"SearchResults" : ( "YES" | "NO" ),
"ProductGallery" : ( "YES" | "NO" ),
"DynamicPlaces" : ( "YES" | "NO" )
},
"WbMaximumClicks": { /* StrategyMaximumClicks */
"WeeklySpendLimit": (long),
"BidCeiling": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"WbMaximumConversionRate": { /* StrategyMaximumConversionRate */
"WeeklySpendLimit": (long),
"BidCeiling": (long), /* nillable */
"GoalId": (long),
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
}
},
"AverageCpc": { /* StrategyAverageCpc */
"AverageCpc": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"AverageCpa": { /* StrategyAverageCpa */
"AverageCpa": (long),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling": (long), /* nillable */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"WeeklyClickPackage": { /* StrategyWeeklyClickPackage */
"ClicksPerWeek": (long),
"AverageCpc": (long), /* nillable */
"BidCeiling": (long) /* nillable */
},
"AverageRoi": { /* StrategyAverageRoi */
"ReserveReturn": (int),
"RoiCoef": (long),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"BidCeiling": (long), /* nillable */
"Profitability": (long), /* nillable */
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"AverageCrr": { /* StrategyAverageCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
"ExplorationBudget" : { /* nillable */
"MinimumExplorationBudget" : (long) /* required */,
"IsMinimumExplorationBudgetCustom" : ("YES") /* required */
}
},
"PayForConversionCrr": { /* StrategyPayForConversionCrr */
"Crr": (int),
"GoalId": (long),
"WeeklySpendLimit": (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
},
"PayForConversion" : { /* StrategyPayForConversion */
"Cpa" : (long),
"GoalId" : (long),
"WeeklySpendLimit" : (long), /* nillable */
"CustomPeriodBudget": { /* nillable */
"SpendLimit": (long),
"StartDate": (string),
"EndDate": (string),
"AutoContinue": ("YES" | "NO")
},
"BudgetType": ("WEEKLY_BUDGET" | "CUSTOM_PERIOD_BUDGET") /* nillable */,
}
},
"Network": { /* DynamicTextCampaignNetworkStrategy */
"BiddingStrategyType": ( "SERVING_OFF" ) /* required */
}
},
"Settings": [{ /* DynamicTextCampaignSetting */
"Option": ( "ADD_METRICA_TAG" | ... | "REQUIRE_SERVICING" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"PlacementTypes": [{ /* DynamicTextCampaignPlacementTypes */
"Type": ( "SEARCH_RESULTS" | "PRODUCT_GALLERY" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"CounterIds": { /* ArrayOfInteger */
"Items": [(int), ... ] /* required */
}, /* nillable */
"PriorityGoals": { /* PriorityGoalsUpdateSetting */
"Items": [{ /* PriorityGoalsUpdateItem */
"GoalId": (long), /* required */
"Value": (long), /* required */
"Operation": ( "SET" ), /* required */
"IsMetrikaSourceOfValue": ( "YES" | "NO" )
}, ... ] /* required */
}, /* nillable */
"TrackingParams" : (string),
"AttributionModel": ( "FC" | "LC" | "LSC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
"PackageBiddingStrategy": {
"StrategyId": (long),
"StrategyFromCampaignId": (long)
},
"NegativeKeywordSharedSetIds" : { /* nillable */
"Items" : [ (long) ] /* required */
}
}
}, ... ] /* required */
}
}
Parameter |
Type |
Description |
Required |
DynamicTextCampaignUpdateItem structure |
|||
|
array of DynamicTextCampaignSetting |
Array of settings that only accept the values YES or NO. |
No |
|
array of DynamicTextCampaignPlacementTypes |
Ad placements in search results. |
No |
|
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 |
|
DynamicTextCampaignStrategy |
Display strategy. |
No |
|
string |
URL parameters for templates. |
|
|
AttributionModelEnum |
The attribution model used for optimizing conversions (see Attribution model in Yandex Direct Help). Possible values:
|
No |
|
Links a campaign to the specified strategy. If You can't pass the following parameters in this field:
To pass these parameters, unlink the campaign from the portfolio strategy: specify a new value for |
No |
|
|
PriorityGoalsUpdateSetting, nillable |
Priority goals for automatic bid adjustments. If the array is omitted, automatic bid adjustments are used for obtaining the maximum number of engaged sessions (see Engaged session figures in Yandex Direct Help). You can't add more than 30 priority goals. |
No |
|
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 |
|||
|
DynamicTextCampaignSettingsEnum |
Setting name:
|
Yes |
|
YesNoEnum |
Setting value. |
Yes |
DynamicTextCampaignPlacementTypes structure |
|||
|
DynamicTextCampaignPlacementTypesEnum |
Type of ad placement in search results:
|
Yes |
|
YesNoEnum |
Setting value. |
Yes |
PriorityGoalsUpdateSetting structure |
|||
|
array of PriorityGoalsUpdateItem |
A new set of priority goals and conversion values to replace the existing set. |
Yes |
PriorityGoalsUpdateItem structure |
|||
|
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 |
|
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 |
|
OperationEnum |
Type of action with the set of priority goals. Currently, only the SET value is available. |
Yes |
|
YesNoEnum |
Priority goal value source: Yandex Metrica goal. The |
If the BiddingStrategyType parameter is set to AVERAGE_CRR or PAY_FOR_CONVERSION_CRR |
DynamicTextCampaignPackageBiddingStrategyUpdate structure |
|||
|
long |
Portfolio strategy ID. |
No |
|
long |
ID of the campaign the portfolio strategy was created from. |
No |
DynamicTextCampaignStrategy structure |
|||
|
DynamicTextCampaignSearchStrategy |
Display strategy in search results. |
No |
|
DynamicTextCampaignNetworkStrategy |
Display strategy in ad networks. |
No |
DynamicTextCampaignSearchStrategy structure |
|||
|
DynamicTextCampaignSearchStrategyTypeEnum |
The type of display strategy in search results:
|
Yes |
|
DynamicTextCampaignSearchStrategyPlacementTypes |
Placements in search results. |
No |
|
StrategyMaximumClicks |
Parameters of the Optimize clicks strategy. Limited by weekly budget. |
When the |
|
StrategyMaximumConversionRate |
Parameters of the Optimize conversions strategy without specifying the average CPA. |
When the |
|
StrategyAverageCpc |
Parameters of the Optimize clicks strategy. Limited by average CPC. |
When the |
|
StrategyAverageCpa |
Parameters of the Optimize conversions strategy. Maintain the average CPA. |
When the |
|
StrategyAverageRoi |
Parameters of the Optimize ROI strategy. |
When the |
|
StrategyAverageCrr |
Parameters of the strategy Optimize cost revenue ratio. Maintain the average cost revenue ratio. |
When the |
|
StrategyPayForConversionCrr |
Parameters of the strategy Optimize cost revenue ratio. Pay per conversion. |
When the |
|
StrategyPayForConversion |
Parameters of the Optimize conversions strategy. Pay per conversion. |
When the |
|
StrategyWeeklyClickPackage |
Parameters of the Optimize clicks strategy. Limited by click package. |
When the |
DynamicTextCampaignNetworkStrategy structure |
|||
|
DynamicTextCampaignNetworkStrategyTypeEnum |
The type of display strategy in ad networks. Only one value is available: SERVING_OFF |
Yes |
DynamicTextCampaignSearchStrategyPlacementTypes structure |
|||
|
YesNoEnum |
Search results. |
No |
|
YesNoEnum |
Product gallery. |
No |
|
YesNoEnum |
Dynamic placements in search results. |
No |
StrategyMaximumClicks structure |
|||
|
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 |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
StrategyMaximumConversionRate structure |
|||
|
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 |
|
long |
ID of the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help. The value 13 indicates priority goals. Allowed if the array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. |
No |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
StrategyAverageCpc structure |
|||
|
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 |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
|
BudgetTypeEnum |
Type of budget:
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 |
|||
|
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 |
|
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 |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
|
BudgetTypeEnum |
Type of budget:
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 |
|
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 |
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 To set a custom minimum budget, use the If |
No |
StrategyAverageRoi structure |
|||
|
int |
The maximum percentage of saved funds that can be returned to advertising (spent) if the forecasted return on investment exceeds the value of the A value from 0 to 100 as a multiple of ten: 0, 10, 20... 100. |
No |
|
long |
The desired average return on investment per week. The value represents the ratio between sales profits and ad costs, multiplied by 1,000,000. The value must be an integer. If the value is not a multiple of 10,000, the last 4 digits are reset to zero (which is the same as discarding extra decimal digits). |
No |
|
long |
ID of the Yandex Metrica goal. For more information about goals, see Goals and conversions in Yandex Metrica Help. The value 13 indicates priority goals. Allowed if the array specifies at least one goal that is different from engaged sessions. To get the list of goals, use the GetStatGoals method in version 4 or Live 4 of the API. |
No |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
|
BudgetTypeEnum |
Type of budget:
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 |
|
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 |
|
long, nillable |
The percentage of revenue that is the cost value of products or services. The value is a percentage multiplied by 1,000,000. The value must be an integer between 0 and 100,000,000 (which corresponds to 100%). If the value is not a multiple of 10,000, the last 4 digits are reset to zero (which is the same as discarding extra decimal digits). |
No |
|
ExplorationBudget |
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 To set a custom minimum budget, use the If |
No |
StrategyAverageCrr structure |
|||
|
int |
Average cost revenue ratio. |
Yes |
|
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 |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
|
BudgetTypeEnum |
Type of budget:
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 |
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 To set a custom minimum budget, use the If |
No |
StrategyPayForConversionCrr structure |
|||
|
int |
Average cost revenue ratio. |
Yes |
|
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 |
|
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 |
Budget for a custom period. For more information, see Yandex Direct Help. When creating a campaign, you can't specify both this parameter and |
No |
|
BudgetTypeEnum |
Type of budget:
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 |
|||
|
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 |
|
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 |
|
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 |
No |
|
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 |
No |
|
BudgetTypeEnum |
Type of budget:
If the budget type is changed while editing the campaign, the original type must be passed with a NULL value. For example, if you change the budget type from weekly to custom period, make sure to pass NULL in the "WeeklySpendLimit" field. |
No |
StrategyWeeklyClickPackage structure |
|||
|
long |
Desired number of clicks per week. |
No |
|
long, nillable |
The average CPC in the advertiser's currency, multiplied by 1,000,000. The minimum value for the average cost is listed by currency in the currency reference. To get the list of currencies, use the Dictionaries.get method. Note The |
No |
|
long, nillable |
The maximum bid in the advertiser's currency, multiplied by 1,000,000. The minimum and maximum bid for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. Note The |
No |
ExplorationBudget structure |
|||
|
long |
Minimum budget value. Acceptable value: between 0 and the weekly budget (if set). |
Yes, if the request includes the |
|
YesNoEnum |
A flag indicating a custom minimum budget. |
Yes, if the request includes the |
CustomPeriodBudget structure |
|||
|
long |
Budget size for a custom period. |
Yes |
|
string |
Start of the budget period. |
Yes |
|
string |
End of the budget period. |
Yes |
|
YesNoEnum |
Flag to autocontinue the budget period. |
Yes |