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>]
|
To get data for only one super campaign, specify its ID. Default value: |
|
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:
Default value: |
|
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>
<level>{integer}</level>
<priority>{integer}</priority>
<status>{integer}</status>
<impressionsMethodID>{integer}</impressionsMethodID>
<maxImpressions>{integer}</maxImpressions>
<maxImpressionsPerDay>{integer}</maxImpressionsPerDay>
<maxImpressionsPerHour>{integer}</maxImpressionsPerHour>
<maxClicks>{integer}</maxClicks>
<maxClicksPerDay>{integer}</maxClicksPerDay>
<maxClicksPerHour>{integer}</maxClicksPerHour>
<maxActiveEvents>{integer}</maxActiveEvents>
<maxActiveEventsPerDay>{integer}</maxActiveEventsPerDay>
<maxActiveEventsPerHour>{integer}</maxActiveEventsPerHour>
<maxUniqueImpressions>{integer}</maxUniqueImpressions>
<maxUniqueClicks>{integer}</maxUniqueClicks>
<datePeriod/>
<frequencyTypeImpressions>{integer}</frequencyTypeImpressions>
<uniquePeriodImpressions>{string}</uniquePeriodImpressions>
<impressionsPerPeriod>{integer}</impressionsPerPeriod>
<minimalPeriodImpressions>0:00</minimalPeriodImpressions>
<frequencyTypeClicks>{integer}</frequencyTypeClicks>
<uniquePeriodClicks>0:00</uniquePeriodClicks>
<clicksPerPeriod>{integer}</clicksPerPeriod>
<minimalPeriodClicks>0:00</minimalPeriodClicks>
<dateStart>{date}</dateStart>
<dateEnd>{date}</dateEnd>
<dateFinished>{date}</dateFinished>
<dateAdded>{date}</dateAdded>
</row0>
</data>
</result>
</response>
Response parameters
|
Request processing status. If the value is |
|
Item number in the response tree, where N is a number from 0 to rows-1 (where |
|
Super campaign name. |
|
Advertiser ID. |
|
Advertiser's account. |
|
ID of the assistant that the super campaign is assigned to. |
|
Account of the assistant that the super campaign is assigned to. |
|
IDs of additional advertisers. |
|
Accounts of additional advertisers. |
|
IDs of additional assistants. |
|
Accounts of additional assistants. |
|
Campaign type. Acceptable values:
|
|
Super campaign level from 1 to 10. |
|
Priority. |
|
Status. Acceptable values:
|
|
Impression count method. Acceptable values:
|
|
Maximum number of impressions. |
|
Maximum number of impressions per day. |
|
Maximum number of impressions per hour. |
|
Maximum total number of clicks. |
|
Maximum number of clicks per day. |
|
Maximum number of clicks per hour. |
|
Maximum number of active events. |
|
Maximum number of active events per day. |
|
Maximum number of active events per hour. |
|
Maximum number of impressions per user. |
|
Maximum number of clicks per user. |
|
Campaign period start date. |
|
Impression frequency period. |
|
If you set impression frequency to other period ( |
|
Number of impressions per period. |
|
Minimum period between impressions. |
|
Click frequency period. |
|
If you set click frequency to other period ( |
|
Number of clicks per period. |
|
Minimum period between clicks. |
|
Delivery start date. |
|
Delivery end date. |
|
Delivery completion date. |
|
Add date. |
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> <level>1</level> <priority>100</priority> <status>2</status> <impressionsMethodID>0</impressionsMethodID> <maxImpressions>0</maxImpressions> <maxImpressionsPerDay>0</maxImpressionsPerDay> <maxImpressionsPerHour>0</maxImpressionsPerHour> <maxClicks>0</maxClicks> <maxClicksPerDay>0</maxClicksPerDay> <maxClicksPerHour>0</maxClicksPerHour> <maxActiveEvents>0</maxActiveEvents> <maxActiveEventsPerDay>0</maxActiveEventsPerDay> <maxActiveEventsPerHour>0</maxActiveEventsPerHour> <maxUniqueImpressions>0</maxUniqueImpressions> <maxUniqueClicks>0</maxUniqueClicks> <datePeriod/> <frequencyTypeImpressions>6</frequencyTypeImpressions> <uniquePeriodImpressions>0:00</uniquePeriodImpressions> <impressionsPerPeriod>1</impressionsPerPeriod> <minimalPeriodImpressions>0:00</minimalPeriodImpressions> <frequencyTypeClicks>0</frequencyTypeClicks> <uniquePeriodClicks>0:00</uniquePeriodClicks> <clicksPerPeriod>1</clicksPerPeriod> <minimalPeriodClicks>0:00</minimalPeriodClicks> <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> </row0> </data> </result> </response>
Other actions with the object
See more actions with the superCampaign
object:
- Add a super campaign.
- Delete a super campaign.
- Edit a super campaign.
- Add an additional assistant.
- Add an additional advertiser.
- Delete an additional assistant.
- Delete an additional advertiser.
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
.