modify

objectID*

ID of the supercampaign whose parameters you want to edit.

name

Supercampaign name.

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

advertiserID

Advertiser ID.

Read also:

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

assistantID

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

Read also:

• Create an assistant.
• Get a list of assistants.

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.

maxImpressions

Maximum number of banner impressions.

Acceptable values: an integer from 1 to 2147483647.

maxImpressionsPerDay

Maximum number of impressions per day.

Acceptable values: an integer from 1 to 2147483647.

maxImpressionsPerHour

Maximum number of impressions per hour.

Acceptable values: an integer from 1 to 2147483647.

maxClicks

Maximum total number of click-throughs.

Acceptable values: an integer from 1 to 2147483647.

maxClicksPerDay

Maximum number of clicks per day.

Acceptable values: an integer from 1 to 2147483647.

maxClicksPerHour

Maximum number of clicks per hour.

Acceptable values: an integer from 1 to 2147483647.

maxUniqueImpressions

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

Acceptable values: an integer from 1 to 2147483647.

frequencyTypeImpressions

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

Acceptable values:

• 0: Not set.
• 1: An hour.
• 2: Four hours.
• 3: Six hours.
• 4: 12 hours.
• 5: 24 hours.
• 6: A week.
• 7: A 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 transmission 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 transmission format with seconds: HH:mm:ss.

dateStart

Ad running start date.

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

Default value: today from 00:00.

dateEnd

Ad running end date.

Date and time transmission 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).

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.