bindBlock

ID of the placement a Yandex Advertising Network ad unit should be linked to.

Description of actions performed by the intermediary representative.

Acceptable values:

• 0: Other.
• 1: Actions related to ad distribution.
• 2: Conclusion of contracts.
• 3: Commercial representation.

Default value: 0. To set the status to “Not specified”, pass either null or an empty value ''. When editing, you can set the status to “Not specified” by using actionType=&.

Enable or disable placement.

Acceptable values:

• 0: disabled.
• 1: enabled.

User account.

The account name must be unique within the system.

An entry can contain Russian and Latin letters, numbers, and any special characters

To get data for only one object, specify its ID.

Default value: 0 — display the entire list.

Filter by the site ID.

Advertiser's account.

Enable targeting by age.

Acceptable values:

• 0: disabled.
• 1: enabled.

Select the age value.

The parameter is required if age=1.

Acceptable values:

• 1: Under 18.
• 2: From 18 to 24.
• 3: From 25 to 34.
• 4: From 35 to 44.
• 5: Over 45 (the value is deprecated, it includes values 6 and 7 automatically).
• 6: From 45 to 54.
• 7: Over 55.

To pass multiple values, use a vertical bar | as a separator without spaces.

Intermediary function, attribute of the monetary flow direction towards the principal. Required if the contract type type = 1. Otherwise, must be omitted.

Acceptable values:

