GetCampaignsParams (Live)

Returns campaigns parameters.

Restrictions

Alert

The method returns only campaigns with the "Text & Image Ads" type. To work with campaigns of all types, use the Campaigns service in API version 5. Learn more about campaign types...

What's new in Live version 4

Added the ContextStrategy parameter, which sets the ad serving strategy for the Yandex Advertising Network. The ContextLimit, ContextLimitSum, and ContextPricePercent parameters have been moved under the ContextStrategy parameter.

Added the BidCoefs and WorkingHolidays parameters to the time targeting settings.

Added the Currency input parameter and the Currency, CampaignCurrency, BonusDiscount, and SourceCampaignID output parameters.

Added the ClickTrackingEnabled output parameter.

Added the DayBudget and DayBudgetEnabled output parameters.

Added the AverageCPA output parameter for the AverageCPAOptimization strategy.

Added the MobileBidAdjustment output parameter.

Added the EnableRelatedKeywords output parameter.

Added the ReserveReturn, ROICoef, and Profitability output parameters for the ROIOptimization strategy.

Added the ExtendedAdTitleEnabled output parameter.

Added the MaintainNetworkCPC output parameter.

Input data

The structure of input data in JSON format is shown below.

{
   "method": "GetCampaignsParams",
   "param": {
      /* CampaignIDSInfo */
      "CampaignIDS": [
         (int)
         ...
      ],
      "Currency": (string)
   }
}

The parameters are described below.

Parameter	Description	Required
CampaignIDSInfo object
`CampaignIDS`	Array of campaign IDs to get parameters for (no more than 100 IDs).	Yes
`Currency`	Currency in which monetary parameter values should be expressed in the response (bids, budgets, statistics). Possible values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. The value must match the campaign currency. If the parameter is absent or equals NULL, Yandex units are assumed. In this case, if the campaign is run in real currency, the returned values are converted from the campaign currency to Yandex units. If the value is not NULL and does not match the currency of one of the campaigns, an error with code 245 is returned.	No

Output data

The structure of output data in JSON format is shown below.

