Campaign

The Campaign object contains an advertising campaign's settings and summary statistics.

Service

Use the Campaigns service for managing campaigns.

Methods

add | update | delete | suspend | resume | archive | unarchive | get

To manage a unified performance campaign, use this URL: https://api.direct.yandex.com/v501/.

Restrictions

To get the limit on the number of campaigns for an advertiser, use the method Clients.get or AgencyClients.get (see the CAMPAIGNS_TOTAL_PER_CLIENT and CAMPAIGNS_UNARCHIVED_PER_CLIENT elements in the Restrictions array).

Campaign type

The campaign type is set when creating a campaign and can't be changed.

The campaign type determines the type for child ad groups. You can only add the corresponding type of groups to the campaign.

Part of the campaign parameters are shared across all types of campaigns, and part of them depend on the type of campaign. The parameters that depend on the campaign type are passed in a child structure with the corresponding name.

The following types of campaigns are currently available:

• TEXT_CAMPAIGN: Campaign of the "Text & Image ads" type.

  To create or edit this type of campaign, you must pass the campaign parameters in the TextCampaign structure for the add or update method. Parameters are described in the sections add: TextCampaign parameters and update: TextCampaign parameters.

  When getting campaign parameters, list the names of parameters that are shared across all campaign types in the FieldNames input parameter, and list the names of parameters that are specific to this campaign type in the TextCampaignFieldNames input parameter of theget method. For descriptions of the parameters returned for this type of campaign, see the section get: TextCampaign parameters.

• UNIFIED_CAMPAIGN: Unified performance campaign.

  To create or edit this type of campaign, use the add and update methods with the campaign parameters defined in the UnifiedCampaign structure. Parameters are described in add: UnifiedCampaign parameters and update: UnifiedCampaign parameters.

  When getting campaign parameters, list the names of the parameters shared across all campaign types in the FieldNames input parameter, and list the names of parameters specific to this campaign type in the UnifiedCampaignFieldNames input parameter of the get method. For the descriptions of parameters returned for this type of campaign, see get: UnifiedCampaign parameters.

• SMART_CAMPAIGN: Campaign of the "Smart banners" type. For more information about smart banners, see Smart banners in Yandex Direct Help.

  To create or edit this type of campaign, use the add or update method with the campaign parameters defined in the SmartCampaign structure. Parameters are described in add: SmartCampaign parameters and update: SmartCampaign parameters.

  When getting campaign parameters, list the names of parameters that are shared across all campaign types in the FieldNames input parameter, and list the names of parameters that are specific to this campaign type in the SmartCampaignFieldNames input parameter of the get method. For descriptions of the parameters returned for this type of campaign, see get: SmartCampaign parameters.

• DYNAMIC_TEXT_CAMPAIGN: Campaign of the "Dynamic ads" type. For more information about dynamic ads, see Dynamic ads in Yandex Direct Help.

  To create or edit this type of campaign, use the add or update method with the campaign parameters defined in the DynamicTextCampaign structure. Parameters are described in the sections add: DynamicTextCampaign parameters and update: DynamicTextCampaign parameters.

  When getting campaign parameters, list the names of parameters that are shared across all campaign types in the FieldNames input parameter, and list the names of parameters that are specific to this campaign type in the DynamicTextCampaignFieldNames input parameter of the get method. For descriptions of the parameters returned for this type of campaign, see the section get: DynamicTextCampaign parameters.

• MOBILE_APP_CAMPAIGN: Campaign of the "Ads for Mobile Apps" type. For more information about ads for mobile apps, see Ads for Mobile Apps in Yandex Direct Help.

  To create or edit this type of campaign, use the add or update method with the campaign parameters defined in the MobileAppCampaign structure. Parameters are described in the sections add: MobileAppCampaign parameters and update: MobileAppCampaign parameters.

  When getting campaign parameters, list the names of parameters that are shared across all campaign types in the FieldNames input parameter, and list the names of parameters that are specific to this campaign type in the MobileAppCampaignFieldNames input parameter of the get method. For descriptions of the parameters returned for this type of campaign, see the section get: MobileAppCampaign parameters.

• MCBANNER_CAMPAIGN: Campaign of the "Search banner" type. For more information about banners in search results, see Search banners in Yandex Direct Help.

  This type of campaign only allows getting statistics via the Yandex Direct API.

• CPM_BANNER_CAMPAIGN: Campaign of the "Display campaign" type. For more information about display campaigns, see Display banners in Yandex Direct Help.

  To create or edit this type of campaign, use the add or update method with the campaign parameters defined in the CpmBannerCampaign structure. Parameters are described in the sections add: CpmBannerCampaign parameters, update: CpmBannerCampaign parameters.

  When getting campaign parameters, list the names of parameters that are shared across all campaign types in the FieldNames input parameter, and list the names of parameters that are specific to this campaign type in the CpmBannerCampaignFieldNames input parameter of the get method. For descriptions of the parameters returned for this type of campaign, see the section get: CpmBannerCampaign parameters.

• CPM_DEALS_CAMPAIGN: Campaign of the "Display campaign with deals" type. For more information about deals, see Deals in Yandex Direct Help.

  This type of campaign only allows getting statistics via the Yandex Direct API.

• CPM_FRONTPAGE_CAMPAIGN: Campaign of the "Display campaign on the Yandex Home page" type. For more information about this campaign type, see Display banner on the Yandex Home page in Yandex Direct Help.

  This type of campaign only allows getting statistics via the Yandex Direct API.

• CPM_PRICE: Campaign of the "Fixed CPM campaign" type. For more information about this type of campaign, see Campaigns with fixed CPM in Yandex Direct Help.

  This type of campaign only allows getting statistics via the Yandex Direct API.

Display strategies

See the section Display strategies.

Monetary parameters

Limits on monetary parameters are listed for each currency in the currency reference. To get the list of currencies, use the Dictionaries.get method.

Campaign status and state

The State parameter reflects the current state of displays in the campaign.

State	Description
CONVERTED	The campaign was run in Yandex units before the advertiser switched to a real currency. It is currently in a special archive and available only for read access. Note The get method returns a campaign in the CONVERTED state only if the States parameter is set to CONVERTED or the ID of this campaign is specified in the Ids parameter. If the Ids and States parameters are both omitted, the method doesn't return a campaign in the CONVERTED state.
ARCHIVED	The campaign has been archived using the archive method, by the user in the web interface, or automatically (if the account funds were depleted and there haven't been any displays for more than 30 days).
SUSPENDED	The owner has stopped the campaign using the suspend method or in the web interface.
ENDED	The campaign ended (the end date has passed).
ON	The campaign is active and ads can be displayed.
OFF	The campaign is inactive (draft, pending review, rejected, no funds on the campaign or on the shared account, or no active ads).
UNKNOWN	Used for providing backward compatibility and displaying states that are not supported in this version of the API.

The Status parameter reflects the overall result of reviewing the campaign objects.

Status	Description
DRAFT	The campaign has been created but has not yet been submitted for review.
MODERATION	The campaign is under review.
ACCEPTED	At least one of the campaign's ads was accepted after review.
REJECTED	All of the campaign's ads were rejected after review.
UNKNOWN	This value is used for backward compatibility and for displaying statuses that are not supported in this version of the API.

The StatusPayment parameter indicates whether the campaign is ready for payments.

Payment status	Description
DISALLOWED	Payment is not allowed (or only pre-payment before being reviewed is available).
ALLOWED	The campaign was accepted after review, or the shared account is enabled.

For an advertiser

Limits on the number of objects for an advertiser.

For an agency

—