• 0: The agent acts in the interests of the advertiser under this agent agreement (is an advertiser's representative).
• 1: The agent acts on behalf of the publisher under this agency agreement (serves as the ad platform representative).

Show the “Ad” or “Social ad” label on banners.

Acceptable values:

• 0: Disable the label.
• 1: Show the “Ad” label.
• 2: Show the “Social ad” label.

IDs of additional advertisers.

Accounts of additional advertisers.

IDs of additional assistants.

Accounts of additional assistants.

Address.

Address (continued).

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

The ID of the advertiser that the action point must be added to.

The alt parameter of the img tag provides alternative text for the image.

Contract price. Passed only if amountType = 0 (paid).

Contract price. Acceptable values:

• 0: Paid (if this value is selected, amountRub becomes mandatory).
• 1: Unpaid.
• 2: There is no price in the contract.

ID of the assistant who will be allowed access to the object according to 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

b

Background color in HEX format, for example: #FFFFFF.

Banner type name.

Banner ID.

Read also:

• Get a list of banners

Banner type ID.

Read also:

• Create a banner type
• View the list of banner type IDs

Use targeting by behavior for users labeled via:

• 0 — permanent category, if audience labeling is based on categories assigned to sites, sections, and placements.
• 1 — temporary category, if audience labeling is based on action points.

The logical expression is represented as an n-ary tree mapped to a non-recursive JSON structure using ID references instead of full child node definitions.

{"version": 1,"nodes": [{"id": 1,"type": 2, "value": 
{ "subnodes": [2, 5, 6] }}, {"id": 2,"type": 1, "value": 
{ "subnodes": [3, 4] }}, {"id": 3,"type": 3, "value": 
{ "key": 1, "values": [6, 7, 8] }}, {"id": 4,"type": 3, 
"value": { "key": 1, "values": [4, 5] }}, {"id": 5,"type": 
3, "value": { "key": 2, "values": [1] }}, {"id": 6,"type": 
3,"invert": true, "value": { "key": 2, "values": [2] }}]}
{"version": 1,"nodes": [{"id": 1,"type": 2, "value": 
{ "subnodes": [2, 5, 6] }}, {"id": 2,"type": 1, "value": 
{ "subnodes": [3, 4] }}, {"id": 3,"type": 3, "value": 
{ "key": 1, "values": [6, 7, 8] }}, {"id": 4,"type": 3, 
"value": { "key": 1, "values": [4, 5] }}, {"id": 5,"type": 
3, "value": { "key": 2, "values": [1] }}, {"id": 6,"type": 
3,"invert": true, "value": { "key": 2, "values": [2] }}]}

The structure is designed with versioning in mind. The format shown in the example applies to version 1. Future updates and extensions are planned for later versions.

Every node of the first version has four fields:

• id: The node ID within the tree.

  Numbering always starts with 1. The node with ID=1 is always the root.

• invert: Inversion flag.

  Use this flag to set NOT logic. It applies to the result of the entire node calculation. If child nodes are present, all child nodes are calculated first.

• type: The ID of the node content type:

  • 1: The AND grouping node.
  • 2: The OR grouping node.
  • 3: User field validation node (PUID).

  AND and OR nodes function essentially as parentheses, grouping all child nodes under the respective logical operation.

• value: A JSON representation of the node content as a key and its values.

  • key: The ID of the user characteristic.
  • values: An array of value IDs for the user characteristic.
  Example

  Characteristic with the following values: a (valueID=10), b (valueID=20), c (valueID=30).

  {"key": 1, "values": [10,20,30]}

  Read also:

  • Get a list of values of user targeting characteristics

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.

c

Category name.

Specify which category the user must be labeled with, where N in the parameter name is the condition number from 1 to 9.

Allowed values: Category ID.

Default value: 0 — not set if targeting is for unlabeled users.

Read also:

• Get a list of categories

Category ID.

Read also:

• Add a category
• Get a list of categories

ID of the category to which the audience that interacts with the action point will be labeled into.

Acceptable values:

• 0: Category not specified.
• N: Category ID.

Default value: 0.

Campaign name.

Company name.

Campaign start date.

Campaign end date.

The ID of the campaign or flight where the banner will be added.

Read also:

• View the list of campaign or flight IDs
• Create a campaign or flight

ID of the campaign the banner belongs to.

Attribute “Fee under this contract is paid by the intermediary, attorney, commission agent, or agent”. The field can be passed only in the intermediary contract type = 1 and if the attribute of the monetary flow direction towards the principal is agentActingForPublisher = 0.

Acceptable values:

• 0: disabled.
• 1: Enabled (fee under this contract is paid by the intermediary, attorney, commission agent, or agent).

City.

Total number of banner clicks.

Number of clicks today.

Data from counters. Number of clicks today.

The frequency of the user's exposure to the ad campaign. Number of clicks per period.

Acceptable values: Integers from 1 to 2147483647.

System templates.

This parameter is required if the banner template (templateID) is not set.

Allowed value: XML — XML banner (for XML types).

Type of ad distribution.

Acceptable values:

• 1: Banner.
• 2: Text & Image ad unit.
• 3: Text ad unit.
• 4: Video.
• 5: Live video.
• 6: Live audio.
• 7: Audio.
• 8: Text ad unit with video.
• 9: Text & Image ad unit with video.
• 10: Text ad unit with audio.
• 11: Text & Image ad unit with audio.
• 12: Text & Image ad unit with audio and video.
• 13: Text ad unit with audio and video.
• 14: HTML5 banner.

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

Campaign type.

Acceptable values:

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

ID of a direct or primary contract.

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

ID of the general profile.

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.

Country of registration code (OKSM).

Comments.

Counterparty ID. Ad labeling parameter.

Contract role. Acceptable values:

• 0: Primary.
• 1: Final.
• 2: Direct.

Country.

PostView counter data over the entire time.

PostView counter data for today.

PostClick counter data over the entire period.

PostClick counter data for today.

User characteristic ID.

Allowed values: 1≤N≤63, where N is the characteristic index from 1 to 63 inclusive.

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

For kind_id=2, the parameter is required.

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

Allowed values: integers from 1 to 99999.

If CPM is passed, don't pass CPC.

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

For kind_id=2, the parameter is required.

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

Allowed values: an integer greater than 0.

If CPC is passed, don't pass CPM.

Customer ID. To learn how to get a list of counterparty IDs, see contractor.

d

Ad running start date.

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

Default value: today from 00:00.

Delivery end date.

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

Add date.

Delivery completion date.

The frequency of the user's exposure to the ad campaign. Start date of the period when the set limit of impressions or click-throughs is in effect.

Date format: YYYY-MM-DD.

Enable targeting by day of the month, where N is the day number (for example: 1 for the first day of the month, 2 for the second day of the month, and so on).

Acceptable values:

• 0: disabled.
• 1: enabled.

Domain next to the “Ad” label.

Date of the contract or additional agreement. Format: YYYY-MM-DD. The date can't be in the future.

Backup ad image URL.

Only for mode=0 and the Standard and Nondimensional banner types.

If defaultImageURL is specified, the defaultHitURL parameter becomes required.

This is the destination URL for the backup banner.

Only for mode=0 and the Standard and Nondimensional banner types.

The targeting value.

Image width in pixels.

Only for mode=0 and the Nondimensional banner type.

Image height in pixels.

Only for mode=0 and the Nondimensional banner type.

Backup ad.

Only for mode=1 and the Nondimensional banner type.

Type of code for the backup ad.

Acceptable values:

• 0: HTML.
• 1: JavaScript.

Only for mode=1.

Ad tag type.

Acceptable values:

• 0: HTML.
• 1: JavaScript.

Default value: 0.

e

Email address that the user's access is registered to.

The email address registered for user access.

Electronic payment instrument number.

Event names, where N is the event number from 1 to 30.

Every template contains a set of defined events. Get a list of template variables used and pass event names when you add or edit the banner.

Contractor ID. To learn how to get a list of counterparty IDs, see contractor.

f

Fax.

The frequency of the user's exposure to the ad campaign. Impression frequency period.

Acceptable values:

• 0: Not set.
• 1 1 hour.
• 2: 4 hours.
• 3: 6 hours.
• 4: 12 hours.
• 5: 24 hours.
• 6: A week.
• 7: A month.
• 8: Other period.
• 9: 14 days.

Default value: 0.

The frequency of the user's exposure to the ad campaign. The click frequency period.

Acceptable values:

• 0: Not set.
• 1 1 hour.
• 2: 4 hours.
• 3: 6 hours.
• 4: 12 hours.
• 5: 24 hours.
• 6: A week.
• 7: A month.
• 8: Other period.
• 9: 14 days.

Default value: 0.

This is the name of the parameter used to pass the destination URL into the Flash video.

When creating a Flash video, the code handling the click action must include a parameter that accepts the destination URL.

You need to specify both the destination URL and this parameter name when uploading the banner to Adfox. The parameter name in the banner must match the one in the Flash video.

User's first name.

g

Link to a flash video for flash banners.

Enable targeting by gender.

Acceptable values:

• 0: disabled.
• 1: enabled.

Select the gender value.

The parameter is required if gender=1.

Acceptable values:

• 1: Male.
• 2: Female.

Enable targeting by geography.

Acceptable values:

• 0: disabled.
• 1: enabled.

Setting up the Whole world option, which you can use to specify the targeting logic:

• Everything allowed except: If there are fewer objects to exclude, enable the Whole world option and exclude certain objects from the list.

• Nothing allowed except: If you want to enable impressions only for certain objects, disable the Whole world option and include the necessary objects in the list.

Acceptable values:

• 0: Reset. Inherited from the parent element.
• 1: Allowed.
• 2: Forbidden.

h

Banner height.

Link to the advertiser's website.

Specify the click-through URL for events, where N in the parameter name is the event number from 1 to 30.

Enable targeting by day of the week or by hour, where:

• N: An hour from 0 to 23. For example: 0 — from 00:00 to 00:59, 1 — from 01:00 to 01:59.
• M: Day of the week from 1 to 7. For example: 1 — Monday, 2 — Tuesday, 3 — Wednesday, and so on).

