CreateOrUpdateCampaign (Live)
Creates a campaign with the specified parameters, or changes the parameters of an existing campaign.
Disabled method. Use version 5 of the API.
For information about the compatibility of methods between versions Live 4 and 5, see the Migration guide.
Restrictions
For editing campaigns, no more than 100 calls per day per campaign. For creating campaigns, no more than 100 calls per day.
The daily budget settings can be changed no more than three times a day.
New in the Live 4 version
Added the AdditionalMetrikaCounters parameter.
Added the ContextStrategy parameter, which sets the display strategy in the Yandex Advertising Network. The ContextLimit, ContextLimitSum and ContextPricePercent parameters moved under the ContextStrategy parameter.
Added the BidCoefs parameter to the time targeting settings. You can use this parameter to raise or lower the CPC during certain time periods. Also added the parameter WorkingHolidays.
For the Yandex advertising network, automatic strategies for managing bids are available (StrategyName parameter in the CampaignContextStrategy object).
Added the Currency input parameter (see the section Real currencies instead of Yandex units).
Added the ClickTrackingEnabled input parameter.
Added the DayBudget input parameter.
Added the AverageCPA input parameter for the AverageCPAOptimization strategy.
Added the MobileBidAdjustment input parameter.
Added the EnableRelatedKeywords input parameter.
Added the ReserveReturn, ROICoef, and Profitability input parameters for the ROIOptimization strategy.
Added the ExtendedAdTitleEnabled input parameter.
Added the MaintainNetworkCPC input parameter.
Input data
The input data structure in JSON is shown below.
{
"method": "CreateOrUpdateCampaign",
"param": {
/* CampaignInfo */
"Login": (string),
"CampaignID": (int),
"Name": (string),
"FIO": (string),
"StartDate": (date),
"Currency": (string),
"Strategy": {
/* CampaignStrategy */
"StrategyName": (string),
"MaxPrice": (float),
"AveragePrice": (float),
"WeeklySumLimit": (float),
"AverageCPA": (float),
"ClicksPerWeek": (int),
"GoalID": (int),
"ReserveReturn": (int),
"ROICoef": (float),
"Profitability": (float)
},
"ContextStrategy": {
/* CampaignContextStrategy */
"StrategyName": (string),
"ContextLimit": (string),
"ContextLimitSum": (int),
"ContextPricePercent": (int),
"MaxPrice": (float),
"AveragePrice": (float),
"AverageCPA": (float),
"WeeklySumLimit": (float),
"ClicksPerWeek": (int),
"GoalID": (int),
"ReserveReturn": (int),
"ROICoef": (float),
"Profitability": (float)
},
"AdditionalMetrikaCounters": [
(int)
...
],
"ClickTrackingEnabled": (string),
"SmsNotification": {
/* SmsNotificationInfo */
"MetricaSms": (string),
"ModerateResultSms": (string),
"MoneyInSms": (string),
"MoneyOutSms": (string),
"SmsTimeFrom": (string),
"SmsTimeTo": (string)
},
"EmailNotification": {
/* EmailNotificationInfo */
"Email": (string),
"WarnPlaceInterval": (int),
"MoneyWarningValue": (int),
"SendAccNews": (string),
"SendWarn": (string)
},
"StatusBehavior": (string),
"TimeTarget": {
/* TimeTargetInfo */
"ShowOnHolidays": (string),
"HolidayShowFrom": (int),
"HolidayShowTo": (int),
"DaysHours": [
{ /* TimeTargetItem */
"Hours": [
(int)
...
],
"Days": [
(int)
...
],
"BidCoefs": [
(int)
...
]
}
...
],
"TimeZone": (string),
"WorkingHolidays": (string)
},
"StatusContextStop": (string),
"ContextLimit": (string),
"ContextLimitSum": (int),
"ContextPricePercent": (int),
"AutoOptimization": (string),
"StatusMetricaControl": (string),
"DisabledDomains": (string),
"DisabledIps": (string),
"StatusOpenStat": (string),
"ConsiderTimeTarget": (string),
"MinusKeywords": [
(string)
...
],
"AddRelevantPhrases": (string),
"RelevantPhrasesBudgetLimit": (int),
"DayBudget": {
/* DayBudgetInfo */
"Amount": (float),
"SpendMode": (string)
},
"MobileBidAdjustment": (int),
"EnableRelatedKeywords": (string),
"ExtendedAdTitleEnabled": (string),
"MaintainNetworkCPC": (string)
}
}
Parameters are described below.
Parameter | Description | Required |
CampaignInfo object | ||
---|---|---|
Login | Login name of the campaign owner (username of the Yandex user that the ad campaign is run for). When creating a campaign, direct advertisers set their own Yandex username, while advertising agencies set their client's username. When getting campaign parameters, the username of the advertiser's chief representative is returned. | Yes |
CampaignID | The campaign ID. To create a campaign, it is set to 0; to change the parameters of an existing campaign, the campaign ID is specified. | Yes |
Name | The campaign name. | Yes |
FIO | First name and last name of the campaign owner. | Yes |
Strategy | Defines the display strategy on search. Contains the CampaignStrategy object with the strategy parameters. | Yes |
ContextStrategy | Determines the display strategy for the Yandex Advertising Network. Contains the CampaignContextStrategy object with the name and parameters of the strategy. | No |
AdditionalMetrikaCounters | Array containing IDs of Yandex Metrica tags. To delete tag IDs, pass an empty array. If the parameter is omitted, IDs are not changed. | No |
ClickTrackingEnabled | Automatically add the yclid tag with a unique click ID to the ad link — Yes/No. The predefined value is No. Using this tag, you can more precisely track the results of ad campaigns in Metrica. For more information, see Tagging links for Metrica in the Help for Yandex Direct. | No |
EmailNotification | The EmailNotificationInfo object with parameters for sending notifications by email. | Yes |
SmsNotification | The SmsNotificationInfo object with parameters for sending SMS notifications. To get notifications, you must subscribe to them (see the Help section Subscribe to SMS notifications). The phone number to send notifications to is taken from the user data (see the Help section Mobile numbers). | No |
StartDate | Date to start impressions, The date can be in the future. In this case, impressions begin on the specified date, if the moderator approved the ad and funds were transferred to the campaign balance. | No |
Currency | The currency used in monetary parameters for strategies. Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. The value must match the campaign's currency. If this parameter is omitted or NULL, Yandex units are used. In this case, if the campaign is run using real currency, the values passed by the application are converted to the actual currency before saving (see the section Real currencies instead of Yandex units). If the value is something other than NULL but it does not match the currency the client is operating in, an error is returned with code 245. | No |
StatusBehavior | Enable behavioral targeting — Yes / No. The predefined value is Yes. | No |
TimeTarget | The TimeTargetInfo object with time targeting parameters. | No |
StatusContextStop | Do not use keywords in the Yandex Advertising Network that were disabled on the search for a low CTR — Yes/No. The predefined value is No (when a keyword is disabled on the search, it continues being used in the Yandex Advertising Network). Restriction. This parameter is no longer relevant for new keywords, since keywords are no longer excluded for a low CTR. | No |
ContextLimit | The parameter is duplicated here for compatibility with the stable version 4 and will be removed in the future. The actual parameter has moved to the CampaignContextStrategy object. | No |
ContextLimitSum | The parameter is duplicated here for compatibility with the stable version 4 and will be removed in the future. The actual parameter has moved to the CampaignContextStrategy object. | No |
ContextPricePercent | The parameter is duplicated here for compatibility with the stable version 4 and will be removed in the future. The actual parameter has moved to the CampaignContextStrategy object. | No |
AutoOptimization | Enable automatic keyword optimization — Yes/No. The predefined value is No. | No |
StatusMetricaControl | Stop displays when the advertiser's web site is not available — Yes/No. Availability is detected by the results of monitoring performed by Yandex Direct. | No |
DisabledDomains | List of display places where the ad shouldn't be displayed:
Maximum of 1000 display places. Values are comma-separated. For example, | No |
DisabledIps | List of IP addresses that campaign ads should not be shown to. Addresses are separated by commas, such as | No |
StatusOpenStat | When redirecting to the advertiser's web site, append an OpenStat tag to the URL — Yes/No. The predefined value is No. | No |
ConsiderTimeTarget | When calculating the price for the display position, ignore bids in competitors' ads that are currently stopped by their schedule — Yes/No. The predefined value is No (all ads are factored into the calculation). | No |
MinusKeywords | Array of negative keywords that are shared by all the keywords of a campaign. A keyword should be specified without the minus sign before the first word. Maximum of 7 words per keyword. The maximum length of each word is 35 characters. The maximum combined length of negative keywords in the array is 20,000 characters. The “!” operator or “+” operator before a word is not included in the total length. | No |
AddRelevantPhrases | Add additional relevant keywords to ads — Yes/No. | No |
RelevantPhrasesBudgetLimit | Maximum percent of the budget to be spent on clicks on additional relevant keywords. The value is a multiple of ten: 10, 20, ..., 100. The predefined value is 100. | No |
DayBudget | The DayBudgetInfo object with parameters of the daily campaign budget. Whether the daily budget can be managed depends on the value of the DayBudgetEnabled parameter that is returned by the GetCampaignsParams (Live), GetCampaignParams (Live), GetCampaignsList (Live), and GetCampaignsListFilter (Live) methods. If daily budget configuration is not available, an attempt to pass the DayBudget parameter causes an error with the code 71. If an automatic display strategy is selected, the passed value is ignored and the daily budget is canceled. | No |
MobileBidAdjustment | Coefficient for setting bids on mobile devices. Used for campaigns and set as a percent of the desktop bid. A range of values from 50 to 1300. The default value is 100. With this value, the bid on mobile devices is the same as the bid on desktops. For more information about the coefficient, see Bid adjustments in the Help for Yandex Direct. | No |
EnableRelatedKeywords | Enable automatically adding related keywords — Yes/No. The predefined value is Yes. | No |
ExtendedAdTitleEnabled | Enable substituting part of the ad text in the title — Yes/No. The predefined value is Yes. | No |
MaintainNetworkCPC | Keep the average CPC on content sites lower than the average CPC on search — Yes/No. The predefined value is Yes. | No |
CampaignStrategy object | ||
StrategyName | Strategy on search. Acceptable values are listed below.
Strategies with manual bid management on search:
Automatic strategies on search:
| Yes |
MaxPrice | Maximum bid (in the currency specified in the Currency parameter). Can be set for the WeeklyBudget, WeeklyPacketOfClicks, and CPAOptimizer strategies, and for AverageCPAOptimization and ROIOptimization. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded down to the nearest bid increment in this currency (see the section Real currencies instead of Yandex units). | No |
AveragePrice | Average bid (in the currency set in the Currency parameter) for the AverageClickPrice strategy. Can also be set for the WeeklyPacketOfClicks strategy. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the AverageClickPrice strategy |
AverageCPA | Average cost of reaching a goal (in the currency set in the Currency parameter) for the AverageCPAOptimization strategy. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the AverageCPAOptimization strategy |
WeeklySumLimit | Maximum weekly budget (in the currency set in the Currency parameter) for the WeeklyBudget and CPAOptimizer strategies. Can also be set for the AverageClickPrice, AverageCPAOptimization, and ROIOptimization strategies. The minimum value is shown in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. The restriction is checked in the currency specified in the Currency parameter (not in the campaign's currency). If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the WeeklyBudget and CPAOptimizer strategies |
ClicksPerWeek | Number of clicks per week for the WeeklyPacketOfClicks strategy. | For the WeeklyPacketOfClicks strategy |
GoalID | ID of the Yandex Metrica goal for the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies (only non-composite goals are acceptable). The value 0 indicates all goals that are configured on the site. Use the GetStatGoals (Live) method to get a list of appropriate goals. | For the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies |
ReserveReturn | The maximum percent of funds saved for the ROIOptimization strategy 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. | For the ROIOptimization strategy |
ROICoef | The desired average return on investment per week for the ROIOptimization strategy. The value is rounded to two decimal places. | For the ROIOptimization strategy |
Profitability | The percentage of revenue that is the cost value of products or services for the ROIOptimization strategy. A value from 0 to 100, rounded to two decimal places. | No |
CampaignContextStrategy object | ||
StrategyName | Strategy in the Yandex Advertising Network. Acceptable values are listed below.
Strategies with manual bid management for the Yandex Advertising Network:
Automatic strategies in the Yandex Advertising Network: Important. Automatic strategies in the Yandex Advertising Network are available only if impressions are turned off for the search (ShowsDisabled strategy).
| Yes |
ContextLimit | Budget limit for impressions in the Yandex Advertising Network:
To avoid spending funds on impressions in the Yandex Advertising Network, disable impressions using the ShowsDisabled strategy (StrategyName parameter). | No |
ContextLimitSum | Maximum percentage of the budget to be spent on ad impressions on content sites in the Yandex Advertising Network. The value is a multiple of ten: 10, 20, ..., 100. If the value is not set (null), the budget is unlimited (equal to Default in the ContextLimit parameter). | No |
ContextPricePercent | Parameter for calculating CPC on content sites in the Yandex Advertising Network. Used for the Default strategy. Set as a percentage of the CPC on Yandex search. The value is a multiple of ten: 10, 20, ..., 100. The value 100 makes the CPC in the Yandex Advertising Network equal to the CPC in the search. | No |
MaxPrice | Maximum bid (in the currency specified in the Currency parameter). Can be set for the WeeklyBudget, WeeklyPacketOfClicks, and CPAOptimizer strategies, and for AverageCPAOptimization and ROIOptimization. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded down to the nearest bid increment in this currency (see the section Real currencies instead of Yandex units). | No |
AveragePrice | Average bid (in the currency set in the Currency parameter) for the AverageClickPrice strategy. Can also be set for the WeeklyPacketOfClicks strategy. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the AverageClickPrice strategy |
AverageCPA | Average cost of reaching a goal (in the currency set in the Currency parameter) for the AverageCPAOptimization strategy. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the AverageCPAOptimization strategy |
WeeklySumLimit | Maximum weekly budget (in the currency set in the Currency parameter) for the WeeklyBudget and CPAOptimizer strategies. Can also be set for the AverageClickPrice, AverageCPAOptimization, and ROIOptimization strategies. The minimum value is shown in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. The restriction is checked in the currency specified in the Currency parameter (not in the campaign's currency). If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the WeeklyBudget and CPAOptimizer strategies |
ClicksPerWeek | Number of clicks per week for the WeeklyPacketOfClicks strategy. | For the WeeklyPacketOfClicks strategy |
GoalID | ID of the Yandex Metrica goal for the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies (only non-composite goals are acceptable). The value 0 indicates all goals that are configured on the site. Use the GetStatGoals (Live) method to get a list of appropriate goals. | For the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies |
ReserveReturn | The maximum percent of funds saved for the ROIOptimization strategy 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. | For the ROIOptimization strategy |
ROICoef | The desired average return on investment per week for the ROIOptimization strategy. The value is rounded to two decimal places. | For the ROIOptimization strategy |
Profitability | The percentage of revenue that is the cost value of products or services for the ROIOptimization strategy. A value from 0 to 100, rounded to two decimal places. | No |
SmsNotificationInfo object | ||
MetricaSms | Notify of Yandex Metrica site monitoring results — Yes/No. | No |
ModerateResultSms | Notify of ad moderation results — Yes/No. | No |
MoneyInSms | Notify when funds are credited to the campaign balance — Yes/No. The predefined value is No. If the client has the shared account enabled, this parameter is not used. | No |
MoneyOutSms | Notify when the campaign balance is out of funds — Yes/No. The predefined value is No. If the client has the shared account enabled, this parameter is not used. | No |
SmsTimeFrom | The allowed starting time for sending SMS notifications of campaign events. Specified in the format HH:MM; minutes are set in multiples of 15 (0, 15, 30, 45). For example, “19:45”. | No |
SmsTimeTo | The ending time for sending SMS notifications of campaign events. Specified in the format HH:MM; minutes are set in multiples of 15 (0, 15, 30, 45). For example, “19:45”. | No |
EmailNotificationInfo object | ||
Email | The email address for sending notifications of campaign events. | Yes |
WarnPlaceInterval | How often to check the position of ads: every 15, 30, or 60 minutes. Notification is sent if the ad moved to a lower position than the one that the bid covered when it was set up. | Yes |
MoneyWarningValue | The minimal balance; notification is sent when the account balance is reduced to this amount. Set as a percentage of the amount of the last payment. The predefined value is 20. If the client has the shared account enabled, this parameter is not used. | Yes |
SendAccNews | Notify of campaign events — Yes/No. It is set for campaigns that have a personal Yandex manager. The predefined value is No. | No |
SendWarn | Whether to send email notifications — Yes/No. The predefined value is No. | No |
TimeTargetInfo object | ||
ShowOnHolidays | Show ads on holiday non-work days — Yes/No (does not include normal Saturdays and Sundays). The predefined value is Yes. | No |
HolidayShowFrom | The time at which ads start being displayed on public holidays. If omitted, ads are displayed according to the schedule in the DaysHours parameter. | No |
HolidayShowTo | The time at which ads stop being displayed on public holidays. If omitted, ads are displayed according to the schedule in the DaysHours parameter. | No |
DaysHours | Array of TimeTargetItem objects that determines the schedule for ad displays (time targeting). | Yes |
TimeZone | Time zone where the ad campaign owner is located. To get the list of time zones, use the GetTimeZones method. | No |
WorkingHolidays | Change the display schedule when a work day is moved to Saturday or Sunday because of holidays — Yes/No. For example, if a work day is moved from Monday to Saturday and the value is Yes, on the Saturday work day, impressions will be shown according to the Monday schedule, and on the Monday holiday, they will be shown according to the Saturday schedule. | No |
TimeTargetItem object | ||
Hours | Array of integers from 0 to 23. The number 0 corresponds to the time interval from 00:00 to 00:59, the number 1 corresponds to the interval from 01:00 to 01:59, and so on. The predefined value is an array of the numbers from 0 to 23, which equals all 24 hours of the day. | Yes |
Days | Array of integers from 1 to 7. The number 1 corresponds to Monday, and 7 corresponds to Sunday. Ads are displayed on the specified days during the time set in the Hours parameter. The predefined value is an array of the numbers from 1 to 7, which equals a complete week. | Yes |
BidCoefs | An array of coefficients that raise or lower the CPC during certain time periods. Used for strategies with manual bid management. Coefficients are specified as percentages, and the value must be a multiple of ten: 0, 10, 20... 200. You must set the same number of coefficients as there are hours set in the Hours array. Each coefficient correlates to a particular hour in the successive order in the array. If the parameter is omitted, previously set coefficients are not changed. | No |
DayBudgetInfo object | ||
Amount | The daily campaign budget (in the currency specified in the Currency parameter). The minimum acceptable value is shown in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. The restriction is checked in the currency specified in the Currency parameter (not in the campaign's currency). A value of 0 nullifies the daily budget. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | Yes |
SpendMode | Evenly distribute the daily budget over the course of the day — Default/Stretched. When the value is Default, the daily budget may be used up and impressions may stop before the day is over. | Yes |
Parameter | Description | Required |
CampaignInfo object | ||
---|---|---|
Login | Login name of the campaign owner (username of the Yandex user that the ad campaign is run for). When creating a campaign, direct advertisers set their own Yandex username, while advertising agencies set their client's username. When getting campaign parameters, the username of the advertiser's chief representative is returned. | Yes |
CampaignID | The campaign ID. To create a campaign, it is set to 0; to change the parameters of an existing campaign, the campaign ID is specified. | Yes |
Name | The campaign name. | Yes |
FIO | First name and last name of the campaign owner. | Yes |
Strategy | Defines the display strategy on search. Contains the CampaignStrategy object with the strategy parameters. | Yes |
ContextStrategy | Determines the display strategy for the Yandex Advertising Network. Contains the CampaignContextStrategy object with the name and parameters of the strategy. | No |
AdditionalMetrikaCounters | Array containing IDs of Yandex Metrica tags. To delete tag IDs, pass an empty array. If the parameter is omitted, IDs are not changed. | No |
ClickTrackingEnabled | Automatically add the yclid tag with a unique click ID to the ad link — Yes/No. The predefined value is No. Using this tag, you can more precisely track the results of ad campaigns in Metrica. For more information, see Tagging links for Metrica in the Help for Yandex Direct. | No |
EmailNotification | The EmailNotificationInfo object with parameters for sending notifications by email. | Yes |
SmsNotification | The SmsNotificationInfo object with parameters for sending SMS notifications. To get notifications, you must subscribe to them (see the Help section Subscribe to SMS notifications). The phone number to send notifications to is taken from the user data (see the Help section Mobile numbers). | No |
StartDate | Date to start impressions, The date can be in the future. In this case, impressions begin on the specified date, if the moderator approved the ad and funds were transferred to the campaign balance. | No |
Currency | The currency used in monetary parameters for strategies. Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. The value must match the campaign's currency. If this parameter is omitted or NULL, Yandex units are used. In this case, if the campaign is run using real currency, the values passed by the application are converted to the actual currency before saving (see the section Real currencies instead of Yandex units). If the value is something other than NULL but it does not match the currency the client is operating in, an error is returned with code 245. | No |
StatusBehavior | Enable behavioral targeting — Yes / No. The predefined value is Yes. | No |
TimeTarget | The TimeTargetInfo object with time targeting parameters. | No |
StatusContextStop | Do not use keywords in the Yandex Advertising Network that were disabled on the search for a low CTR — Yes/No. The predefined value is No (when a keyword is disabled on the search, it continues being used in the Yandex Advertising Network). Restriction. This parameter is no longer relevant for new keywords, since keywords are no longer excluded for a low CTR. | No |
ContextLimit | The parameter is duplicated here for compatibility with the stable version 4 and will be removed in the future. The actual parameter has moved to the CampaignContextStrategy object. | No |
ContextLimitSum | The parameter is duplicated here for compatibility with the stable version 4 and will be removed in the future. The actual parameter has moved to the CampaignContextStrategy object. | No |
ContextPricePercent | The parameter is duplicated here for compatibility with the stable version 4 and will be removed in the future. The actual parameter has moved to the CampaignContextStrategy object. | No |
AutoOptimization | Enable automatic keyword optimization — Yes/No. The predefined value is No. | No |
StatusMetricaControl | Stop displays when the advertiser's web site is not available — Yes/No. Availability is detected by the results of monitoring performed by Yandex Direct. | No |
DisabledDomains | List of display places where the ad shouldn't be displayed:
Maximum of 1000 display places. Values are comma-separated. For example, | No |
DisabledIps | List of IP addresses that campaign ads should not be shown to. Addresses are separated by commas, such as | No |
StatusOpenStat | When redirecting to the advertiser's web site, append an OpenStat tag to the URL — Yes/No. The predefined value is No. | No |
ConsiderTimeTarget | When calculating the price for the display position, ignore bids in competitors' ads that are currently stopped by their schedule — Yes/No. The predefined value is No (all ads are factored into the calculation). | No |
MinusKeywords | Array of negative keywords that are shared by all the keywords of a campaign. A keyword should be specified without the minus sign before the first word. Maximum of 7 words per keyword. The maximum length of each word is 35 characters. The maximum combined length of negative keywords in the array is 20,000 characters. The “!” operator or “+” operator before a word is not included in the total length. | No |
AddRelevantPhrases | Add additional relevant keywords to ads — Yes/No. | No |
RelevantPhrasesBudgetLimit | Maximum percent of the budget to be spent on clicks on additional relevant keywords. The value is a multiple of ten: 10, 20, ..., 100. The predefined value is 100. | No |
DayBudget | The DayBudgetInfo object with parameters of the daily campaign budget. Whether the daily budget can be managed depends on the value of the DayBudgetEnabled parameter that is returned by the GetCampaignsParams (Live), GetCampaignParams (Live), GetCampaignsList (Live), and GetCampaignsListFilter (Live) methods. If daily budget configuration is not available, an attempt to pass the DayBudget parameter causes an error with the code 71. If an automatic display strategy is selected, the passed value is ignored and the daily budget is canceled. | No |
MobileBidAdjustment | Coefficient for setting bids on mobile devices. Used for campaigns and set as a percent of the desktop bid. A range of values from 50 to 1300. The default value is 100. With this value, the bid on mobile devices is the same as the bid on desktops. For more information about the coefficient, see Bid adjustments in the Help for Yandex Direct. | No |
EnableRelatedKeywords | Enable automatically adding related keywords — Yes/No. The predefined value is Yes. | No |
ExtendedAdTitleEnabled | Enable substituting part of the ad text in the title — Yes/No. The predefined value is Yes. | No |
MaintainNetworkCPC | Keep the average CPC on content sites lower than the average CPC on search — Yes/No. The predefined value is Yes. | No |
CampaignStrategy object | ||
StrategyName | Strategy on search. Acceptable values are listed below.
Strategies with manual bid management on search:
Automatic strategies on search:
| Yes |
MaxPrice | Maximum bid (in the currency specified in the Currency parameter). Can be set for the WeeklyBudget, WeeklyPacketOfClicks, and CPAOptimizer strategies, and for AverageCPAOptimization and ROIOptimization. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded down to the nearest bid increment in this currency (see the section Real currencies instead of Yandex units). | No |
AveragePrice | Average bid (in the currency set in the Currency parameter) for the AverageClickPrice strategy. Can also be set for the WeeklyPacketOfClicks strategy. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the AverageClickPrice strategy |
AverageCPA | Average cost of reaching a goal (in the currency set in the Currency parameter) for the AverageCPAOptimization strategy. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the AverageCPAOptimization strategy |
WeeklySumLimit | Maximum weekly budget (in the currency set in the Currency parameter) for the WeeklyBudget and CPAOptimizer strategies. Can also be set for the AverageClickPrice, AverageCPAOptimization, and ROIOptimization strategies. The minimum value is shown in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. The restriction is checked in the currency specified in the Currency parameter (not in the campaign's currency). If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the WeeklyBudget and CPAOptimizer strategies |
ClicksPerWeek | Number of clicks per week for the WeeklyPacketOfClicks strategy. | For the WeeklyPacketOfClicks strategy |
GoalID | ID of the Yandex Metrica goal for the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies (only non-composite goals are acceptable). The value 0 indicates all goals that are configured on the site. Use the GetStatGoals (Live) method to get a list of appropriate goals. | For the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies |
ReserveReturn | The maximum percent of funds saved for the ROIOptimization strategy 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. | For the ROIOptimization strategy |
ROICoef | The desired average return on investment per week for the ROIOptimization strategy. The value is rounded to two decimal places. | For the ROIOptimization strategy |
Profitability | The percentage of revenue that is the cost value of products or services for the ROIOptimization strategy. A value from 0 to 100, rounded to two decimal places. | No |
CampaignContextStrategy object | ||
StrategyName | Strategy in the Yandex Advertising Network. Acceptable values are listed below.
Strategies with manual bid management for the Yandex Advertising Network:
Automatic strategies in the Yandex Advertising Network: Important. Automatic strategies in the Yandex Advertising Network are available only if impressions are turned off for the search (ShowsDisabled strategy).
| Yes |
ContextLimit | Budget limit for impressions in the Yandex Advertising Network:
To avoid spending funds on impressions in the Yandex Advertising Network, disable impressions using the ShowsDisabled strategy (StrategyName parameter). | No |
ContextLimitSum | Maximum percentage of the budget to be spent on ad impressions on content sites in the Yandex Advertising Network. The value is a multiple of ten: 10, 20, ..., 100. If the value is not set (null), the budget is unlimited (equal to Default in the ContextLimit parameter). | No |
ContextPricePercent | Parameter for calculating CPC on content sites in the Yandex Advertising Network. Used for the Default strategy. Set as a percentage of the CPC on Yandex search. The value is a multiple of ten: 10, 20, ..., 100. The value 100 makes the CPC in the Yandex Advertising Network equal to the CPC in the search. | No |
MaxPrice | Maximum bid (in the currency specified in the Currency parameter). Can be set for the WeeklyBudget, WeeklyPacketOfClicks, and CPAOptimizer strategies, and for AverageCPAOptimization and ROIOptimization. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded down to the nearest bid increment in this currency (see the section Real currencies instead of Yandex units). | No |
AveragePrice | Average bid (in the currency set in the Currency parameter) for the AverageClickPrice strategy. Can also be set for the WeeklyPacketOfClicks strategy. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the AverageClickPrice strategy |
AverageCPA | Average cost of reaching a goal (in the currency set in the Currency parameter) for the AverageCPAOptimization strategy. The maximum and minimum values are provided in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the AverageCPAOptimization strategy |
WeeklySumLimit | Maximum weekly budget (in the currency set in the Currency parameter) for the WeeklyBudget and CPAOptimizer strategies. Can also be set for the AverageClickPrice, AverageCPAOptimization, and ROIOptimization strategies. The minimum value is shown in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. The restriction is checked in the currency specified in the Currency parameter (not in the campaign's currency). If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | For the WeeklyBudget and CPAOptimizer strategies |
ClicksPerWeek | Number of clicks per week for the WeeklyPacketOfClicks strategy. | For the WeeklyPacketOfClicks strategy |
GoalID | ID of the Yandex Metrica goal for the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies (only non-composite goals are acceptable). The value 0 indicates all goals that are configured on the site. Use the GetStatGoals (Live) method to get a list of appropriate goals. | For the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies |
ReserveReturn | The maximum percent of funds saved for the ROIOptimization strategy 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. | For the ROIOptimization strategy |
ROICoef | The desired average return on investment per week for the ROIOptimization strategy. The value is rounded to two decimal places. | For the ROIOptimization strategy |
Profitability | The percentage of revenue that is the cost value of products or services for the ROIOptimization strategy. A value from 0 to 100, rounded to two decimal places. | No |
SmsNotificationInfo object | ||
MetricaSms | Notify of Yandex Metrica site monitoring results — Yes/No. | No |
ModerateResultSms | Notify of ad moderation results — Yes/No. | No |
MoneyInSms | Notify when funds are credited to the campaign balance — Yes/No. The predefined value is No. If the client has the shared account enabled, this parameter is not used. | No |
MoneyOutSms | Notify when the campaign balance is out of funds — Yes/No. The predefined value is No. If the client has the shared account enabled, this parameter is not used. | No |
SmsTimeFrom | The allowed starting time for sending SMS notifications of campaign events. Specified in the format HH:MM; minutes are set in multiples of 15 (0, 15, 30, 45). For example, “19:45”. | No |
SmsTimeTo | The ending time for sending SMS notifications of campaign events. Specified in the format HH:MM; minutes are set in multiples of 15 (0, 15, 30, 45). For example, “19:45”. | No |
EmailNotificationInfo object | ||
Email | The email address for sending notifications of campaign events. | Yes |
WarnPlaceInterval | How often to check the position of ads: every 15, 30, or 60 minutes. Notification is sent if the ad moved to a lower position than the one that the bid covered when it was set up. | Yes |
MoneyWarningValue | The minimal balance; notification is sent when the account balance is reduced to this amount. Set as a percentage of the amount of the last payment. The predefined value is 20. If the client has the shared account enabled, this parameter is not used. | Yes |
SendAccNews | Notify of campaign events — Yes/No. It is set for campaigns that have a personal Yandex manager. The predefined value is No. | No |
SendWarn | Whether to send email notifications — Yes/No. The predefined value is No. | No |
TimeTargetInfo object | ||
ShowOnHolidays | Show ads on holiday non-work days — Yes/No (does not include normal Saturdays and Sundays). The predefined value is Yes. | No |
HolidayShowFrom | The time at which ads start being displayed on public holidays. If omitted, ads are displayed according to the schedule in the DaysHours parameter. | No |
HolidayShowTo | The time at which ads stop being displayed on public holidays. If omitted, ads are displayed according to the schedule in the DaysHours parameter. | No |
DaysHours | Array of TimeTargetItem objects that determines the schedule for ad displays (time targeting). | Yes |
TimeZone | Time zone where the ad campaign owner is located. To get the list of time zones, use the GetTimeZones method. | No |
WorkingHolidays | Change the display schedule when a work day is moved to Saturday or Sunday because of holidays — Yes/No. For example, if a work day is moved from Monday to Saturday and the value is Yes, on the Saturday work day, impressions will be shown according to the Monday schedule, and on the Monday holiday, they will be shown according to the Saturday schedule. | No |
TimeTargetItem object | ||
Hours | Array of integers from 0 to 23. The number 0 corresponds to the time interval from 00:00 to 00:59, the number 1 corresponds to the interval from 01:00 to 01:59, and so on. The predefined value is an array of the numbers from 0 to 23, which equals all 24 hours of the day. | Yes |
Days | Array of integers from 1 to 7. The number 1 corresponds to Monday, and 7 corresponds to Sunday. Ads are displayed on the specified days during the time set in the Hours parameter. The predefined value is an array of the numbers from 1 to 7, which equals a complete week. | Yes |
BidCoefs | An array of coefficients that raise or lower the CPC during certain time periods. Used for strategies with manual bid management. Coefficients are specified as percentages, and the value must be a multiple of ten: 0, 10, 20... 200. You must set the same number of coefficients as there are hours set in the Hours array. Each coefficient correlates to a particular hour in the successive order in the array. If the parameter is omitted, previously set coefficients are not changed. | No |
DayBudgetInfo object | ||
Amount | The daily campaign budget (in the currency specified in the Currency parameter). The minimum acceptable value is shown in the ../concepts/multicurrency_const.html#multicurrency_const__limits table. The restriction is checked in the currency specified in the Currency parameter (not in the campaign's currency). A value of 0 nullifies the daily budget. If the value is converted from Yandex units to the campaign currency before saving, it is rounded to the second digit after the decimal, following mathematical rules (for all currencies, including the tenge). | Yes |
SpendMode | Evenly distribute the daily budget over the course of the day — Default/Stretched. When the value is Default, the daily budget may be used up and impressions may stop before the day is over. | Yes |
Output data
The method returns the ID of the created or edited campaign, as shown in the following example.
{
"data": 3193279
}
Examples of input data
Python
{
"Login":"agrom",
"CampaignID":3193279,
"Name":"Promotion of home appliances",
"FIO":"Alex Gromov",
"Strategy":{
"StrategyName":"RightBlockHighest"
},
"ContextStrategy": {
"StrategyName":"Default",
"ContextLimit":"Limited",
"ContextLimitSum":30,
"ContextPricePercent":90
},
"TimeTarget":{
"TimeZone":"Europe/Moscow",
"DaysHours":[
{
"Hours":[1,2,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],
"Days":[1,2,3,4,5]
},
{
"Hours":[10,11,12,13,14,15,16,17,18,19,20],
"Days":[6,7],
"BidCoefs":[40,40,40,50,150,160,200,60,60,20,10]
}
],
"ShowOnHolidays":"Yes",
"WorkingHolidays": "No"
},
"StatusBehavior":"Yes",
"StatusContextStop":"No",
"AutoOptimization":"Yes",
"StatusMetricaControl":"Yes",
"DisabledDomains": "domain1.ru,domain2.ru",
"DisabledIps": "64.234.23.21",
"StatusOpenStat":"No",
"ConsiderTimeTarget":"Yes",
"AddRelevantPhrases":"No",
"RelevantPhrasesBudgetLimit":100,
"MinusKeywords":[],
"SmsNotification":{
"SmsTimeFrom":"09:00",
"MoneyInSms":"Yes",
"SmsTimeTo":"21:00",
"MoneyOutSms":"Yes",
"ModerateResultSms":"Yes",
"MetricaSms":"Yes"
},
"EmailNotification":{
"MoneyWarningValue":20,
"SendAccNews":"Yes",
"WarnPlaceInterval":60,
"SendWarn":"Yes",
"Email":"agrom@yandex.ru"
}
}
PHP
array(
"Login" => "agrom",
"CampaignID" => 3193279,
"Name" => "Promotion of home appliances",
"FIO" => "Alex Gromov",
"Strategy" => array(
"StrategyName" => "RightBlockHighest"
),
"ContextStrategy" => array(
"StrategyName" => "Default",
"ContextLimit" => "Limited",
"ContextLimitSum" => 30,
"ContextPricePercent" => 90
),
"TimeTarget" => array(
"TimeZone" => "Europe/Moscow",
"DaysHours" => array(
array(
"Hours" => array(1,2,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23),
"Days" => array(1,2,3,4,5)
),
array(
"Hours" => array(10,11,12,13,14,15,16,17,18,19,20),
"Days" => array(6,7),
"BidCoefs" => array(40,40,40,50,150,160,200,60,60,20,10)
)
),
"ShowOnHolidays" => "Yes",
"WorkingHolidays" => "No"
),
"StatusBehavior" => "Yes",
"StatusContextStop" => "No",
"AutoOptimization" => "Yes",
"StatusMetricaControl" => "Yes",
"DisabledDomains" => "domain1.ru,domain2.ru",
"DisabledIps" => "64.234.23.21",
"StatusOpenStat" => "No",
"ConsiderTimeTarget" => "Yes",
"AddRelevantPhrases" => "No",
"RelevantPhrasesBudgetLimit" => 100,
"MinusKeywords" => array(),
"SmsNotification" => array(
"SmsTimeFrom" => "09:00",
"MoneyInSms" => "Yes",
"SmsTimeTo" => "21:00",
"MoneyOutSms" => "Yes",
"ModerateResultSms" => "Yes",
"MetricaSms" => "Yes"
),
"EmailNotification" => array(
"MoneyWarningValue" => 20,
"SendAccNews" => "Yes",
"WarnPlaceInterval" => 60,
"SendWarn" => "Yes",
"Email" => "agrom@yandex.ru"
)
)
Perl
{
'Login' => 'agrom',
'CampaignID' => 3193279,
'Name' => 'Promotion of home appliances',
'FIO' => 'Alex Gromov',
'Strategy' => {
'StrategyName' => 'RightBlockHighest'
},
'ContextStrategy' => {
'StrategyName' => 'Default',
'ContextLimit' => 'Limited',
'ContextLimitSum' => 30,
'ContextPricePercent' => 90
},
'TimeTarget' => {
'TimeZone' => 'Europe/Moscow',
'DaysHours' => [
{
'Hours' => [1,2,7,8,9,10,11,12,13,14,15,16,17,18,19,20,21,22,23],
'Days' => [1,2,3,4,5]
},
{
'Hours' => [10,11,12,13,14,15,16,17,18,19,20],
'Days' => [6,7],
'BidCoefs' => [40,40,40,50,150,160,200,60,60,20,10]
}
],
'ShowOnHolidays' => 'Yes',
'WorkingHolidays' => 'No'
},
'StatusBehavior' => 'Yes',
'StatusContextStop' => 'No',
'AutoOptimization' => 'Yes',
'StatusMetricaControl' => 'Yes',
'DisabledDomains' => 'domain1.ru,domain2.ru',
'DisabledIps' => '64.234.23.21',
'StatusOpenStat' => 'No',
'ConsiderTimeTarget' => 'Yes',
'AddRelevantPhrases' => 'No',
'RelevantPhrasesBudgetLimit' => 100,
'MinusKeywords' => [],
'SmsNotification' => {
'SmsTimeFrom' => '09:00',
'MoneyInSms' => 'Yes',
'SmsTimeTo' => '21:00',
'MoneyOutSms' => 'Yes',
'ModerateResultSms' => 'Yes',
'MetricaSms' => 'Yes'
},
'EmailNotification' => {
'MoneyWarningValue' => 20,
'SendAccNews' => 'Yes',
'WarnPlaceInterval' => 60,
'SendWarn' => 'Yes',
'Email' => 'agrom@yandex.ru'
}
}