superCampaign

name*

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

advertiserID*

Advertiser ID.

See also:

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

assistantID

ID of the assistant who will be allowed access to the object according to their permissions.

See also:

• Create an assistant.

• Get a list of assistants.

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 event sequence number from 1 to 30 (101 corresponds to event 1, 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). An impression is only counted if at least 50% of the banner area is 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). Iimpressions in the viewable area of the window in the active browser tab, counted according to the criteria established by international media industry standards (minimum percentage of pixels in the viewable area and display time in the viewable browser area).

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.

See also:

• Get a list of industries.

maxImpressions

Maximum number of banner impressions.

Acceptable values: integers from 1 to 2,147,483,647.

maxImpressionsPerDay

Maximum number of impressions per day.

Acceptable values: integers from 1 to 2,147,483,647.

maxImpressionsPerHour

Maximum number of impressions per hour.

Acceptable values: integers from 1 to 2,147,483,647.

maxClicks

Maximum total number of clicks.

Acceptable values: integers from 1 to 2,147,483,647.

maxClicksPerDay

Maximum number of clicks per day.

Acceptable values: integers from 1 to 2,147,483,647.

maxClicksPerHour

Maximum number of clicks per hour.

Acceptable values: integers from 1 to 2,147,483,647.

maxUniqueImpressions

Frequency of the user's contact with the ad campaign. Maximum number of impressions per user.

Acceptable values: integers from 1 to 2,147,483,647.

frequencyTypeImpressions

Frequency of the user's contact with the campaign. Impression frequency period.

Acceptable values:

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

Default value: 0.

uniquePeriodImpressions

Frequency of the user's contact with the campaign.

If you set impression frequency to other period (frequencyTypeImpressions=8), specify your own period for serving banners to a unique user in hours and minutes.

Time format: HH:mm

impressionsPerPeriod

Frequency of the user's contact with the campaign. Number of impressions per period.

minimalPeriodImpressions

Frequency of the user's contact with the campaign. Minimum period between banner impressions for a unique user (hours:minutes:seconds).

Time format with seconds: HH:mm:ss

dateStart

Delivery start date.

Default value: today from 00:00.

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

dateEnd

Delivery end date.

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

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.

This parameter is required if sendToErir=1. Learn more about getting a 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.

code

Request processing status. If the value is 0, the request was completed successfully. For the key, see Error handling.

ID

Object ID.