Acceptable values:

• 0: disabled.
• 1: enabled.

i

Total number of banner impressions.

Data from counters. Number of impressions today.

The frequency of the user's exposure to the ad campaign. Number of impressions per period.

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

The method of counting impressions.

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.

Enable logical targeting.

Acceptable values:

• 0: Disabled. The blocks parameter is optional.
• 1: Enabled. The blocks parameter is required.

Acceptable values:

• 0: The template doesn't contain "ims" events. You can use it to create banners in campaigns with impression count methods other than IMS.
• 1: The template supports IMS events. You can use it to create banners for campaigns with IMS impression counting methods.

Specifies if the counterparty is an ad distributor.

Acceptable values:

• 0: Not an ad distributor.
• 1: Ad distributor.

Redefine targeting.

Acceptable values:

• 0: Inherit targeting settings from a higher level. Level hierarchy from top to bottom:

  • Campaign.
  • Campaign on the site.
  • Campaign in the site section.
  • Campaign on the placement.
  • Banner.

• 1: Cancel targeting settings from higher levels and use the parameters set at the current level.

Specifies if the counterparty is an advertising system operator.

Acceptable values:

• 0: Not an advertising system operator.
• 1: Advertising system operator.

Get links to events.

Acceptable values:

• 0: disabled.
• 1: enabled.

Setting for configuring access rights. Create own campaigns.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

Setting for configuring access rights. Create own advertisers.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

Dynamic definition of a site section by referer.

Each banner request contains information about the page address (referer) that the request comes from.

If you enable this option, you can use the ad tag from the site level. The system will automatically match the ad request to a site section based on its referer header. If you disable this option, you must use ad tags from the placement level.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 1.

Setting for configuring access rights. Manage all campaigns.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

Setting for configuring access rights. Manage ad campaigns assigned to the assistant.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

Is enabled automatically if:

• isCreateOwnCampaigns=1: allowed to create own campaigns.
• isModifyAllCampaigns=1: allowed to manage all campaigns.

Enable/disable the object.

Acceptable values:

• 0: disabled.
• 1: enabled.

Parent contract ID. Passed only if type = 2.

Setting for configuring access rights. View all campaigns.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

