campaign

name*

Name of the new campaign (flight). An entry can contain Russian and Latin letters, numbers, and any special characters

advertiserID*

Advertiser ID.

If a campaign is added to a supercampaign, the advertiser is not specified and is inherited from the supercampaign.

Read also:

• Create an advertiser.
• Get a list of advertisers.

assistantID

ID of the assistant who will be granted access to the object based on their permissions.

If a campaign is added to a supercampaign, the assistant is not specified and is inherited from the supercampaign.

Read also:

• Create an assistant.

• Get a list of assistants.

superCampaignID

ID of the supercampaign (if the campaign is added to a supercampaign).

Read also:

• Create a supercampaign.
• Get a list of supercampaigns.

impressionsMethodID

Impression count method.

Acceptable values:

• 0: Banner ad response. An impression is counted when the banner code is uploaded to the site page.
• 101≤N≤130, where N is the ordinal number of the event from 1 to 30 (the value 101 corresponds to event 1, the value 105 corresponds to event 5, and so on). An impression is counted when the event with the specified number is called by the banner on the site page.
• 1101: Viewable impression, Yandex (IMS). To count as an impression, at least 50% of the banner must be visible in the active browser window for at least two seconds.
• 2101: Impression (IMS). An impression event that occurs when ad rendering begins.
• 2102: Viewable impression (IMS). Ad impressions are counted as viewable when they meet criteria established by international media industry standards, including a minimum percentage of pixels within the browser's viewable area and a minimum duration of visibility within that area.

kind_id

Defines the campaign type.

Acceptable values:

• 1: Guarantee type. It's used for campaigns with guaranteed sales where there are ad running obligations. Includes the dependence of two parameters:

  • The level parameter can only take values from 1 to 10. If the level parameter isn't passed, the default value 1 is used.
  • The cpm parameter isn't required. If it's passed, its value is ignored.

• 2: The Dynamic monetization type allows the publisher to receive the highest revenue from impressions, enabling the Yandex Advertising Network to compete for impressions of non-guaranteed ad campaigns. Campaigns are prioritized by CPM. Includes the dependence of two parameters:

  • The level parameter must be equal to 11. If the level parameter isn't passed, the default value 11 is used.
  • The cpm parameter is required and must be > 0.

  If the ad campaign was created with an external monetizer, you can't change “Campaign type”. Its value must be 2.

• 3: Promo type. It's used for custom promotion campaigns and placeholders. Includes the dependence of two parameters:

  • The level parameter can only take values from 12 to 20. If the level parameter isn't passed, the default value 12 is used.
  • The cpm parameter isn't required. If it's passed, its value is ignored.

Default value: 1.

level

Campaign level.

How many campaign levels are available depends on whether you have enabled the “Campaign types” module in your account.

If the “Campaign types” module is disabled, you can use the following values:

• From 1 to 10 (inclusive).

Default value: 1.

When the “Campaign types” module is enabled, you can use the following values:

• From 1 to 10 (inclusive): For Guarantee campaigns (kind_id=1).

• 11: For Dynamic monetization campaigns (kind_id=2).

• From 12 to 20: For Promo campaigns (kind_id=3).

Pay attention to the dependence of the kind_id and cpm parameter values.

cpm

CPM threshold value for an ad campaign of the Dynamic monetization type.

For kind_id=2, this parameter is required.

For kind_id=1|3, this parameter is optional. If it's passed, its value is ignored.

Acceptable values: integers from 1 to 99999.

If CPM is passed, don't pass CPC.

cpc

CPC threshold value for an ad campaign of the Dynamic monetization type.

For kind_id=2, this parameter is required.

For kind_id=1\|3, this parameter is optional. If it's passed, its value is ignored.

Acceptable values: an integer greater than 0.

If CPC is passed, don't pass CPM.

priority

Priority.

1≤N≤1000, where N is a number from 1 to 1000 (inclusive).

Default value: 100.

status

Object status. Only objects with the active status can be displayed.

Acceptable values:

• 0: Active. The object is ready for delivery.

• 1: Paused. The object is assumed to be temporarily disabled. By default, filters in the Adfox web interface show paused objects in the list.

