GetCampaignsParams (Live)

Returns the campaign parameters.

Attention.

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

Attention. This method only returns campaigns with the “Text & Image Ads” type. To work with all types of campaigns, use the Campaigns service in version 5 of the API. More information about campaign types

New in the Live 4 version

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 and WorkingHolidays parameters to the time targeting settings.

Added the Currency input parameter and Currency, CampaignCurrency, BonusDiscount, and SourceCampaignID output parameters (also see the section Real currencies instead of Yandex units).

Added the ClickTrackingEnabled output parameter.

Added the DayBudget and DayBudgetEnabled 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 input data structure in JSON is shown below.

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

Parameters are described below.

Parameter Description Required
CampaignIDSInfo object
CampaignIDS An array of campaign IDs that you need to get parameters for (no more than 100 IDs). Yes
Currency

The currency to use for the values of monetary parameters in the response (bids, budgets, statistics).

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 operates using a real currency, returned values are converted from the campaign's currency to Yandex units (see the section Real currencies instead of Yandex units).

If the value is something other than NULL but it does not match the currency of one of the campaigns, an error is returned with code 245.

No

Output data

The output data structure in JSON 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)
      }
      ...
   ]
}

Parameters are described below.

Parameter Description
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.

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.

Name

The campaign name.

FIO

First name and last name of the campaign owner.

StartDate

Date to start impressions, YYYY-MM-DD. If omitted, the campaign creation date is used.

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.

ManagerName

Name of the personal Yandex manager. It is filled in automatically for campaigns that have a personal manager.

AgencyName

Name of the advertising agency. It is filled in automatically if the campaign was created by an agency.

Currency

The currency to use for monetary values in the response (bids, budgets, statistics).

Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. If this parameter is omitted or NULL, Yandex units are used.

CampaignCurrency

The currency the campaign operates in.

Acceptable values: RUB, CHF, EUR, KZT, TRY, UAH, USD, BYN. If the parameter is omitted or set to NULL, it means the campaign operates in Yandex units.

SourceCampaignID ID of the unit-based source campaign, if the current campaign was created automatically when switching the client to using currency (see the section Switching to currency). Otherwise, omitted or set to NULL.
Strategy

Defines the display strategy on search. Contains the CampaignStrategy object with the strategy parameters.

ContextStrategy

Determines the display strategy for the Yandex Advertising Network. Contains the CampaignContextStrategy object with the name and parameters of the strategy.

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.

ClickTrackingEnabled Automatically add the yclid tag with a unique click ID to the ad link — Yes/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.
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).

EmailNotification

The EmailNotificationInfo object with parameters for sending notifications by email.

TimeTarget

The TimeTargetInfo object with time targeting parameters.

AutoOptimization

Enable automatic keyword optimization — Yes/No. The predefined value is No.

DisabledDomains

List of display places where the ad shouldn't be displayed:

  • Domain names of websites.
  • IDs of mobile apps (the bundle ID for iOS, or the package name for Android).
  • Names of ad exchanges (SSPs).

Maximum of 1000 display places. Values are comma-separated. For example, site.ru,ru.example.app.

DisabledIps

List of IP addresses that campaign ads should not be shown to. Addresses are separated by commas, such as 127.0.0.1,127.0.0.2.

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).

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.

AddRelevantPhrases

Add additional relevant keywords to ads — Yes/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.

StatusBehavior

Enable behavioral targeting — Yes / No. The predefined value is Yes.

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.

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.

StatusOpenStat

When redirecting to the advertiser's web site, append an OpenStat tag to the URL — Yes/No. The predefined value is No.

SumAvailableForTransfer

The amount available to transfer using the TransferMoney method. It may be less than the campaign balance. It is returned only if the advertiser has not enabled the shared account.

The value is shown 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 the second decimal point (see the section Real currencies instead of Yandex units).

If the value is expressed in a real currency, it does not include VAT.

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.

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.

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.

DayBudget The DayBudgetInfo object with parameters of the daily campaign budget.
DayBudgetEnabled Daily campaign budget management is available — Yes/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.

EnableRelatedKeywords

Related keywords tool enabled — Yes/No.

ExtendedAdTitleEnabled Substituting part of the ad text in the title is enabled — Yes/No.
MaintainNetworkCPC Keep the average CPC on content sites lower than the average CPC on search — Yes/No.
Campaign state
IsActive

The campaign is active and ads are being displayed — Yes/No.

"Active" is defined as the campaign state in which ad impressions are turned on and off automatically, according to the time targeting settings or depending on the campaign balance. An "inactive" campaign means that ad impressions are disabled and can't be enabled automatically.

Status The campaign status. For example: “Running impressions”, “Waiting for payment”, “Under moderation”, “Stopped”, “Running impressions. Activating”, “Archived campaign”, and others.
StatusShow