Enabled automatically if isModifyAllCampaigns=1 (allowed to manage all campaigns).

Setting for configuring access rights. View campaigns assigned to the assistant.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

Is enabled automatically if:

• isModifyAllCampaigns=1: allowed to manage all campaigns.
• isCreateOwnCampaigns=1: allowed to create own campaigns.
• isModifyOwnCampaigns=1 (allowed to manage campaigns assigned to the assistant).

Setting for configuring access rights. Manage all sites.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

Setting for configuring access rights. Access general reports.

Acceptable values:

• 0: disabled.
• 1: enabled.

Default value: 0.

Object ID.

User ID.

Counterparty's INN (TIN).

Link to the banner image or a flash banner placeholder.

Disable banner placement on placements created after adding the banner.

Acceptable values:

• 0: disabled.
• 1: enabled.

This option depends on whether you have enabled the “Disable banner placement” module.

If the module is connected, the default value is 1.

Depending on the banner type, this can be HTML code, XML code, or JavaScript.

Session impressions.

Acceptable values:

• 0: disabled.
• 1: enabled.

j

k

Use this to define the campaign type.

Acceptable values:

• 1: Guarantee campaign, which is a campaign with guaranteed sales where the publisher commits to serve a certain number of impressions. 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.
  • cpm is required and must be greater than 0.

  If the ad campaign was created with an external monetizer, you can't change the 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.

Specify keywords or phrase for targeting the object.

You can't target by both phrases and specific keywords at the same time.

Recording format:

• Use a comma to separate phrases.
• Use a space or comma to separate keywords.

An entry can contain Russian and Latin letters, numbers, and any special characters

Targeting method.

Acceptable values:

• 0: By keywords.
• 1: By phrases.

Default value: 0.

A keyword or words that can't be used in the banner request for serving the banner.

Recording format:

• Use a comma to separate phrases.
• Use a space or comma to separate keywords.

An entry can contain Russian and Latin letters, numbers, and any special characters

l

Display the result for specified campaigns only. A comma-separated list of campaign IDs.

Read also:

• Get a list of campaigns/flights

User's last name.

Campaign level.

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

Allowed values if the Campaign types module is disabled: from 1 to 10 inclusive.

Default value: 1.

Acceptable values if the Campaign types module is enabled:

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

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

Acceptable values:

• 0: Commercial.
• 1: Measuring.

m

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.

Creative description.

Code from the KKTU reference list. Required if labeling is enabled.

If markingKktu is set to 30.15.1, markingCommonDescription is required.

To get the list of codes, use the bannerKktu method.

General description of the advertised item.

Required if 30.15.1 is specified in the markingKktu parameter.

Display region.

Acceptable values:

• none: The Don't send value. Data on display regions won't be submitted to ERIR.
• all: The All of Russia value. The banner is served across Russia.
• selected: Specify regions manually value. If you choose selected, be sure to provide the IDs of the selected regions in the markingSelectedRegions parameter.

ID of the ad impression region.

Required if selected is specified in the markingSendRegionsType parameter.

To set multiple regions, include several markingSendRegionsType's in the request parameters.

&markingSendRegionsType=9&markingSendRegionsType=21&markingSendRegionsType=63

To get a list of regions, use the erirRegions method.

Array of creative's media data. This field is required if the textData and sendToErir<ParameterN> parameters were omitted.

The URL is checked for accessibility before saving. The description field is optional.

mediaData[]={"url": "https://avatars.mds.yandex.net/get-adfox-content/2462621/221121_adfox_2033661_5594482.379ba05374bcd6b6339273f47b5a1b64.jpeg/optimize.webp", "description": "Text_string"}

Array actions:

• Add an item: Pass all existing items along with the new items.
• Delete an item: Pass all items except the one being deleted.
• Clear the array: Pass the array with an empty value, for example, mediaData[]=.

The frequency of the user's exposure to the ad campaign. Maximum number of impressions per user.

Acceptable values: Integers from 1 to 2147483647.

Maximum number of banner impressions.

Acceptable values: Integers from 1 to 2147483647.

Maximum number of impressions per day.

Acceptable values: Integers from 1 to 2147483647.

Maximum number of impressions per hour.

Acceptable values: Integers from 1 to 2147483647.

Maximum total number of click-throughs.

Acceptable values: Integers from 1 to 2147483647.

The frequency of the user's exposure to the ad campaign. The maximum number of click-throughs per user after which ad display is limited.

Acceptable values: Integers from 1 to 2147483647.

Maximum number of clicks per day.

Acceptable values: Integers from 1 to 2147483647.

Maximum number of clicks per hour.