• 2: Completed. The object is assumed to be delivered in full. By default, filters in the Adfox web interface hide completed objects.

Default value: 0.

sectorID

Industry.

For more information on how to get the list of industries, see utility-sector.

rotationMethodID

Campaign rotation method.

Acceptable values:

• 0: By priority. Use the values of the level and priority parameters to determine the probability of your ad campaign being served.
• 1: By percentage of traffic. Use the value of the trafficPercents parameter to determine the probability of your ad campaign being served. The trafficPercents parameter is required.

Default value: 0.

trafficPercents

Traffic percentage.

Required if the traffic percentage rotation method is used (rotationMethodID=1).

Acceptable values: from 1 to 100.

commonProfileID

General profile ID.

A general profile combines a targeting profile and a placement profile. When specifying a general profile, you don't need to pass targetingProfileID and bundleID.

targetingProfileID

Targeting profile ID.

You can use a targeting profile to combine the settings of several targeting types. When creating a campaign or banner, you can specify a targeting profile. This way, you don't waste time setting up every targeting type separately.

For more information on how to get the list of profile IDs, see list-targetingProfile.

bundleID

Placement profile ID.

You can use a placement profile to combine commonly used placements for campaigns. You can specify a placement profile right away when creating a new campaign. This way, the campaign will appear on the placements specified in the profile.

isSession

Session impressions.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

impressionsSmoothTypeID

Deliver impressions.

Acceptable values:

• 0: As fast as possible. Campaign banners are served at the maximum possible speed until the impression limits are reached (if specified). The maximum delivery speed doesn't require you to set limits or specify the campaign start and end dates.

• 1: Spread evenly throughout the day. Impressions are uniformly distributed throughout the day. Make sure to specify the maximum number of impressions per day (maxImpressionsPerDay).

• 2: Spread evenly throughout the entire period. The campaign impressions are distributed evenly over the entire period based on account statistics. Make sure to specify the maximum number of impressions (maxImpressions) and the ad campaign end date (dateEnd).

• 3: Spread evenly throughout the entire period (automatic prolongation). The campaign impressions are distributed evenly over the entire period based on account statistics. If the campaign doesn't reach the impression limit in the allocated time, it's automatically extended for one day and runs at the maximum speed on that day. Make sure to specify the maximum number of impressions (maxImpressions) and the ad campaign end date (dateEnd).

Default value: 0.

maxImpressions

Maximum number of banner impressions.

Acceptable values: Integers from 1 to 2147483647.

maxImpressionsPerDay

Maximum number of impressions per day.

Acceptable values: Integers from 1 to 2147483647.

maxImpressionsPerHour

Maximum number of impressions per hour.

Acceptable values: Integers from 1 to 2147483647.

maxClicks

Maximum total number of click-throughs.

Acceptable values: Integers from 1 to 2147483647.

maxClicksPerDay

Maximum number of clicks per day.

Acceptable values: Integers from 1 to 2147483647.

maxClicksPerHour

Maximum number of clicks per hour.

Acceptable values: Integers from 1 to 2147483647.

dateStart

Ad running start date.

Default value: today from 00:00.

Date and time format: YYYY-MM-DD HH:mm

dateEnd

Delivery end date.

Date and time transmission format: YYYY-MM-DD HH:mm

logicType

Campaign type. Not required for a campaign inside a supercampaign.

Acceptable values:

• 0: Commercial.
• 1: Measuring campaign.

Default value: 0.

sendToErir

Submit data to the state register (ERIR).

Acceptable values:

• 0: Do not submit data to the state register.
• 1: Submit data to state register (labeling enabled).

Default value: 0.

contractID

ID of a direct or primary contract.

Required if sendToErir=1. Find out how to get the list of contracts.

publisherContractID

ID of the contract with the end advertiser.

Required if contractID points to a primary contract.

costType

Campaign type.

Acceptable values:

• 0: Other.
• 1: CPM.
• 2: CPC.
• 3: CPA.

Default value: 0.

markingAdvertiserInfo

Advertiser information as shown in the banner menu. Displayed when the Show banner menu option is enabled for the banner. The default value is an empty string.

code

Request processing status. A value of 0 means the request was completed successfully. For the key, see Error handling.

ID

The ID of the created object.