Ad impressions are enabled for the campaign — Yes/No. Turning on and off is performed by methods StopCampaign and ResumeCampaign.

Allowing displays at the campaign level does not mean that the ad is actually displayed. For impressions, other conditions must be met as well: sufficient funds, moderator approval of the campaign and ads, and enabled displays on the ad level (ResumeBanners method). An actual impression corresponds to the Yes value in the IsActive parameter.

StatusArchive

Campaign archive status:

  • Yes — Campaign has been archived.
  • No — Campaign is not in the archive.
  • Pending — The campaign is being transferred to the archive, or is being restored from the archive.
  • CurrencyConverted — The campaign was automatically archived when switching the client to using currency, and cannot be unarchived (see the section Real currencies instead of Yandex units).

Use the ArchiveCampaign method to transfer a campaign to the archive. Use the UnArchiveCampaign method to restore a campaign from the archive.

StatusActivating

Campaign activation status:

  • Yes — Activated.
  • Pending — Waiting for activation.
StatusModerate

Moderation result:

  • Yes — Moderator approved at least one ad.
  • No — Moderator rejected all the ads.
  • New — Ads have not been submitted for moderation (the campaign has the “Draft” status).
  • Pending — Under moderation.

Use the ModerateBanners method to submit a Creative for moderation.

Statistics
Sum

If the advertiser has the shared account enabled, this is the total amount of funds spent over the campaign's existence.

If the shared account is disabled, this is the amount of funds added to the campaign over the campaign's existence.

The value is shown 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 the second decimal point (see the section Real currencies instead of Yandex units).

If the value is expressed in a real currency, it does not include VAT.

Rest

The current balance of the shared account + the amount refunded to the campaign (if the advertiser has the shared account enabled) or the current campaign balance (if the shared account is disabled).

Note. The amount of money returned for clicks that the system determines to be fraudulent or mistaken; this amount can be spent only within the same campaign.

The value is shown 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 the second decimal point (see the section Real currencies instead of Yandex units).

If the value is expressed in a real currency, it does not include VAT.

BonusDiscount The discount bonus in proportion to the current balance. Currently, the discount is not being applied.
Shows

The number of impressions since the campaign was launched.

Clicks

The number of clicks since the campaign was launched.

CampaignStrategy object
StrategyName

Strategy on search. Acceptable values are listed below.

  • ShowsDisabled — Disable impressions on search. This is required when using an automatic strategy in the Yandex Advertising Network. Showing ads in the search cannot be disabled if the Default strategy is applied to the Yandex Advertising Network.

Strategies with manual bid management on search:

  • HighestPosition — “Highest available position” strategy.
  • LowestCost — “Cheapest position in ad block” strategy.
  • LowestCostPremium — “Cheapest position in ad block” strategy, but ads are displayed only in Premium Placement.
  • LowestCostGuarantee — “Impressions below search results” strategy (in the lower block at lowest cost).
  • RightBlockHighest — The “Impressions below search results” strategy (in the lower block at the highest position available for the specified bid).

Automatic strategies on search:

  • WeeklyBudget — The “Weekly budget: maximum clicks” strategy (mandatory parameter WeeklySumLimit; optional parameter MaxPrice).
  • CPAOptimizer — The “Weekly budget: maximum conversion rate” strategy (mandatory parameters WeeklySumLimit and GoalID; optional parameter MaxPrice). See the conditions for using this strategy in the Help for Yandex.Direct.
  • AverageClickPrice — The “Average CPC” strategy (mandatory parameter: AveragePrice; optional parameter: WeeklySumLimit).
  • WeeklyPacketOfClicks — The “Weekly click package” strategy (mandatory parameter: ClicksPerWeek; optional parameters: MaxPrice or AveragePrice).
  • AverageCPAOptimization — The “Average CPA” strategy (mandatory parameters AverageCPA and GoalID; optional parameters WeeklySumLimit and MaxPrice). See the conditions for using this strategy in the Help for Yandex.Direct.
  • ROIOptimization — The “Average ROI” strategy (mandatory parameters ReserveReturn, ROICoef, GoalID; optional parameters Profitability, WeeklySumLimit and MaxPrice). See the conditions for using this strategy in the Help for Yandex.Direct.
MaxPrice

Maximum bid (in the currency set in the Currency parameter) for the WeeklyBudget, WeeklyPacketOfClicks, CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies.

If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded down to the bid increment (0.01 Yandex units; also see the section Real currencies instead of Yandex units).

AveragePrice

