modify

objectID*

ID of the supercampaign whose parameters you want to edit.

name

Supercampaign name. It can contain Russian and Latin letters, numbers, and any symbols.

advertiserID

Advertiser ID.

See also:

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

assistantID

The ID of the assistant to whom you want to give access to the object based on their permissions.

See also:

• Create an assistant.

• Get a list of assistants.

status

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

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 on the list.
• 2: Completed — the object is assumed to be delivered in full. by default, filters in the Adfox web interface hide finished objects.

sectorID

Industry.

See also:

• Get a list of industries.

maxImpressions

The maximum number of banner impressions.

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

maxImpressionsPerDay

The maximum number of impressions per day.

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

maxImpressionsPerHour

The maximum number of impressions per hour.

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

maxClicks

The maximum number of total clicks.

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

maxClicksPerDay

The maximum number of clicks per day.

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

maxClicksPerHour

The maximum number of clicks per hour.

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

maxUniqueImpressions

The user's frequency cap for the campaign. The maximum number of impressions per user. Acceptable values: an integer from 1 to 2,147,483,647.

frequencyTypeImpressions

The user's frequency cap for 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.

uniquePeriodImpressions

The user's frequency cap for the campaign.

If you set the 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

The user's frequency cap for the campaign. Number of impressions per period.

minimalPeriodImpressions

The user's frequency cap for the campaign. The minimum period between banner impressions for a unique user (hours:minutes:seconds).

Time format with seconds: HH:mm:ss.

dateStart

Ad running start date.

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

dateEnd

Ad running 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. For the key, see Error handling.

ID

The ID of the supercampaign being edited.