banner

objectID*

ID of the object that the action is performed on.

name

Banner name.

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

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.

dateStart

Ad running start date.

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

dateEnd

Delivery end date.

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

priority

Priority.

Acceptable values:

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

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.

isEvents

Get links to events.

Acceptable values:

• 0: disabled.
• 1: enabled.

isUnplaced

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 enabled, the default value is 1.

If the module isn't connected, the default value is 0.

backgroundColor

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

width

Banner width.

height

Banner height.

imageURL

Link to the banner image or a flash banner placeholder.

hitURL

Link to the advertiser's website.

target

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.

alt

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

userN

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.

For example, a template has two custom parameters: strings user1 and user3.

When you add or edit the banner, you need to pass the following values:

user1=text1&user3=text3

eventN

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.

hitURLN

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

videoResolution

Video quality.

Acceptable values:

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

Default value: 480p.

videoDuration

Video duration in seconds.

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

maxImpressions

Maximum number of 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.

trackingURL

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

For example, in links to the Adfox pixel, pr is the parameter for assigning a random number. Let's add a macro to it:

http://ads.adfox.com/166283/getCode?p1=borgd&p2=ezjv&
pfb=dwsey&pr=%random%

showMenu

Show the banner menu.

Acceptable values:

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

adLabel

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.

domain

Domain next to the “Ad” label.

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

token

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.

creativeContentType

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.

markingDescription

Description of the creative.

markingKktu

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.

markingCommonDescription

General description of the advertised item. Required if 30.15.1 is specified in the markingKktu parameter.

markingSendRegionsType

Ad impression region.

Acceptable values:

• none: Don't send value — the impression region data isn't sent to ERIR.
• all: All Russia value — the banner is served in all regions of Russia.
• selected: Specify regions manually value. If you choose selected, be sure to provide the IDs of the selected regions in the markingSelectedRegions parameter.

markingSelectedRegions

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. Example for ad impression regions with codes 9, 21, and 63:

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

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

targetURL

Target URL.

textData[]

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

To add an array element, pass all existing elements along with the new ones.

To delete an element from the array, pass all the elements except the one that you want to delete.

You can also completely clear the array. To do this, pass an array with an empty value, for example: textData[]=.

mediaData[]

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

The URL is checked for availability before saving.

The description field is optional.

Example of the field:

mediaData[]={"url": "https://avatars.mds.yandex.net/
get-adfox-content/example.jpeg/example.we
bp", "description": "Text_string"}

To add an array element, pass all existing elements along with the new ones.

To delete an element from the array, pass all the elements except the one that you want to delete.

You can also completely clear the array. To do this, pass an array with an empty value, for example: mediaData[]=.

sendToErir<ParameterN>

Enable or disable the transfer of the creative's parameter to the state register for a specific variable, where <ParameterN> is the name of that variable.

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 submission to the state register for the variable.

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

If parameter transfer isn't enabled in the template (the Do not use in marking option is selected in the Labeling column), you won't be able to submit the parameter (error Incorrect value (-6)). To manage data transfer when creating a banner, go to the Adfox interface and enable the option in the template.

sendToErirContentType<ParameterN>

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

Acceptable values:

• image;

• video;

• audio;

• zip.

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

sendToErirDescription<ParameterN>

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

code

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