update
Changes campaign parameters.
Restrictions
Maximum of 10 campaigns per method call.
Maximum of 3 changes to the daily budget per day for a single campaign.
Request
Request structure in JSON format:
{
"method": "update",
"params": { /* params */
"Campaigns": [{ /* CampaignUpdateItem */
"Id": (long), /* required */
"Name": (string),
"StartDate": (string),
"DailyBudget": { /* DailyBudget */
"Amount": (long), /* required */
"Mode": ( "STANDARD" | "DISTRIBUTED" ) /* required */
}, /* nillable */
"EndDate": (string), /* nillable */
"NegativeKeywords": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
}, /* nillable */
"BlockedIps": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
}, /* nillable */
"ExcludedSites": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
}, /* nillable */
"TextCampaign": { /* TextCampaignUpdateItem */
... text campaign params ...
},
"MobileAppCampaign": { /* MobileAppCampaignUpdateItem */
... mobile app campaign params ...
},
"DynamicTextCampaign": { /* DynamicTextCampaignUpdateItem */
... dynamic text campaign params ...
},
"CpmBannerCampaign": { /* CpmBannerCampaignUpdateItem */
... cpm banner campaign params ...
},
"SmartCampaign": { /* SmartCampaignUpdateItem */
... smart campaign params ...
},
"UnifiedCampaign": { /* SmartCampaignUpdateItem */
... unified campaign params ...
},
"ClientInfo": (string),
"Notification": { /* Notification */
"SmsSettings": { /* SmsSettings */
"Events": [( "MONITORING" | ... | "FINISHED" ), ... ],
"TimeFrom": (string),
"TimeTo": (string)
},
"EmailSettings": { /* EmailSettings */
"Email": (string),
"CheckPositionInterval": (int),
"WarningBalance": (int),
"SendAccountNews": ( "YES" | "NO" ),
"SendWarnings": ( "YES" | "NO" )
}
},
"TimeTargeting": { /* TimeTargeting */
"Schedule": { /* ArrayOfString */
"Items": [(string), ... ] /* required */
},
"ConsiderWorkingWeekends": ( "YES" | "NO" ), /* required */
"HolidaysSchedule": { /* TimeTargetingOnPublicHolidays */
"SuspendOnHolidays": ( "YES" | "NO" ), /* required */
"BidPercent": (int),
"StartHour": (int),
"EndHour": (int)
} /* nillable */
},
"TimeZone": (string)
}, ... ] /* required */
}
}
Parameter | Type | Description | Required |
Params structure (for JSON) / AddRequest structure (for SOAP) | |||
---|---|---|---|
Campaigns | array of CampaignUpdateItem | Campaigns whose parameters need to be changed. | Yes |
CampaignUpdateItem structure | |||
Id | long | The ID of the campaign to change parameters for. | Yes |
Name | string | Campaign name (maximum of 255 characters). | No |
ClientInfo | string | Client name (maximum of 255 characters). The default value is the name from the advertiser's settings. Can't be set for UnifiedCampaign. | No |
StartDate | string | Start date for displaying ads, in the format YYYY-MM-DD. Can't be earlier than the current date. Ad displays begin at 00:00 Moscow time (regardless of the TimeZone parameter). The start time for displays is affected by the time targeting settings (the TimeTargeting parameter). Ad displays are possible only if at least one ad has passed review and funds have been credited to the campaign or shared account. If you set a budget for a custom period for the campaign, the value in this field is ignored, and the strategy period is prioritized instead. | No |
EndDate | string, nillable | End date for displaying ads, in the format YYYY-MM-DD. Ad impressions end at 24:00 Moscow time (regardless of the TimeZone parameter). | No |
TimeTargeting | TimeTargeting | Settings for time targeting and hourly bid adjustments. Specified for the time zone set in the TimeZone parameter. | No |
TimeZone | string | Time zone of the advertiser's location. Use the Dictionaries.get method to get a reference list of time zones. The default value is Europe/Moscow. | No |
NegativeKeywords | ArrayOfString, nillable | Array of negative keywords that are shared by all the keywords of a campaign. Restriction. This parameter is not supported for campaigns with the “Display campaign” type. 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. Spaces, dashes, and operators are not counted as part of the total length. | No |
BlockedIps | ArrayOfString, nillable | Array of IP addresses that campaign ads should not be shown to. Maximum of 25 items in the array. | No |
ExcludedSites | ArrayOfString, nillable | Array of display places where the ad shouldn't be displayed:
Maximum of 1000 items in the array. Maximum of 255 characters per array item. | No |
DailyBudget | DailyBudget, nillable | Settings for the daily budget of a campaign. Daily budget management is available if a manual display strategy is selected in the campaign. Otherwise, an attempt to set the daily budget results in an error. To reset the daily budget, pass null (nil). | No |
Notification | Notification | Settings for SMS and email notifications. Can't be set for UnifiedCampaign. | No |
TextCampaign | TextCampaignUpdateItem | Settings for campaigns with the “Text & Image ads” type. For a data structure description, see update: TextCampaign parameters. | No |
MobileAppCampaign | MobileAppCampaignUpdateItem | Settings for “Ads for mobile apps” campaigns. For a data structure description, see update: MobileAppCampaign parameters. | No |
DynamicTextCampaign | DynamicTextCampaignUpdateItem | Settings for campaigns with the “Dynamic ads” type. For a data structure description, see update: DynamicTextCampaign parameters. | No |
CpmBannerCampaign | CpmBannerCampaignUpdateItem | Settings for the “Display campaign” type. For a data structure description, see update: CpmBannerCampaign parameters. | No |
SmartCampaign | SmartCampaignUpdateItem | Settings for “Smart banners” campaigns. For a data structure description, see update: SmartCampaign parameters. | No |
UnifiedCampaign | UnifiedCampaignUpdateItem | Settings for campaigns with the “Unified performance campaign” type. For a data structure description, see update: UnifiedCampaign parameters. | No |
TimeTargeting structure | |||
Schedule | ArrayOfString | Settings for time targeting and hourly bid adjustments. Maximum of 7 items in the array. Each array item contains 25 comma-separated numbers. The first number is the number of the day of the week: from 1 (Monday) to 7 (Sunday). The next 24 numbers are a sequence of bid coefficients for displaying ads in the corresponding hours. Coefficients are specified as percentages from 0 to 200. The value must be a multiple of 10: If the coefficient is 0, no ads are served during this hour. Example of an array element: 1, 0, 0, 50, 50, 100, 100, 150, 200, 200, 150, 100, 100, 80, 70, 100, 100, 100, 50, 50, 40, 30, 0, 0, 0 Note.
| No |
ConsiderWorkingWeekends | YesNoEnum | Whether to change the display schedule when a work day is moved to Saturday or Sunday because of a public holiday. For example, if a work day is moved from Monday to Saturday and the value is YES, on the Saturday work day, ads are displayed according to the Monday schedule, and on the Monday holiday, they are displayed according to the Saturday schedule. | Yes |
HolidaysSchedule | TimeTargetingOnPublicHolidays, nillable | Display settings on public holidays. If the time zone specified in the TimeZone parameter belongs to Russia, Ukraine, Belarus, Kazakhstan, or Turkey, we use the holiday calendar for the appropriate country. In all other cases, we use the Russian calendar. | No |
TimeTargetingOnPublicHolidays structure | |||
SuspendOnHolidays | YesNoEnum | Whether to suspend ads on public holidays: YES — suspend; NO — don't suspend. Note. The BidPercent, StartHour and EndHour parameters can only be set when SuspendOnHolidays has the value NO. | Yes |
BidPercent | int | The bid coefficient for displays on public holidays. Specified as a percentage from 0 to 200. The value must be a multiple of 10. | No |
StartHour | int | The time (in hours) to start displays on public holidays. From 0 to 23. | When the SuspendOnHolidays parameter has the value NO |
EndHour | int | The time (in hours) to end displays on public holidays. From 0 to 24. | When the SuspendOnHolidays parameter has the value NO |
DailyBudget structure | |||
Amount | long | The daily campaign budget in the advertiser currency, multiplied by 1,000,000. The minimum daily budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. | Yes |
Mode | DailyBudgetModeEnum | Mode for displaying ads:
See the Average daily budget section under “Manual bid management” in the Help for Yandex Direct. | Yes |
Notification structure | |||
SmsSettings | SmsSettings | Settings for sending SMS notifications. The phone number to send notifications to is taken from the advertiser's Yandex profile (see My numbers in the Yandex Passport Help). | No |
EmailSettings | EmailSettings | Settings for sending email notifications. | No |
SmsSettings structure | |||
Events | array of SmsEventsEnum | Events to notify of by SMS:
| No |
TimeFrom | string | 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 |
TimeTo | string | 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 |
EmailSettings structure | |||
Email | string | The email address for sending notifications of campaign events. The default value is the advertiser's address. | No |
CheckPositionInterval | int | The frequency of checking the traffic forecast: 15, 30 or 60 minutes. The default value is 60. A notification is sent if the traffic forecast is lower than the one that the bid covered at the time of configuration. | No |
WarningBalance | int | 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, from 1 to 50. The default value is 20. If the client has the shared account enabled, this parameter is not used. | No |
SendAccountNews | YesNoEnum | Whether to send notifications of events related to the campaign. It is set for campaigns that have a personal Yandex manager. For campaigns that are not handled by a personal manager, the passed value is ignored. The default value is NO. | No |
SendWarnings | YesNoEnum | Whether to send email notifications. The default value is NO. | No |
Parameter | Type | Description | Required |
Params structure (for JSON) / AddRequest structure (for SOAP) | |||
---|---|---|---|
Campaigns | array of CampaignUpdateItem | Campaigns whose parameters need to be changed. | Yes |
CampaignUpdateItem structure | |||
Id | long | The ID of the campaign to change parameters for. | Yes |
Name | string | Campaign name (maximum of 255 characters). | No |
ClientInfo | string | Client name (maximum of 255 characters). The default value is the name from the advertiser's settings. Can't be set for UnifiedCampaign. | No |
StartDate | string | Start date for displaying ads, in the format YYYY-MM-DD. Can't be earlier than the current date. Ad displays begin at 00:00 Moscow time (regardless of the TimeZone parameter). The start time for displays is affected by the time targeting settings (the TimeTargeting parameter). Ad displays are possible only if at least one ad has passed review and funds have been credited to the campaign or shared account. If you set a budget for a custom period for the campaign, the value in this field is ignored, and the strategy period is prioritized instead. | No |
EndDate | string, nillable | End date for displaying ads, in the format YYYY-MM-DD. Ad impressions end at 24:00 Moscow time (regardless of the TimeZone parameter). | No |
TimeTargeting | TimeTargeting | Settings for time targeting and hourly bid adjustments. Specified for the time zone set in the TimeZone parameter. | No |
TimeZone | string | Time zone of the advertiser's location. Use the Dictionaries.get method to get a reference list of time zones. The default value is Europe/Moscow. | No |
NegativeKeywords | ArrayOfString, nillable | Array of negative keywords that are shared by all the keywords of a campaign. Restriction. This parameter is not supported for campaigns with the “Display campaign” type. 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. Spaces, dashes, and operators are not counted as part of the total length. | No |
BlockedIps | ArrayOfString, nillable | Array of IP addresses that campaign ads should not be shown to. Maximum of 25 items in the array. | No |
ExcludedSites | ArrayOfString, nillable | Array of display places where the ad shouldn't be displayed:
Maximum of 1000 items in the array. Maximum of 255 characters per array item. | No |
DailyBudget | DailyBudget, nillable | Settings for the daily budget of a campaign. Daily budget management is available if a manual display strategy is selected in the campaign. Otherwise, an attempt to set the daily budget results in an error. To reset the daily budget, pass null (nil). | No |
Notification | Notification | Settings for SMS and email notifications. Can't be set for UnifiedCampaign. | No |
TextCampaign | TextCampaignUpdateItem | Settings for campaigns with the “Text & Image ads” type. For a data structure description, see update: TextCampaign parameters. | No |
MobileAppCampaign | MobileAppCampaignUpdateItem | Settings for “Ads for mobile apps” campaigns. For a data structure description, see update: MobileAppCampaign parameters. | No |
DynamicTextCampaign | DynamicTextCampaignUpdateItem | Settings for campaigns with the “Dynamic ads” type. For a data structure description, see update: DynamicTextCampaign parameters. | No |
CpmBannerCampaign | CpmBannerCampaignUpdateItem | Settings for the “Display campaign” type. For a data structure description, see update: CpmBannerCampaign parameters. | No |
SmartCampaign | SmartCampaignUpdateItem | Settings for “Smart banners” campaigns. For a data structure description, see update: SmartCampaign parameters. | No |
UnifiedCampaign | UnifiedCampaignUpdateItem | Settings for campaigns with the “Unified performance campaign” type. For a data structure description, see update: UnifiedCampaign parameters. | No |
TimeTargeting structure | |||
Schedule | ArrayOfString | Settings for time targeting and hourly bid adjustments. Maximum of 7 items in the array. Each array item contains 25 comma-separated numbers. The first number is the number of the day of the week: from 1 (Monday) to 7 (Sunday). The next 24 numbers are a sequence of bid coefficients for displaying ads in the corresponding hours. Coefficients are specified as percentages from 0 to 200. The value must be a multiple of 10: If the coefficient is 0, no ads are served during this hour. Example of an array element: 1, 0, 0, 50, 50, 100, 100, 150, 200, 200, 150, 100, 100, 80, 70, 100, 100, 100, 50, 50, 40, 30, 0, 0, 0 Note.
| No |
ConsiderWorkingWeekends | YesNoEnum | Whether to change the display schedule when a work day is moved to Saturday or Sunday because of a public holiday. For example, if a work day is moved from Monday to Saturday and the value is YES, on the Saturday work day, ads are displayed according to the Monday schedule, and on the Monday holiday, they are displayed according to the Saturday schedule. | Yes |
HolidaysSchedule | TimeTargetingOnPublicHolidays, nillable | Display settings on public holidays. If the time zone specified in the TimeZone parameter belongs to Russia, Ukraine, Belarus, Kazakhstan, or Turkey, we use the holiday calendar for the appropriate country. In all other cases, we use the Russian calendar. | No |
TimeTargetingOnPublicHolidays structure | |||
SuspendOnHolidays | YesNoEnum | Whether to suspend ads on public holidays: YES — suspend; NO — don't suspend. Note. The BidPercent, StartHour and EndHour parameters can only be set when SuspendOnHolidays has the value NO. | Yes |
BidPercent | int | The bid coefficient for displays on public holidays. Specified as a percentage from 0 to 200. The value must be a multiple of 10. | No |
StartHour | int | The time (in hours) to start displays on public holidays. From 0 to 23. | When the SuspendOnHolidays parameter has the value NO |
EndHour | int | The time (in hours) to end displays on public holidays. From 0 to 24. | When the SuspendOnHolidays parameter has the value NO |
DailyBudget structure | |||
Amount | long | The daily campaign budget in the advertiser currency, multiplied by 1,000,000. The minimum daily budget for each currency is listed in the currency reference. To get the list of currencies, use the Dictionaries.get method. | Yes |
Mode | DailyBudgetModeEnum | Mode for displaying ads:
See the Average daily budget section under “Manual bid management” in the Help for Yandex Direct. | Yes |
Notification structure | |||
SmsSettings | SmsSettings | Settings for sending SMS notifications. The phone number to send notifications to is taken from the advertiser's Yandex profile (see My numbers in the Yandex Passport Help). | No |
EmailSettings | EmailSettings | Settings for sending email notifications. | No |
SmsSettings structure | |||
Events | array of SmsEventsEnum | Events to notify of by SMS:
| No |
TimeFrom | string | 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 |
TimeTo | string | 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 |
EmailSettings structure | |||
Email | string | The email address for sending notifications of campaign events. The default value is the advertiser's address. | No |
CheckPositionInterval | int | The frequency of checking the traffic forecast: 15, 30 or 60 minutes. The default value is 60. A notification is sent if the traffic forecast is lower than the one that the bid covered at the time of configuration. | No |
WarningBalance | int | 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, from 1 to 50. The default value is 20. If the client has the shared account enabled, this parameter is not used. | No |
SendAccountNews | YesNoEnum | Whether to send notifications of events related to the campaign. It is set for campaigns that have a personal Yandex manager. For campaigns that are not handled by a personal manager, the passed value is ignored. The default value is NO. | No |
SendWarnings | YesNoEnum | Whether to send email notifications. The default value is NO. | No |
Response
Response structure in JSON format:
{
"result": { /* result */
"UpdateResults": [{ /* ActionResult */
"Id": (long),
"Warnings": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ...
],
"Errors": [{ /* ExceptionNotification */
"Code": (int), /* required */
"Message": (string), /* required */
"Details": (string)
}, ...
]
}, ... ] /* required */
}
}
Parameter | Type | Description |
Result structure (for JSON) / UpdateResponse structure (for SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Results of changing campaign parameters. |
ActionResult structure | ||
Id | long | The campaign ID. Returned if there are no errors, see Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |
Parameter | Type | Description |
Result structure (for JSON) / UpdateResponse structure (for SOAP) | ||
---|---|---|
UpdateResults | array of ActionResult | Results of changing campaign parameters. |
ActionResult structure | ||
Id | long | The campaign ID. Returned if there are no errors, see Operations on object arrays. |
Warnings | array of ExceptionNotification | Warnings that occurred during the operation. |
Errors | array of ExceptionNotification | Errors that occurred during the operation. |