Acceptable values: Integers from 1 to 2147483647.

Minimum allowed CTR value as a percentage. Allowed values: from 0 to 100.

Default value: 0.

The frequency of the user's exposure to the ad campaign. Minimum period between click-throughs (hours:minutes:seconds)

Time format with seconds: HH:mm:ss.

The frequency of the user's exposure to the ad campaign. Minimum period between banner impressions for a unique user (hours:minutes:seconds).

Time format with seconds: HH:mm:ss.

Targeting options: by day of the week or by day of the month.

Acceptable values:

• 0: By day of the week.
• 1: By day of the month.

Default value: 0.

The mode for using the default banner.

Acceptable values:

• 0: File (only for standard and nondimensional banner types).
• 1: Code.

Default value: 0.

Counterparty's phone number. Enter the phone number in the format +[countrycode]{phonenumber}. The phone number can only contain digits, with a length of 1 to 50 digits, and must not include spaces, hyphens, or other characters.

n

Object name.

An entry can contain Russian and Latin letters, numbers, and any special characters

Name of the new campaign (flight).

An entry can contain Russian and Latin letters, numbers, and any special characters

Counterparty name. Use only Russian letters, spaces, and hyphens (no more than one consecutive space or hyphen between words). Hyphens cannot be used at the beginning or end of the string.

Ad unit name.

ID of the Yandex Advertising Network platform where you want to create an ad unit.

Ad unit type. Depending on the type of ad inventory you're using to create an ad unit, specify:

• For ads placed on sites:

  • BANNER
  • FULLSCREEN_DESKTOP
  • FULLSCREEN_MOBILE
  • FLOORAD_DESKTOP
  • FLOORAD_MOBILE
  • TOPAD

• For mobile apps:

  • BANNER
  • INTERSTITIAL
  • NATIVE
  • REWARDED
  • APP_OPEN
  • FEED

• For video platforms:

  • PRE
  • MID
  • POST
  • PAUSE
  • INROLL
  • POSTPAUSE

Number of the contract or additional agreement. There should be no spaces or line break characters at the beginning and end of the line.

Get a specific number of ad tags for unrepeatable placements.

Allowed values: from 1 to 20.

Default value: 1.

o

ID of the object the action applies to.

ID of the campaign to add a user to.

ID of the campaign to remove a user from.

ID of the placement a Yandex Advertising Network ad unit should be linked to.

ID of the placement a Yandex Advertising Network ad unit should be created on and linked to.

ID of the placement where a Yandex Advertising Network ad unit should be removed and archived.

ID of the placement where the ad unit status should be changed.

ID of the supercampaign to add a user to.

ID of the supercampaign to remove a user from.

Characteristic value ID.

Read also:

• Get the list of values

Campaign ID.

Read also:

• Get a list of campaigns

Banner impression optimization that automatically redistributes impressions among banners within a single campaign based on their actual effectiveness.

Acceptable values:

• none: Don't use optimization.
• ctr: Optimize impressions based on CTR. For more information, see Add a campaign in Adfox Help.

Default value: none.

Account ID.

p

Request parameter separator. Not used in ad tags with a loader.

Acceptable values:

• 0: &amp.
• 1: &.

Default value: 0.

Placement ID.

Read also:

• Get a list of placements

Only for XML banners.

Specify the HTML code that shows the XML banner in the preview window.

Priority.

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

Phone number.

Placement name. Ad labeling parameter. Required if sendToErir=1.

Placement name.

Placement type. Ad labeling parameter. Required if sendToErir=1.

Acceptable values:

• 0: App.
• 1: Site.
• 2: Information system (no longer used, deprecated).
• 3: Smart TV.
• 4: HbbTV.

If platformType=0 or platfromType=1, the url field is required.

Placement position ID.

Read also:

• Create a position
• View the list of positions

Name of the load type for the banner type.

Load type ID determines how the banner code loads onto the site.

Acceptable values:

• 0: Standard. The banner code will be uploaded as HTML code in an iframe with the specified dimensions.
• 4: nondimensional. The banner code will be uploaded as JavaScript code.
• 5: XML. The banner code will be uploaded as XML code.

ID of the final contract.

Required if contractID points to a primary contract.

Impression frequency limit at the placement level. Other period (minutes): You can set your own time period for the impression restriction in minutes.

Allowed values: an integer greater than 1.

Default value: 1.

Required if plp=5 (Impression frequency period = other).

If plp=-1 or plp=0 (the Impression frequency period parameter is passed with the From request URL or No limits value), the pop parameter must be omitted from the request or passed with an empty value.

Impression frequency limit at the placement level. How many banner impressions are made on this placement for a unique user.