Average bid (in the currency set 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 the second decimal place.

AverageCPA

Average conversion price (in the currency set 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 the second decimal place.

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.

If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to the second decimal place.

ClicksPerWeek Number of clicks per week 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 of 0 is all goals set on the site (except composite goals).

Use the GetStatGoals method to get a list of appropriate goals.

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.

ROICoef The desired average return on investment per week 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.

CampaignContextStrategy object
StrategyName

Strategy in the Yandex Advertising Network. Acceptable values are listed below.

  • ShowsDisabled — Disable impressions in the Yandex Advertising Network. This is possible only if impressions are not disabled on search.

Strategies with manual bid management for the Yandex Advertising Network:

  • Default — The “Percentage of the price on Search” strategy. The percent is set in the ContextPricePercent parameter. There are additional optional parameters, ContextLimit and ContextLimitSum. This strategy is applied to campaigns that do not have a strategy explicitly set for them.

  • MaximumCoverage — “Maximum audience coverage” strategy. Bids are set using one of these methods: CreateOrUpdateBanners, SetAutoPrice (Live), UpdatePrices.

    Important. The MaximumCoverage strategy is not available if an automatic strategy is selected for search.

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).

  • WeeklyBudget — The “Weekly budget: maximum clicks” strategy (mandatory parameter WeeklySumLimit; optional parameter MaxPrice).
  • CPAOptimizer — The “Weekly budget: maximum conversion rate” strategy (mandatory parameters WeeklySumLimit and GoalID; optional parameter MaxPrice). See the conditions for using this strategy in the Help for Yandex.Direct.
  • AverageClickPrice — The “Average CPC” strategy (mandatory parameter: AveragePrice; optional parameter: WeeklySumLimit).
  • WeeklyPacketOfClicks — The “Weekly click package” strategy (mandatory parameter: ClicksPerWeek; optional parameters: MaxPrice or AveragePrice).
  • AverageCPAOptimization — The “Average CPA” strategy (mandatory parameters AverageCPA and GoalID; optional parameters WeeklySumLimit and MaxPrice). See the conditions for using this strategy in the Help for Yandex.Direct.
  • ROIOptimization — The “Average ROI” strategy (mandatory parameters ReserveReturn, ROICoef, GoalID; optional parameters Profitability, WeeklySumLimit and MaxPrice). See the conditions for using this strategy in the Help for Yandex.Direct.
ContextLimit

Budget limit for impressions in the Yandex Advertising Network:

  • Default means the budget is unlimited (this is the predefined value).
  • Limited means the budget is limited by the value of the ContextLimitSum parameter.

To avoid spending funds on impressions in the Yandex Advertising Network, disable impressions using the ShowsDisabled strategy (StrategyName parameter).

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).

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.

MaxPrice

Maximum bid (in the currency set in the Currency parameter) for the WeeklyBudget, WeeklyPacketOfClicks, CPAOptimizer, AverageCPAOptimization, and ROIOptimization strategies.

If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded down to the bid increment (0.01 Yandex units; also see the section Real currencies instead of Yandex units).

AveragePrice

Average bid (in the currency set 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 the second decimal place.

AverageCPA

Average conversion price (in the currency set 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 the second decimal place.

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.

If the returned value is converted from the campaign's currency to Yandex units, it is mathematically rounded to the second decimal place.

ClicksPerWeek Number of clicks per week 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 of 0 is all goals set on the site (except composite goals).

Use the GetStatGoals method to get a list of appropriate goals.

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.

ROICoef The desired average return on investment per week 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.

SmsNotificationInfo object
MetricaSms Notify of Yandex.Metrica site monitoring results — Yes/No.
ModerateResultSms Notify of ad moderation results — Yes/No.
MoneyInSms

Notify when funds are credited to the campaign balance — Yes/No. The predefined value is No.

When the client has the shared account enabled, it returns the value of the corresponding parameter for the shared account.

MoneyOutSms

Notify when the campaign balance is out of funds — Yes/No. The predefined value is No.

When the client has the shared account enabled, it returns the value of the corresponding parameter for the shared account.

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”.
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”.
EmailNotificationInfo object
SendWarn

Whether to send email notifications — Yes/No. The predefined value is No.

Email The email address for sending notifications of campaign events.
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.

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.

When the client has the shared account enabled, it returns the value of the corresponding parameter for the shared account.

SendAccNews

Notify of campaign events — Yes/No. It is set for campaigns that have a personal Yandex manager. The predefined value is 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.

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.

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.

DaysHours

Array of TimeTargetItem objects that determines the schedule for ad displays (time targeting).

TimeZone

Time zone where the ad campaign owner is located. To get the list of time zones, use the GetTimeZones method.

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.

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.

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.

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.

DayBudgetInfo object
Amount

The daily campaign 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 the second decimal place.

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.

Examples of input data

Python

{
   'CampaignIDS': [1327944, 1327974]
}

PHP

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

Perl

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