--- metadata: - name: generator content: Diplodoc Platform v5.52.0 alternate: - https://yandex.ru/dev/direct/doc/en/objects/campaign.md - https://yandex.ru/dev/direct/doc/ru/objects/campaign.md - href: en/objects/campaign.md type: text/markdown title: Markdown version - href: ../llms.txt type: text/markdown title: llms.txt sourcePath: en/dg/objects/campaign.md --- > **Documentation Index:** Fetch the complete configuration index at https://yandex.ru/dev/direct/doc/en/llms.txt # Campaign The Campaign object contains campaign settings and summary statistics. ## Service {#service} Use the [Campaigns](https://yandex.com/dev/direct/doc/campaigns/campaigns.html) service for managing campaigns. ### Methods {#methods} [add](https://yandex.com/dev/direct/doc/campaigns/add.html) | [update](https://yandex.com/dev/direct/doc/campaigns/update.html) | [delete](https://yandex.com/dev/direct/doc/campaigns/delete.html) | [suspend](https://yandex.com/dev/direct/doc/campaigns/suspend.html) | [resume](https://yandex.com/dev/direct/doc/campaigns/resume.html) | [archive](https://yandex.com/dev/direct/doc/campaigns/archive.html) | [unarchive](https://yandex.com/dev/direct/doc/campaigns/unarchive.html) | [get](https://yandex.com/dev/direct/doc/campaigns/get.html) To manage a unified performance campaign, use this URL: `https://api.direct.yandex.com/v501/`. ## Restrictions {#restrictions} To get the limit on the number of campaigns for a user, call the [Clients](https://yandex.com/dev/direct/doc/clients/clients.html).[get](https://yandex.com/dev/direct/doc/clients/get.html) or [AgencyClients](https://yandex.com/dev/direct/doc/agencyclients/agencyclients.html).[get](https://yandex.com/dev/direct/doc/agencyclients/get.html) method (look for the CAMPAIGNS_TOTAL_PER_CLIENT and CAMPAIGNS_UNARCHIVED_PER_CLIENT elements in the [Restrictions](*Restrictions) array). ## Campaign type {#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](https://yandex.ru/dev/direct/doc/en/objects/adgroup.md). 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](https://yandex.com/dev/direct/doc/campaigns/add.html) or [update](https://yandex.com/dev/direct/doc/campaigns/update.html) method. Parameters are described in the sections [add: TextCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/add-text-campaign.html) and [update: TextCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/update-text-campaign.html). 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 the[get](https://yandex.com/dev/direct/doc/campaigns/get.html) method. For descriptions of the parameters returned for this type of campaign, see the section [get: TextCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/get-text-campaign.html). - UNIFIED_CAMPAIGN: Unified performance campaign. To create or edit this type of campaign, use the [add](https://yandex.com/dev/direct/doc/campaigns/add.html) and [update](https://yandex.com/dev/direct/doc/campaigns/update.html) methods with the campaign parameters defined in the `UnifiedCampaign` structure. Parameters are described in [add: UnifiedCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/add-unified-campaign.html) and [update: UnifiedCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/update-unified-campaign.html). 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](https://yandex.com/dev/direct/doc/campaigns/get.html) method. For the descriptions of parameters returned for this type of campaign, see [get: UnifiedCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/get-unified-campaign.html). - SMART_CAMPAIGN: Campaign of the "Smart banners" type. For more information about smart banners, see [Smart banners](https://yandex.com/support/direct/en/smart-banners/about.html) in Yandex Direct Help. To create or edit this type of campaign, use the [add](https://yandex.com/dev/direct/doc/campaigns/add.html) or [update](https://yandex.com/dev/direct/doc/campaigns/update.html) method with the campaign parameters defined in the `SmartCampaign` structure. Parameters are described in [add: SmartCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/add-smart-campaign.html) and [update: SmartCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/update-smart-campaign.html). 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](https://yandex.com/dev/direct/doc/campaigns/get.html) method. For descriptions of the parameters returned for this type of campaign, see [get: SmartCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/get-smart-campaign.html). - DYNAMIC_TEXT_CAMPAIGN: Campaign of the "Dynamic ads" type. For more information about dynamic ads, see [Dynamic ads](https://yandex.com/support/direct/en/dynamic-text-ads/about-da.html) in Yandex Direct Help. To create or edit this type of campaign, use the [add](https://yandex.com/dev/direct/doc/campaigns/add.html) or [update](https://yandex.com/dev/direct/doc/campaigns/update.html) method with the campaign parameters defined in the `DynamicTextCampaign` structure. Parameters are described in the sections [add: DynamicTextCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/add-dynamic-text-campaign.html) and [update: DynamicTextCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/update-dynamic-text-campaign.html). 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](https://yandex.com/dev/direct/doc/campaigns/get.html) method. For descriptions of the parameters returned for this type of campaign, see the section [get: DynamicTextCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/get-dynamic-text-campaign.html). - MOBILE_APP_CAMPAIGN: Campaign of the "Ads for Mobile Apps" type. For more information about promoting mobile apps, see [App promotion](https://yandex.com/support/direct/en/ru/products-mobile-apps-ads/about) in Yandex Direct Help. To create or edit this type of campaign, use the [add](https://yandex.com/dev/direct/doc/campaigns/add.html) or [update](https://yandex.com/dev/direct/doc/campaigns/update.html) method with the campaign parameters defined in the `MobileAppCampaign` structure. Parameters are described in the sections [add: MobileAppCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/add-mobile-app-campaign.html) and [update: MobileAppCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/update-mobile-app-campaign.html). 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](https://yandex.com/dev/direct/doc/campaigns/get.html) method. For descriptions of the parameters returned for this type of campaign, see the section [get: MobileAppCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/get-mobile-app-campaign.html). - MCBANNER_CAMPAIGN: Campaign of the "Search banner" type. For more information about banners in search results, see [Search banners](https://yandex.com/support/direct/en/products-media-context-banner/about.html) 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](https://yandex.com/support/direct/en/products-cpm-campaign/about.html) in Yandex Direct Help. To create or edit this type of campaign, use the [add](https://yandex.com/dev/direct/doc/campaigns/add.html) or [update](https://yandex.com/dev/direct/doc/campaigns/update.html) method with the campaign parameters defined in the `CpmBannerCampaign` structure. Parameters are described in the sections [add: CpmBannerCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/add-cpm-banner-campaign.html), [update: CpmBannerCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/update-cpm-banner-campaign.html). 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](https://yandex.com/dev/direct/doc/campaigns/get.html) method. For descriptions of the parameters returned for this type of campaign, see the section [get: CpmBannerCampaign parameters](https://yandex.com/dev/direct/doc/campaigns/get-cpm-banner-campaign.html). - CPM_DEALS_CAMPAIGN: Campaign of the "Display campaign with deals" type. For more information about deals, see [Deals](https://yandex.com/support/direct/en/products-cpm-campaign/deals.html) 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](https://yandex.com/support/direct/en/products-cpm-campaign-frontpage/about.html) 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](https://yandex.com/support/direct/en/fixed-cpm-campaigns/products-fixed-cpm.html) in Yandex Direct Help. This type of campaign only allows getting statistics via the Yandex Direct API. ## Display strategies {#strategy} See the section [Display strategies](https://yandex.ru/dev/direct/doc/en/objects/campaign-strategies.md). ## Monetary parameters {#currency-limits} {% note alert %} All monetary campaign parameters (daily budget, weekly budget, and average price for automatic strategies) are passed via the Yandex Direct API as integer numbers. The passed value is a monetary value in the user's currency, multiplied by 1,000,000. {% endnote %} Limits on monetary parameters are listed for each currency in the currency reference. To get the list of currencies, use the [Dictionaries](https://yandex.com/dev/direct/doc/dictionaries/dictionaries.html).[get](https://yandex.com/dev/direct/doc/dictionaries/get.html) method. ## Campaign status and state {#status} The `State` parameter reflects the current state of displays in the campaign. #| || **State** | **Description** || || CONVERTED | The campaign was run in Yandex units before the user switched to currency. It's currently in a special archive and available with read-only access. {% note info %} The [get](https://yandex.com/dev/direct/doc/campaigns/get.html) 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. {% endnote %} || || ARCHIVED | The campaign has been archived using the [archive](https://yandex.com/dev/direct/doc/campaigns/archive.html) 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](https://yandex.com/dev/direct/doc/campaigns/suspend.html) 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](https://yandex.ru/support/direct-tooltips/pay-before-moderated.html) is available). || || ALLOWED | The campaign was accepted after review, or the shared account is enabled. || |# [*Restrictions]: **For a user** Limits on the number of objects for a user. **For an agency** —