Allowed values: an integer greater than 1.

If plp=-1 or plp=0 (the Impression frequency period parameter is passed with the from request URL or no limits value), the pli parameter must be omitted from the request or passed with an empty value.

Impression frequency limit at the placement level. Impression frequency period.

Acceptable values:

• -1: From the request URL (by default). Frequency capping settings will be taken from the parameters of the banner request URL. If the values aren't passed in the request, the placement is considered to have no limits. The pli (Number of impressions per period) and pop (Other period) parameters must be empty or omitted from the request.
• 0: No limits. Banner impressions on this placement aren't limited even if the request parameters specify otherwise. The pli (Number of impressions per period) and pop (Other period) parameters must be empty or omitted from the request.
• 1: 1 hour. The limit is valid for 1 hour after the banner is first served to a unique user.
• 2: 6 hours. The limit applies for 6 hours after the banner is first served to a unique user.
• 3: 12 hours. The limit applies for 12 hours after the banner is first served to a unique user.
• 4: 24 hours. The limit applies for 24 hours after the banner is first served to a unique user.
• 5: Other. Specify a custom period for frequency capping in minutes. The pop (Other period) parameter is required.

Use this setting to allow serving particular ad campaign types on this placement.

Acceptable values:

• 0: From the request URL (by default). The code type is defined by the parameter value passed in the banner request URL. If this parameter is omitted from the request, the placement is treated as having a standard code type by default.
• 1: Standard. Banners from all ad campaigns are allowed to serve, except for session-on-page campaigns.
• 2: Unrepeatable. You can install multiple ad tags for a specific placement on the page, which will then request and serve various banners, excluding session-on-page campaigns.
• 3: Session on page. The page serves banners from session-on-page campaigns (which take priority over standard campaigns). If no session-on-page campaigns are available, the system selects a standard ad campaign.
• 4: Unrepeatable campaigns. You can install multiple ad tags for this placement on the page, and each one requests a single banner from the same ad campaign, excluding session-on-page campaigns.

q

r

Required parameter.

Specify the targeting status for regions.

Entry format: {"225":2,"3":0}, where {"Region ID":value,"Region ID":value}.

Acceptable values:

• 0: Reset. Inherited from the parent element.
• 1: Allowed.
• 2: Forbidden.

For example, regions={"225":1} allows impressions in Russia.

You can also configure the Whole world option using the regions parameter with ID=10000. This setting takes priority over the value that's passed in the global parameter.

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 estimate the probability of the ad campaign being served.

  The trafficPercents parameter is required.

Default value: 0.

Campaign rotation method.

Acceptable values:

• −1: Not redefined (the value is inherited from the level above).
• 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 estimate the probability of the ad campaign being served.

Default value: -1.

List item with its corresponding number.

Enable targeting by income (revenue).

Acceptable values:

• 0: disabled.
• 1: enabled.

Select the income value.

The parameter is required if revenue=1.

Acceptable values:

• 1: Below average.
• 2: Average.
• 3: Above average.

To pass multiple values, use a vertical bar | as a separator without spaces.

Number of items in the response tree.

Item number in the response tree, where N is a number from 0 to rows-1 (where rows is the total number of items in the response).

Registration number.

The roles the counterparty can assume when entering into a contract.

Acceptable values:

• 0: Contractor.
• 1: Customer.

Default value: roles[]=0&roles[]=1 — the “Customer and contractor” role.

Ad network URL or other information.

URL template to compare against the page address retrieved from the request. If the address doesn't match the URL template, the action point loading isn't counted.

An entry can contain Russian and Latin letters, numbers, and any special characters

s

Region.

Show the banner menu.

Acceptable values:

• 0: Don't show the menu.
• 1: Show the menu.

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

Submit data to the state register (ERIR).

Acceptable values:

• 0: Do not submit data to the state register. All other ad labeling fields are ignored.
• 1: Submit data to state register (labeling enabled). In this case, the platformName and platformType fields are required.

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

Read also:

• Create a supercampaign
• Get a list of supercampaigns

Filtering by substring in a campaign/flight name.

An entry can contain Russian and Latin letters, numbers, and any special characters

Enable or disable submitting the parameter (creative) value to ERIR for a specific variable, where <ParameterN> is the variable name.

If you're passing predefined variables, use the following parameter names:

• sendToErirImageURL for the Image variable.
• sendToErirGetFLV for the FLV video variable.

To enable custom variables (user1-user25), use <ParameterN>, where N is a value from 1 to 25. For example, use sendToErirParameter2 for the additional variable user2.

Acceptable values:

