modify

Edit supercampaign parameters.

Request format

https://adfox.yandex.com/api/v1
  ? object=superCampaign
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [advertiserID=<integer>]
  & [assistantID=<integer>]
  & [status=<integer>]
  & [sectorID=<integer>]
  & [maxImpressions=<integer>]
  & [maxImpressionsPerDay=<integer>]
  & [maxImpressionsPerHour=<integer>]
  & [maxClicks=<integer>]
  & [maxClicksPerDay=<integer>]
  & [maxClicksPerHour=<integer>]
  & [maxUniqueImpressions=<integer>]
  & [frequencyTypeImpressions=<integer>]
  & [uniquePeriodImpressions=<HH:mm>]
  & [impressionsPerPeriod=<integer>]
  & [minimalPeriodImpressions=<HH:mm:ss>]
  & [dateStart=<YYYY-MM-DD HH:mm>]
  & [dateEnd=<YYYY-MM-DD HH:mm>]
  & [sendToErir=<integer>]
  & [contractID=<integer>]
  & [publisherContractID=<integer>]
  & [costType=<integer>]

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:

assistantID

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

Read also:

status

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.

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

maxUniqueImpressions

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

Acceptable values: Integers from 1 to 2147483647.

frequencyTypeImpressions

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.

uniquePeriodImpressions

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.

impressionsPerPeriod

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

minimalPeriodImpressions

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.

dateStart

Ad running start date.

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

Default value: today from 00:00.

dateEnd

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

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

publisherContractID

ID of the final contract.

Required if contractID points to a primary contract.

costType

Campaign type.

Acceptable values:

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

Default value: 0.

Response format

<response>
  <status>
    <code>{integer}</code>
    <ID>{integer}</ID>
  </status>
</response>

Texts

Response parameters

code

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

ID

Object ID.

Response format

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=superCampaign&action=modify&objectID=39377&name=April_16_coffee&advertiserID=456&dateStart=2021-12-21 06:30&dateEnd=2021-12-30 22:30

Response:

<response>
  <status>
    <code>0</code>
    <ID>39377</ID>
  </status>
</response>

Other actions with the object

Find out what else you can do with the superCampaign object:

ID of the supercampaign whose parameters you want to edit.

Supercampaign name.

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

Advertiser ID.

Read also:

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

Read also:

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.

Default value: 0.

Industry.

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

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.

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.

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

Acceptable values: Integers from 1 to 2147483647.

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.

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. Number of impressions per period.

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.

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.

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

ID of a direct or primary contract.

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

ID of the final contract.

Required if contractID points to a primary contract.

Campaign type.

Acceptable values:

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

Default value: 0.

Required parameter.