update: SmartCampaign parameters
Request structure in JSON format:
{
"method": "update",
"params": {
"Campaigns": [{ /* CampaignUpdateItem */
...
"SmartCampaign": { /* SmartCampaignUpdateItem */
"CounterId": (long),
"TrackingParams" : (string),
"AttributionModel": ( "LC" | "LSC" | "FC" | "LYDC" | "FCCD" | "LSCCD" | "LYDCCD" | "AUTO" ),
"BiddingStrategy": { /* SmartCampaignStrategy */
"Search": { /* SmartCampaignSearchStrategy */
"BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
"AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
"AverageCpc": (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 */
},
"AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
"FilterAverageCpc": (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 */
},
"AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
"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 */
}
},
"AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
"FilterAverageCpa": (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 */
}
},
"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 */,
},
"PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
"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 */,
},
"PayForConversionPerFilter" : { /* StrategyPayForConversionPerFilter */
"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": { /* SmartCampaignNetworkStrategy */
"BiddingStrategyType": ( "AVERAGE_CPC_PER_CAMPAIGN" | ... | "SERVING_OFF" ), /* required */
"AverageCpcPerCampaign": { /* StrategyAverageCpcPerCampaign */
"AverageCpc": (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 */
},
"AverageCpcPerFilter": { /* StrategyAverageCpcPerFilter */
"FilterAverageCpc": (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 */
},
"AverageCpaPerCampaign": { /* StrategyAverageCpaPerCampaign */
"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 */
}
},
"AverageCpaPerFilter": { /* StrategyAverageCpaPerFilter */
"FilterAverageCpa": (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 */
}
},
"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 */,
},
"PayForConversionPerCampaign" : { /* StrategyPayForConversionPerCampaign */
"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 */,
},
"PayForConversionPerFilter" : { /* StrategyPayForConversionPerFilter */
"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 */,
},
"NetworkDefault": { /* StrategyNetworkDefault */
}
}
},
"Settings": [{ /* SmartCampaignSetting */
"Option": ( "ADD_TO_FAVORITES" | "REQUIRE_SERVICING" ), /* required */
"Value": ( "YES" | "NO" ) /* required */
}, ... ],
"PriorityGoals": { /* PriorityGoalsUpdateSetting */
"Items": [{ /* PriorityGoalsUpdateItem */
"GoalId": (long), /* required */
"Value": (long), /* required */
"Operation": ( "SET" ), /* required */
"IsMetrikaSourceOfValue": ( "YES" | "NO" )
}, ... ] /* required */
}, /* nillable */
"PackageBiddingStrategy": { /* PackageBiddingStrategyUpdate */
"StrategyId": (long),
"StrategyFromCampaignId": (long),
"Platforms" : {
"Search" : ( "YES" | "NO" ) /* required */,
"Network" : ( "YES"| "NO" ) /* required */
}
}
}
}, ... ] /* required */
}
}
Parameter |
Type |
Description |
Required |
SmartCampaignUpdateItem structure |
|||
|
long |
ID of the Yandex Metrica tag installed on the advertiser's site (see Yandex Metrica: evaluate your ad performance in Yandex Direct Help). |
No |
|
string |
URL parameters for templates. |
|
|
AttributionModelEnum |
The attribution model used for optimizing conversions (see Attribution model in the Yandex Direct Help). Possible values:
|
No |
|
SmartCampaignStrategy |
Display strategy. |
No |
|
array of SmartCampaignSetting |
Array of settings that only accept the values YES or NO. |
No |
|
PriorityGoalsUpdateSetting, nillable |
Priority goals for automatic bid adjustments. null (nil) — Delete the set of priority goals. In this case, automatic bid adjustments are used to obtain the maximum number of engaged sessions (see Engaged session figures in the Yandex Direct Help). You can't add more than 30 priority goals. |
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 |
|
SmartCampaignSetting structure |
|||
|
SmartCampaignSettingsEnum |
Setting name:
|
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 the 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 |
SmartCampaignPackageBiddingStrategyUpdate structure |
|||
|
long |
Portfolio strategy ID. |
No |
|
long |
ID of the campaign the portfolio strategy was created from. |
No |
|
SmartCampaignPlatforms |
Ad placement platform. |
No |
SmartCampaignPlatforms structure |
|||
|
YesNoEnum |
Search results. |
Yes |
|
YesNoEnum |
Yandex Advertising Network. |
Yes |
SmartCampaignStrategy structure |
|||
|
SmartCampaignSearchStrategy |
Display strategy in search results. |
No |
|
SmartCampaignNetworkStrategy |
Display strategy in ad networks. |
No |
SmartCampaignSearchStrategy structure |
|||
|
SmartCampaignSearchStrategyTypeEnum |
The type of display strategy in search results:
|
Yes |
|
StrategyAverageCpaPerCampaign |
Parameters of the Optimizing the number of conversions strategy with per-campaign CPA. |
When the |
|
StrategyAverageCpaPerFilter |
Parameters of the Optimizing the number of conversions strategy with per-filter CPA. |
When the |
|
StrategyAverageCpcPerCampaign |
Parameters of the Optimizing the number of clicks strategy with per-campaign CPC. |
When the |
|
StrategyAverageCpcPerFilter |
Parameters of the Optimizing the number of clicks strategy with per-filter CPC. |
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 |
|
StrategyPayForConversionPerCampaign |
Parameters of the Optimizing the number of conversions strategy. Pay per conversion. |
When the |
|
StrategyPayForConversionPerFilter |
Parameters of the Optimizing the number of conversions strategy. Pay per conversion per filter. |
When the |
SmartCampaignNetworkStrategy structure |
|||
|
SmartCampaignNetworkStrategyTypeEnum |
The type of display strategy in ad networks:
|
Yes |
|
StrategyAverageCpaPerCampaign |
Parameters of the Optimizing the number of conversions strategy with per-campaign CPA. |
When the |
|
StrategyAverageCpaPerFilter |
Parameters of the Optimizing the number of conversions strategy with per-filter CPA. |
When the |
|
StrategyAverageCpcPerCampaign |
Parameters of the Optimizing the number of clicks strategy with per-campaign CPC. |
When the |
|
StrategyAverageCpcPerFilter |
Parameters of the Optimizing the number of clicks strategy with per-filter CPC. |
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 |
|
StrategyPayForConversionPerCampaign |
Parameters of the Optimizing the number of conversions strategy. Pay per conversion. |
When the |
|
StrategyPayForConversionPerFilter |
Parameters of the Optimizing the number of conversions strategy. Pay per conversion per filter. |
When the |
|
StrategyNetworkDefault |
Settings for impressions in ad networks based on the settings for search. Pass an empty structure for this strategy. |
When the |
StrategyAverageCpaPerCampaign structure |
|||
|
long, nillable |
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 the 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 |
|
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 |
|
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 |
|
StrategyAverageCpaPerFilter structure |
|||
|
long, nillable |
The average default goal cost per filter 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 the 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 |
|
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 |
|
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 |
|
StrategyAverageCpcPerCampaign 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 |
|
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 |
StrategyAverageCpcPerFilter structure |
|||
|
long |
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 |
|
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 |
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. Подробнее о целях см. раздел Цели и конверсии помощи Метрики. 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 |
|
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 |
|
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 the 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 |
|
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 |
|
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 the 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 |
|
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 |
StrategyPayForConversionPerCampaign 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 the 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 |
|
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 |
StrategyPayForConversionPerFilter 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 the 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 |
|
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 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 |