• 0: Disable data transfer to the state register for the variable.
• 1: Enable data transfer to the state register for the variable.

Default value: 0.

This field is required if the mediaData and textData parameters were omitted.

Type of file uploaded to the variable when data transfer to the state register is enabled.

Allowed values:

• image
• video
• audio
• zip

If you select image, the sendToErirDescription<ParameterN> parameter, which describes the creative's object, becomes required.

Description of the creative's object for the variable with the uploaded file. Required if image is specified in the sendToErirContentType<ParameterN> parameter.

Subject matter of the contract.

Acceptable values:

• 0: Other.
• 1: Ad distribution contract.
• 2: Contract to organize ad distribution.
• 3: Mediation.
• 4: Representation.

Default value: 0. To set the status to “Not specified”, pass either null or an empty value ''. When editing, you can set the status to “Not specified” by using subjectType=&.

Site section name.

Name of the site in management.

Site ID.

ID of the site where the placement is located.

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

Acceptable values:

• 0: Active. The object is ready for delivery.
• 1: Suspended. 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 have completed its delivery. By default, filters in the Adfox web interface hide completed objects.

Status.

Acceptable values:

• 0: Active.
• 1: Suspended.
• 2: Completed.

Site section ID.

Industry.

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

Configuring data completeness in the list of campaigns/flights.

Acceptable values:

• common (summarized display format):

  • ID
  • name

• short (limited display format):

  • ID
  • bannerTypeID
  • templateID
  • campaignID
  • status
  • dateStart
  • dateEnd

• advanced (full display format).

Default value: advanced.

Contract type. Acceptable values:

• 0: Commercial.
• 1: Social advertising contract with payment.
• 2: Social advertising contract by quota.

Tag type.

Acceptable values:

• 1: Asynchronous.
• 2: Asynchronous with scroll check.
• 3: Adaptive.

Default value: 1.

t

The URL of the page where ad serving is allowed.

If there are multiple URLs, every URL must be passed in a separate parameter. The maximum number of parameters with a URL is 5.

targetingUrlOn[]=url1&targetingUrlOn[]=url2...

URL of the page where ad serving is prohibited.

If there are multiple URLs, every URL must be passed in a separate parameter. The maximum number of parameters with a URL is 5.

targetingUrlOff[]=url1&targetingUrlOff[]=url2...

Specify the page templates to be used to check the received address in the banner request.

An entry can contain Russian and Latin letters, numbers, and any special characters

Banner template name.

Page templates that must not belong to this site section.

An entry can contain Russian and Latin letters, numbers, and any special characters

Banner template ID.

A template is a banner code with variables. It defines the appearance and functionality of the banner on the site.

Please note: If the ad campaign (campaignID) to which the banner is being added was created using an impression counting method (impressionsMethodID=2101 or 2102), then the template must have the is_Ims=1 attribute.

You can check if a template has this attribute by getting the template parameters (account-list-template) or the list of templates in the banner type (bannerType-list-template).

See list-template to find out how to get the list of template IDs.

Template type for targeting by URL.

Acceptable values:

• 0: Standard. In the URL template, use the * symbol for a sequence of any characters of any length.
• 1: POSIX. In the URL template, use regular expressions according to the POSIX standard.

Default value: 0.

Page template type. For more information about template types, see Referer templates.

Acceptable values:

• 0: Standard.
• 1: POSIX.2.

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.

To learn how to list profile IDs, see the list-targetingProfile section.

The link's target parameter determines the window where the link opens.

Acceptable values:

• _blank: Open the page in a new browser window.
• _parent: Open the page in the current window.
• _top: Open the page in a full browser window.

Category activity in days. Default value: not set.

Specify how many days ago the user must have been labeled last, where N in the parameter name is the condition number from 1 to 9.

Acceptable values: Integers from 1 to 2147483647.

The targeting name.

The name of the parameter used to pass the target value to the Flash video.

When a flash video is developed, the click processing code uses a parameter that expects the target value in the input.

You specify the click link and the parameter name for passing the target value to the video when adding the banner to Adfox. The parameter name in the banner must match the one in the Flash video.

Target URLs. You can enter multiple URLs in this field, separating them with a newline character \n (encoded in URLs as %0A). Each URL must begin with a protocol. Maximum URL length is 2000 characters.

Array of creative's text data. This field is required if the mediaData and sendToErir<ParameterN> parameters were omitted.

Array actions:

• Add an item: Pass all existing items along with the new items.
• Delete an item: Pass all items except the one being deleted.
• Clear the array: Pass an array with an empty value, for example, textData[]=.

Tracking pixel link.

