GetCampaignParams

Returns the campaign parameters.

Attention.

Disabled method. Use version 5 of the API.

For information about the compatibility of methods between versions 4 and 5, see the Migration guide.

The GetCampaignParams (Live) version also exists for this method.

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

Input data

The input data structure in JSON is shown below.

{
   "method": "GetCampaignParams",
   "param": {
      /* CampaignIDInfo */
      "CampaignID": (int)
   }
}

Parameters are described below.

Parameter Description Required
CampaignIDInfo object
CampaignID The ID of the campaign to get parameters for. Yes

Output data

The method returns the CampaignInfo object containing campaign parameters. 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),
      "Shows": (int),
      "Clicks": (int),
      "Strategy": {
         /* CampaignStrategy */
         "MaxPrice": (float),
         "AveragePrice": (float),
         "WeeklySumLimit": (float),
         "ClicksPerWeek": (int),
         "StrategyName": (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)
                  ...
               ]
            }
            ...
         ],
         "TimeZone": (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)
   }
}

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.

Strategy

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

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.

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.

Yandex Advertising Network
ContextPricePercent

Maximum bid in the Yandex Advertising Network, as a percentage of the bid on search. The value is a multiple of ten: 10, 20... 100. The predefined value is 100.

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

Maximum percentage of the budget to be spent on displaying ads in the Yandex Advertising Network. The value must be a multiple of ten or equal to zero: 0, 10, 20... 100.

When the value is 0, impressions are disabled in the Yandex Advertising Network. The predefined NULL value does not put any restrictions on the budget, which is the same as setting Default in the ContextLimit parameter.

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.

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.

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.

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

The number of impressions since the campaign was launched.

Clicks

The number of clicks since the campaign was launched.

CampaignStrategy object
StrategyName

Name of the bid management strategy.

Strategies with manual control:

  • HighestPosition — The “Highest available position” strategy.
  • LowestCost — The “Cheapest position in ad block” strategy.
  • LowestCostPremium — The same as the “Cheapest position in ad block” strategy, but ads are displayed only in Premium Placement.

Automatic strategies:

  • WeeklyBudget — The “Weekly budget” strategy (mandatory parameter WeeklySumLimit; optional parameter MaxPrice).
  • WeeklyPacketOfClicks — The “Weekly click package” strategy (mandatory parameter: ClicksPerWeek; optional parameters: MaxPrice or AveragePrice).
  • AverageClickPrice — The “Average CPC” strategy (mandatory parameter: AveragePrice; optional parameter: WeeklySumLimit).

Two additional manual strategies can be set, but their parameters cannot be configured via the API (only via the web interface):

  • NoPremiumPosition — The “Impressions below search results” strategy.
  • IndependentControl — The “Independent management of search and content sites” strategy.

The last two strategies are set up via the Yandex.Direct web interface. However, either of their names may be present in the response from the GetCampaignsParams method, or be input to the CreateOrUpdateCampaign method. In this case, the API does not change the parameters that were set in the web interface for these strategies.

WeeklySumLimit

Maximum weekly budget for the WeeklyBudget strategy. Can also be set for the AverageClickPrice strategy.

ClicksPerWeek Number of clicks per week for the WeeklyPacketOfClicks strategy.
AveragePrice

Average bid for the AverageClickPrice strategy. Can also be set for the WeeklyPacketOfClicks strategy.

MaxPrice

Maximum bid. Can be set for the WeeklyBudget, CPAOptimizer and WeeklyPacketOfClicks strategies.

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.

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.

Examples of input data

Python

{
   'CampaignID': 1327944
}

PHP

array(
   'CampaignID' => 1327944
)

Perl

{
   'CampaignID' => 1327944
}