superCampaign

Get a list of super campaigns.

Request format

Note

Pagination available.

https://adfox.yandex.com/api/v1
  ? object=account
  & action=list
  & actionObject=superCampaign
  & [actionObjectID=<integer>]
  & [dateAddedFrom=<YYYY-MM-DD>]
  & [dateAddedTo=<YYYY-MM-DD>]
  & [show=<string>]
  & [search=<string>]

actionObjectID

To get data for only one super campaign, specify its ID.

Default value: 0 (display the list of all super campaigns).

dateAddedFrom

Data filtering: show super campaigns created after the specified date.

dateAddedTo

Data filtering: show super campaigns created before the specified date.

show

Configure data display.

Acceptable values:

  • advanced (full display format).

  • common (brief display format):

    • ID.
    • name.

  • short (limited display format):

    • ID.
    • name.
    • status.
    • dateStart.
    • dateEnd.
    • dateFinished.

Default value: advanced.

search

Filtering by substring in a super campaign name.

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

* Required

Response format

<response>
<status>
 <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <name>{string}</name>
    <advertiserID>{integer}</advertiserID>
    <advertiserAccount>{string}</advertiserAccount>
    <assistantID>{integer}</assistantID>
    <assistantAccount>{string}</assistantAccount>
    <additionalAdvertiserIDs/>
    <additionalAdvertiserAccounts/>
    <additionalAssistantIDs/>
    <additionalAssistantAccounts/>
    <logicType>{integer}</logicType>
    <type>{integer}</type>
    <status>{integer}</status>
    <impressionsMethodID>{integer}</impressionsMethodID>
    <maxImpressions>{integer}</maxImpressions>
    <maxImpressionsPerDay>{integer}</maxImpressionsPerDay>
    <maxImpressionsPerHour>{integer}</maxImpressionsPerHour>
    <maxClicks>{integer}</maxClicks>
    <maxClicksPerDay>{integer}</maxClicksPerDay>
    <maxClicksPerHour>{integer}</maxClicksPerHour>
    <maxUniqueImpressions>{integer}</maxUniqueImpressions>
    <frequencyTypeImpressions>{integer}</frequencyTypeImpressions>
    <uniquePeriodImpressions>{string}</uniquePeriodImpressions>
    <impressionsPerPeriod>{integer}</impressionsPerPeriod>
    <minimalPeriodImpressions>0:00</minimalPeriodImpressions>
    <dateStart>{date}</dateStart>
    <dateEnd>{date}</dateEnd>
    <dateFinished>{date}</dateFinished>
    <dateAdded>{date}</dateAdded>
    <sendToErir>{integer}</sendToErir>
    <contractID>{integer}</contractID>
    <publisherContractID>{integer}</publisherContractID>
    <costType>{integer}</costType>
  </row0>
</data>
</result>
</response>

Response parameters

code

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

rowN

Item number in the response tree, where N is a number from 0 to rows-1 (where rows is the total number of items in the response).

name

Super campaign name.

advertiserID

Advertiser ID.

advertiserAccount

Advertiser's account.

assistantID

ID of the assistant that the super campaign is assigned to.

assistantAccount

Account of the assistant that the super campaign is assigned to.

additionalAdvertiserIDs

IDs of additional advertisers.

additionalAdvertiserAccounts

Accounts of additional advertisers.

additionalAssistantIDs

IDs of additional assistants.

additionalAssistantAccounts

Accounts of additional assistants.

logicType

Campaign type.

Acceptable values:

  • 0: Commercial.
  • 1: Measuring.

status

Status.

Acceptable values:

  • 0: Active.
  • 1: Paused.
  • 2: Completed.

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

maxImpressions

Maximum number of impressions.

maxImpressionsPerDay

Maximum number of impressions per day.

maxImpressionsPerHour

Maximum number of impressions per hour.

maxClicks

Maximum total number of clicks.

maxClicksPerDay

Maximum number of clicks per day.

maxClicksPerHour

Maximum number of clicks per hour.

maxUniqueImpressions

Maximum number of impressions per user.

frequencyTypeImpressions

Impression frequency period.

uniquePeriodImpressions

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.

impressionsPerPeriod

Number of impressions per period.

minimalPeriodImpressions

Minimum period between impressions.

dateStart

Delivery start date.

dateEnd

Delivery end date.

dateFinished

Delivery completion date.

dateAdded

Add date.

sendToErir

Submit data to the Russian state register.

Possible values:

  • 0: Don't submit data to the Russian state register.
  • 1: Submit data to the Russian state register (ad register is enabled).

contractID

ID of a direct or primary contract.

publisherContractID

ID of the contract with the end advertiser.

costType

Campaign type.

Acceptable values:

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

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=superCampaign

Response:

<response>
<status>
 <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>29038</ID>
    <name>example</name>
    <advertiserID>226201</advertiserID>
    <advertiserAccount>petrov</advertiserAccount>
    <assistantID>221327</assistantID>
    <assistantAccount>ivanov</assistantAccount>
    <additionalAdvertiserIDs/>
    <additionalAdvertiserAccounts/>
    <additionalAssistantIDs/>
    <additionalAssistantAccounts/>
    <logicType>0</logicType>
    <type>0</type>
    <status>2</status>
    <impressionsMethodID>0</impressionsMethodID>
    <maxImpressions>0</maxImpressions>
    <maxImpressionsPerDay>0</maxImpressionsPerDay>
    <maxImpressionsPerHour>0</maxImpressionsPerHour>
    <maxClicks>0</maxClicks>
    <maxClicksPerDay>0</maxClicksPerDay>
    <maxClicksPerHour>0</maxClicksPerHour>
    <maxUniqueImpressions>0</maxUniqueImpressions>
    <frequencyTypeImpressions>6</frequencyTypeImpressions>
    <uniquePeriodImpressions>0:00</uniquePeriodImpressions>
    <impressionsPerPeriod>1</impressionsPerPeriod>
    <minimalPeriodImpressions>0:00</minimalPeriodImpressions>
    <dateStart>2021-07-02 00:00:00</dateStart>
    <dateEnd>2022-03-31 23:59:00</dateEnd>
    <dateFinished>2022-04-01 00:30:01</dateFinished>
    <dateAdded>2021-07-02</dateAdded>
    <sendToErir>1</sendToErir>
    <contractID>123</contractID>
    <publisherContractID>50</publisherContractID>
    <costType>2</costType>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the superCampaign object:

Filtering by substring in a super campaign name.

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

Required

To get data for only one super campaign, specify its ID.

Default value: 0 (display the list of all super campaigns).

Data filtering: show super campaigns created after the specified date.

Data filtering: show super campaigns created before the specified date.

Configure data display.

Acceptable values:

  • advanced (full display format).

  • common (brief display format):

    • ID.
    • name.

  • short (limited display format):

    • ID.
    • name.
    • status.
    • dateStart.
    • dateEnd.
    • dateFinished.

Default value: advanced.

Previous
position
Next
targetingProfile