A pixel link usually has a variable that waits for a random number to be input. This number protects the link from caching in the browser.

Adfox provides a macro for assigning a random numeric value to a variable: %random%.

The banner token obtained from a third-party advertising data operator, including Yandex Advertising Data Operator via API, instead of using Adfox's standard labeling method.

You can set the token parameter value only if sendToErir=0.

The Token field accepts only the token value. Don't add any other characters.

Traffic percentage.

Required when rotating by percentage of traffic (rotationMethodID=1).

Acceptable values: from 1 to 100.

Category type.

Acceptable values:

• 0: Permanent category. Used to label sites, sections, and placements.
• 1: Temporary category. Used to set up behavioral targeting.

Category type.

Acceptable values:

• 0: Permanent category.
• 1: Temporary category.

Contract type.

Acceptable values:

• 0: Service contract.

• 1: Intermediary contract. Available parameters:

  • agentActingForPublisher: Intermediary function.
  • chargePaidByAgent: “Fee under this contract is paid by the intermediary, attorney, commission agent, or agent” option.

• 2: Additional agreement. intermediaryContractID is a required field.

Counterparty type.

Acceptable values:

• 0: Legal entity (Russia). inn is a required field (10 digits).
• 1: Individual (Russia). inn is a required field (12 digits).
• 2: Individual entrepreneur (Russia). inn is a required field (12 digits).
• 3: Legal entity (Non-resident). Ensure to fill in the countryOKSM field and either the mobilePhone or epayNumber field.
• 4: Individual (Non-resident). Ensure to fill in the countryOKSM field and either the inn or regNumber field.

u

User parameters, where N is the parameter number from 1 to 25.

Every template contains a set of defined variables. Get a list of template variables used and pass values to these variables when you add or edit the banner.

The ID passed to the ad tag.

The custom ID of the action point.

The frequency of the user's exposure to the ad campaign.

If your impression frequency is set to other period (frequencyTypeImpressions=8), enter a custom period in hours and minutes for banner impressions per user.

Time format: HH:mm.

The frequency of the user's exposure to the ad campaign.

If you set click-through frequency to other period (frequencyTypeClicks=8), specify a custom period. Once a user reaches the maximum click limit for the period, banner impressions will be capped for them until the period resets.

Time format: HH:mm.

Website or video resource domain, blog URL, or app download link. Ad labeling parameter.

Requirements for url values:

• The URL must start with the http or https protocol.
• The path must not contain punycode or urlencode.

The url field is required if platformType=0 or platfromType=1.

In targeting by behavior, the advertiser sets the conditions when ad display is allowed.

There are two ways conditions can be applied: any of the given conditions is true and all specified conditions are true. You can set up to 9 conditions. Each condition includes 4 parameters, where N in the parameter name is the condition number from 1 to 9:

• Labeled/unlabeled users (UTNotN).
• If the user is labeled, which category (categoryIDN) is used.
• How many times the user is labeled (visitsN).
• When the user was last labeled (timeoutN).

Specify the conditional logic for serving ad campaign banners to users.

Acceptable values:

• 0: Any of the given conditions is true.
• 1: All specified conditions are true.

Select the target audience: labeled or unlabeled users, where N in the parameter name is the condition number from 1 to 9.

Acceptable values:

• 0: Condition not set.
• 1: Labeled users.
• 2: Unlabeled users.

Default value: 0.

Visits at least a specified number of times, where N is the condition number.

Acceptable values: Integers from 1 to 2147483647.

The last visit was no later than the number of days specified, where N is the condition number.

Acceptable values: Integers from 1 to 2147483647.

v

Where N in the parameter name is the ID of a characteristic value.

Acceptable values:

• 0: disabled.
• 1: enabled.

Video quality.

Acceptable values:

• 240p
• 360p
• 480p
• 720p
• 1080p

Default value: 480p.

Specify how many times the user must be labeled, where N in the parameter name is the condition number from 1 to 9.

Acceptable values: Integers from 1 to 2147483647.

Video duration in seconds.

You can set this value with millisecond precision: for example, 11.325.

w

Banner width.

Action point weight. Used for building reports. For example, going to the landing page after clicking on the banner has less weight than going to the checkout page, which has more weight because the purpose of the ad campaign is to increase sales.

Allowed values: 0≤N≤100, where N is the action point weight used to determine its importance for reaching ad goals.

WebMoney wallet number.

WebMoney wallet security code.

Site owner ID. The site owner is only allowed access to site statistics.

Read also:

• Create a site owner
• Get a list of site owners

The name of the site.

x

y

Yandex Money wallet number.

z

Postal code.

Site section ID.

Required parameter.