{
   "data": [
      {  /* CampaignInfo */
         "Login": (string),
         "CampaignID": (int),
         "Name": (string),
         "FIO": (string),
         "StartDate": (date),
         "Sum": (float),
         "Rest": (float),
         "BonusDiscount": (float),
         "Currency": (string),
         "Shows": (int),
         "Clicks": (int),
         "CampaignCurrency": (string),
         "SourceCampaignID": (int),
         "Strategy": {
            /* CampaignStrategy */
            "StrategyName": (string),
            "MaxPrice": (float),
            "AveragePrice": (float),
            "AverageCPA": (float),
            "WeeklySumLimit": (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),
         "Status": (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),
         "ManagerName": (string),
         "AgencyName": (string),
         "StatusShow": (string),
         "StatusArchive": (string),
         "StatusActivating": (string),
         "StatusModerate": (string),
         "IsActive": (string),
         "MinusKeywords": [
            (string)
            ...
         ],
         "AddRelevantPhrases": (string),
         "RelevantPhrasesBudgetLimit": (int),
         "SumAvailableForTransfer": (float),
         "DayBudget": {
            /* DayBudgetInfo */
            "Amount": (float),
            "SpendMode": (string)
         },
         "DayBudgetEnabled": (string),
         "MobileBidAdjustment": (int),
         "EnableRelatedKeywords": (string),
         "ExtendedAdTitleEnabled": (string),
         "MaintainNetworkCPC": (string)
      }
      ...
   ]
}

The parameters are described below.

Parameter	Description
CampaignInfo object
`Login`	Login of the campaign owner (the Yandex user login on whose behalf the advertising campaign is run). When creating a campaign, direct advertisers specify their own Yandex login, while advertising agencies specify their client's login. When retrieving campaign parameters, the login of the advertiser's main representative is returned.
`CampaignID`	Campaign ID. Set to 0 to create a campaign; to change the parameters of an existing campaign, specify its ID.
`Name`	Campaign name.
`FIO`	First and last name of the campaign owner.
`StartDate`	Start of ad serving, `YYYY-MM-DD`. If not set, the campaign creation date is used. The date can be in the future. In this case, ad serving starts when the specified date arrives, provided that the moderator has approved the ads and funds have been deposited to the campaign balance.
`ManagerName`	Name of the personal manager at Yandex. Filled in automatically for campaigns serviced by a personal manager.
`AgencyName`	Name of the advertising agency. Filled in automatically if the campaign was created by an agency.
`Currency`	Currency in which monetary values in the response are expressed (bids, budgets, statistics). Possible values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. If the parameter is absent or equals NULL, Yandex units are implied.
`CampaignCurrency`	Currency in which the campaign is run. Possible values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. If the parameter is absent or equals NULL, this means the campaign is run in Yandex units.
`SourceCampaignID`	ID of the source campaign in Yandex units, if the current campaign was created automatically when the client switched to working in currency. Absent or equals NULL otherwise.
`Strategy`	Defines the ad serving strategy on search. Contains a `CampaignStrategy` object with strategy parameters.
`ContextStrategy`	Defines the ad serving strategy in the Yandex Advertising Network. Contains a `CampaignContextStrategy` object with the strategy name and parameters.
`AdditionalMetrikaCounters`	Array containing Yandex Metrica tag IDs. To delete tag IDs, pass an empty array. If the parameter is absent, the IDs are not changed.
`ClickTrackingEnabled`	Automatically add the `yclid` tag with a unique click number to the ad link — Yes/No. The tag allows more accurate tracking of advertising campaign results in Metrica. For more information, see the section of Yandex Direct Help.
`SmsNotification`	`SmsNotificationInfo` object with SMS notification sending parameters. To receive notifications, you need to subscribe to them (see the Help section The phone number for sending is taken from the user's personal data (see the Help section ).
`EmailNotification`	`EmailNotificationInfo` object with email notification sending parameters.
`TimeTarget`	`TimeTargetInfo` object with time targeting parameters.
`AutoOptimization`	Enable for keywords — Yes/No. Default value — No.
`DisabledDomains`	List of placements where ads should not be served: website domain names; mobile app IDs (bundle ID for iOS, package name for Android); external network names (SSPs). No more than 1000 placements. Values are separated by commas, for example, `site.ru,ru.example.app`.
`DisabledIps`	List of IP addresses to which ads should not be served. Addresses are separated by commas, for example, `127.0.0.1,127.0.0.2`
`ConsiderTimeTarget`	Calculate position prices without taking into account the bids of competitors' stopped ads (stopped according to the schedule) — Yes/No. Default value — No (all ads are taken into account).
`MinusKeywords`	Array of negative keywords shared by all keywords in the campaign. A negative keyword should be specified without a minus sign before the first word. No more than 7 words per negative keyword. Each word can be up to 35 characters long. The total length of negative keywords in the array is 20,000 characters. The “!” or “+” operator before a word is not counted in the total length.
`AddRelevantPhrases`	Add to ads — Yes/No.
`RelevantPhrasesBudgetLimit`	Maximum percentage of the budget spent on clicks for . The value is a multiple of ten: 10, 20, ..., 100. Default value — 100.
`StatusBehavior`	Enable — Yes/No. Default value — Yes.
`StatusMetricaControl`	Stop ad serving when the advertiser's website is unavailable — Yes/No. Unavailability is detected based on monitoring performed by Yandex Direct.
`StatusContextStop`	Do not use in the Yandex Advertising Network the keywords that were disabled on search due to low CTR — Yes/No. Default value — No (when disabled on search, the keyword continues to be used in the Yandex Advertising Network). Alert This parameter is no longer relevant for new keywords, since keywords are no longer disabled for low CTR.
`StatusOpenStat`	When going to the advertiser's website, add an OpenStat tag to the URL — Yes/No. Default value — No.
`SumAvailableForTransfer`	Amount available for transfer using the TransferMoney method. May be less than the campaign balance. Returned only if the shared account is not enabled for the advertiser. The value is expressed in the currency specified in the `Currency` parameter. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places. If the value is expressed in a real currency, it does not include VAT.
`ContextPricePercent`	The parameter is duplicated here for compatibility with stable version 4 and will be removed in the future. The current parameter has been moved to the `CampaignContextStrategy` object.
`ContextLimit`	The parameter is duplicated here for compatibility with stable version 4 and will be removed in the future. The current parameter has been moved to the `CampaignContextStrategy` object.
`ContextLimitSum`	The parameter is duplicated here for compatibility with stable version 4 and will be removed in the future. The current parameter has been moved to the `CampaignContextStrategy` object.
`DayBudget`	`DayBudgetInfo` object with the campaign's daily budget parameters.
`DayBudgetEnabled`	Whether the campaign's daily budget can be managed — Yes/No.
`MobileBidAdjustment`	Bid adjustment coefficient for mobile devices. Used for campaigns and specified as a percentage of the desktop bid. Value range from 50 to 1300. Default value — 100. With this value, the bid on mobile devices equals the desktop bid. For more information about the coefficient, see the section of Yandex Direct Help.
`EnableRelatedKeywords`	is enabled — Yes/No.
`ExtendedAdTitleEnabled`	Substituting part of the ad text into the title is enabled — Yes/No.
`MaintainNetworkCPC`	Keep the average cost per click on themed sites below the average cost on search — Yes/No.
Campaign status
`IsActive`	The campaign is active and ads are being served — Yes/No. Activity means the state of a campaign in which ad serving is enabled and disabled automatically — in accordance with the time targeting settings or depending on the campaign balance. Campaign inactivity means that ad serving is blocked and cannot be enabled automatically.
`Status`	Campaign status, for example: “Impressions on”, “Awaiting payment”, “Under moderation”, “Stopped”, “Impressions on. Activation in progress”, “Campaign archived”, and others.
`StatusShow`	Ad serving for the campaign is enabled — Yes/No. Enabling and disabling is performed using the StopCampaign and ResumeCampaign methods. Enabling serving at the campaign level does not mean that ads are actually being served. For this, other conditions must also be met: sufficient balance, the campaign and ads have been approved by the moderator, serving is enabled at the ad level (the ResumeBanners method). Actual serving corresponds to the value Yes in the `IsActive` parameter.
`StatusArchive`	Campaign archiving status: Yes — the campaign is archived; No — the campaign is not archived; Pending — the campaign is being moved to or restored from the archive. Archiving is performed using the ArchiveCampaign method. The UnArchiveCampaign method is used to restore the campaign from the archive.
`StatusActivating`	Campaign activation status: Yes — activated; Pending — activation pending.
`StatusModerate`	Moderator review result: Yes — the moderator approved at least one ad; No — the moderator rejected all ads; New — the ads have not been submitted for review (campaign status “Draft”); Pending — review in progress. The ModerateBanners method is used to submit ads for review.
Statistics
`Sum`	If the advertiser has a shared account enabled — the total amount of funds spent during the entire lifetime of the campaign. If the shared account is not enabled — the amount of funds deposited to the campaign balance during its lifetime. The value is expressed in the currency specified in the `Currency` parameter. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places. If the value is expressed in a real currency, it does not include VAT.
`Rest`	Current shared account balance + the amount returned to the campaign (if the advertiser has a shared account enabled), or the current campaign balance (if the shared account is not enabled). Note The amount refunded for clicks recognized by the system as fraudulent or erroneous can only be spent within the same campaign. The value is expressed in the currency specified in the `Currency` parameter. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places. If the value is expressed in a real currency, it does not include VAT.
`BonusDiscount`	Discount bonus proportional to the current balance. Currently, the discount is not applied.
`Shows`	Number of impressions during the entire lifetime of the campaign.
`Clicks`	Number of clicks during the entire lifetime of the campaign.
CampaignStrategy object
`StrategyName`	Strategy on search. The possible values are listed below. ShowsDisabled — disable ad serving on search. This is required for using an automatic strategy in the Yandex Advertising Network. Serving on search cannot be disabled if the Default strategy is applied in the Yandex Advertising Network. Manual bid management strategies on search: HighestPosition — “Highest available position” strategy; LowestCost — “Cheapest position in ad block” strategy; LowestCostPremium — “Cheapest position in ad block” strategy, but ads are only served in Premium placement; LowestCostGuarantee — “Impressions below search results” strategy (in the lower block at the lowest price); RightBlockHighest — “Impressions below search results” strategy (in the lower block at the highest position available at the specified bid). Automatic strategies on search: WeeklyBudget — “Weekly budget: maximum clicks” strategy (required parameter `WeeklySumLimit`, optional `MaxPrice`); CPAOptimizer — “Weekly budget: maximum conversion rate” strategy (required parameters `WeeklySumLimit` and `GoalID`, optional `MaxPrice`); see the in Yandex Direct Help; AverageClickPrice — “Average CPC” strategy (required parameter `AveragePrice`, optional `WeeklySumLimit`); WeeklyPacketOfClicks — “Weekly click package” strategy (required parameter `ClicksPerWeek`, optional `MaxPrice` or `AveragePrice`); AverageCPAOptimization — “Average CPA” strategy (required parameters `AverageCPA` and `GoalID`, optional `WeeklySumLimit` and `MaxPrice`); see the in Yandex Direct Help; ROIOptimization — “Average ROI” strategy (required parameters `ReserveReturn`, `ROICoef`, `GoalID`, optional `Profitability`, `WeeklySumLimit` and `MaxPrice`); see the in Yandex Direct Help.
`MaxPrice`	Maximum bid (in the currency specified in the `Currency` parameter) for the WeeklyBudget, WeeklyPacketOfClicks, CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies. If the returned value is converted from the campaign currency to Yandex units, it is rounded down to the bidding step (0.01 Yandex units).
`AveragePrice`	Average bid (in the currency specified in the `Currency` parameter) for the AverageClickPrice strategy. Can also be set for the WeeklyPacketOfClicks strategy. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places.
`AverageCPA`	Average cost per conversion (in the currency specified in the `Currency` parameter) for the AverageCPAOptimization strategy. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places.
`WeeklySumLimit`	Maximum weekly budget (in the currency specified in the `Currency` parameter) for the WeeklyBudget and CPAOptimizer strategies. Can also be set for the AverageClickPrice, AverageCPAOptimization, and ROIOptimization strategies. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places.
`ClicksPerWeek`	Number of clicks per week for the WeeklyPacketOfClicks strategy.
`GoalID`	ID of the Yandex Metrica for the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies. The value 0 — all goals configured on the site (except composite goals). The list of suitable goals is retrieved using the GetStatGoals method.
`ReserveReturn`	Maximum percentage of saved funds for the ROIOptimization strategy that can be returned to advertising (spent) if the projected ROI value exceeds the value of the `ROICoef` parameter. Value from 0 to 100, a multiple of ten: 0, 10, 20... 100.
`ROICoef`	Desired average return on investment per week for the ROIOptimization strategy.
`Profitability`	Percentage of revenue that is the cost of goods or services, for the ROIOptimization strategy. Value from 0 to 100, rounded to two decimal places.
CampaignContextStrategy object
`StrategyName`	Strategy in the Yandex Advertising Network. The possible values are listed below. ShowsDisabled — disable ad serving in the Yandex Advertising Network. This is only possible if serving is not disabled on search. Manual bid management strategies in the Yandex Advertising Network: Default — “Percentage of the search bid” strategy. The percentage is set in the `ContextPricePercent` parameter. Optional parameters — `ContextLimit` and `ContextLimitSum`. This strategy is applied to campaigns that have no strategy explicitly assigned. MaximumCoverage — “Maximum audience coverage” strategy. Bids are set using one of the following methods: CreateOrUpdateBanners, SetAutoPrice (Live), UpdatePrices. Warning The MaximumCoverage strategy is not available if any automatic strategy is selected on search. Automatic strategies in the Yandex Advertising Network: Warning Automatic strategies in the Yandex Advertising Network are available only if ad serving is disabled on search (the ShowsDisabled strategy). WeeklyBudget — “Weekly budget: maximum clicks” strategy (required parameter `WeeklySumLimit`, optional `MaxPrice`); CPAOptimizer — “Weekly budget: maximum conversion rate” strategy (required parameters `WeeklySumLimit` and `GoalID`, optional `MaxPrice`); see the in Yandex Direct Help; AverageClickPrice — “Average CPC” strategy (required parameter `AveragePrice`, optional `WeeklySumLimit`); WeeklyPacketOfClicks — “Weekly click package” strategy (required parameter `ClicksPerWeek`, optional `MaxPrice` or `AveragePrice`); AverageCPAOptimization — “Average CPA” strategy (required parameters `AverageCPA` and `GoalID`, optional `WeeklySumLimit` and `MaxPrice`); see the in Yandex Direct Help; ROIOptimization — “Average ROI” strategy (required parameters `ReserveReturn`, `ROICoef`, `GoalID`, optional `Profitability`, `WeeklySumLimit` and `MaxPrice`); see the in Yandex Direct Help.
`ContextLimit`	Budget limit for ad serving in the Yandex Advertising Network: Default — the budget is not limited (default value); Limited — the budget is limited by the value of the `ContextLimitSum` parameter. To avoid spending funds on serving in the Yandex Advertising Network, disable serving using the ShowsDisabled strategy (the `StrategyName` parameter).
`ContextLimitSum`	Maximum percentage of the budget spent on serving in the Yandex Advertising Network on themed sites. The value is a multiple of ten: 10, 20, ..., 100. If the value is not set (null), the budget is not limited (equivalent to Default in the `ContextLimit` parameter).
`ContextPricePercent`	Parameter for calculating the cost per click in the Yandex Advertising Network on themed sites. Used for the Default strategy. Set as a percentage of the cost per click on search. The value is a multiple of ten: 10, 20, ..., 100. The value 100 makes the cost per click in the Yandex Advertising Network equal to the cost on search.
`MaxPrice`	Maximum bid (in the currency specified in the `Currency` parameter) for the WeeklyBudget, WeeklyPacketOfClicks, CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies. If the returned value is converted from the campaign currency to Yandex units, it is rounded down to the bidding step (0.01 Yandex units).
`AveragePrice`	Average bid (in the currency specified in the `Currency` parameter) for the AverageClickPrice strategy. Can also be set for the WeeklyPacketOfClicks strategy. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places.
`AverageCPA`	Average cost per conversion (in the currency specified in the `Currency` parameter) for the AverageCPAOptimization strategy. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places.
`WeeklySumLimit`	Maximum weekly budget (in the currency specified in the `Currency` parameter) for the WeeklyBudget and CPAOptimizer strategies. Can also be set for the AverageClickPrice, AverageCPAOptimization, and ROIOptimization strategies. If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places.
`ClicksPerWeek`	Number of clicks per week for the WeeklyPacketOfClicks strategy.
`GoalID`	ID of the Yandex Metrica for the CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies. The value 0 — all goals configured on the site (except composite goals). The list of suitable goals is retrieved using the GetStatGoals method.
`ReserveReturn`	Maximum percentage of saved funds for the ROIOptimization strategy that can be returned to advertising (spent) if the projected ROI value exceeds the value of the `ROICoef` parameter. Value from 0 to 100, a multiple of ten: 0, 10, 20... 100.
`ROICoef`	Desired average return on investment per week for the ROIOptimization strategy.
`Profitability`	Percentage of revenue that is the cost of goods or services, for the ROIOptimization strategy. Value from 0 to 100, rounded to two decimal places.
SmsNotificationInfo object
`MetricaSms`	Report website monitoring results based on Yandex Metrica data — Yes/No.
`ModerateResultSms`	Report ad moderation results — Yes/No.
`MoneyInSms`	Notify about funds deposited to the campaign balance — Yes/No. Default value — No. If the client has a shared account enabled, the value of the corresponding shared account parameter is returned.
`MoneyOutSms`	Notify when funds on the campaign balance run out — Yes/No. Default value — No. If the client has a shared account enabled, the value of the corresponding shared account parameter is returned.
`SmsTimeFrom`	Time from which SMS messages about campaign-related events are allowed to be sent. Specified in the HH:MM format, minutes are set in multiples of 15 (0, 15, 30, 45). For example, “19:45”.
`SmsTimeTo`	Time until which SMS messages about campaign-related events are allowed to be sent. Specified in the HH:MM format, minutes are set in multiples of 15 (0, 15, 30, 45). For example, “19:45”.
EmailNotificationInfo object
`SendWarn`	Send email notifications — Yes/No. Default value — No.
`Email`	Email address for sending notifications about campaign-related events.
`WarnPlaceInterval`	Frequency of checking the ad's position — 15, 30, or 60 minutes. A notification is sent if the ad has moved to a lower position than the one provided by the bid at the time it was set.
`MoneyWarningValue`	Minimum balance at which a notification is sent when reached. Set as a percentage of the last payment amount. Default value — 20. If the client has a shared account enabled, the value of the corresponding shared account parameter is returned.
`SendAccNews`	Notify about campaign-related events — Yes/No. Set for campaigns serviced by a personal manager at Yandex. Default value — No.
TimeTargetInfo object
`ShowOnHolidays`	Serve ads on public holidays — Yes/No (regular Saturdays and Sundays are not included). Default value — Yes.
`HolidayShowFrom`	Hour from which ads are served on public holidays. If the parameter is absent, serving follows the schedule from the `DaysHours` parameter.
`HolidayShowTo`	Hour until which ads are served on public holidays. If the parameter is absent, serving follows the schedule from the `DaysHours` parameter.
`DaysHours`	Array of `TimeTargetItem` objects defining the serving schedule (time targeting).
`TimeZone`	Time zone of the advertising campaign owner's location. The list of time zones can be retrieved using the GetTimeZones method.
`WorkingHolidays`	Change the serving schedule when a working day is moved to Saturday or Sunday — Yes/No. For example, if a working day is moved from Monday to Saturday, with the value Yes, on the working Saturday ads will be served according to Monday's schedule, and on the non-working Monday — according to Saturday's schedule.
TimeTargetItem object
`Hours`	Array of integers from 0 to 23. The number 0 corresponds to the time interval from 00:00 to 00:59 inclusive, the number 1 — from 01:00 to 01:59 inclusive, and so on. Default value — an array of numbers from 0 to 23 corresponds to a full day.
`Days`	Array of integers from 1 to 7. The number 1 corresponds to Monday, the number 7 — to Sunday. On the specified days, ads are served according to the value of the `Hours` parameter. Default value — an array of numbers from 1 to 7 corresponds to a full week.
`BidCoefs`	Array of coefficients that increase or decrease the cost per click at certain hours. Applied to manual bid management strategies. Coefficients are specified as percentages, the value must be a multiple of ten: 0, 10, 20... 200. You must specify as many coefficients as there are hours in the `Hours` array. Each coefficient corresponds to a specific hour in the order they appear in the array. If the parameter is absent, the previously set coefficients are not changed.
DayBudgetInfo object
`Amount`	Campaign daily budget (in the currency specified in the `Currency` parameter). If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to two decimal places.
`SpendMode`	Distribute the daily budget evenly throughout the day — Default/Stretched. With the Default value, the daily budget may run out and serving may end before the end of the day.

Input data examples

Python

{
   'CampaignIDS': [1327944, 1327974]
}

PHP

array(
   'CampaignIDS' => array(1327944, 1327974)
)

Perl

{
   'CampaignIDS' => [1327944, 1327974]
}

Was the article helpful?

GetCampaignsParams

ResumeCampaign