banner

Get a list of campaign banners.

Request format

Note

https://adfox.yandex.com/api/v1
  ? object=campaign
  & action=list
  & actionObject=banner
  & objectID=<integer>

objectID*

The ad campaign ID.

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
 <rows>{integer}</rows>
  <row0>
    <ID>{integer}</ID>
    <name>{string}</name>
    <status>{integer}</status>
    <statusName>{string}</statusName>
    <priority>{integer}</priority>
    <bannerTypeID>{integer}</bannerTypeID>
    <bannerTypeName>{string}</bannerTypeName>
    <impressions>{integer}</impressions>
    <impressionsToday>{integer}</impressionsToday>
    <clicks>{integer}</clicks>
    <clicksToday>{integer}</clicksToday>
    <dateStart>{date}</dateStart>
    <dateEnd>{date}</dateEnd>
    <dateAdded>{date}</dateAdded>
  </row0>
  <row1>...</row1>
</data>
</result>
</response>

Response parameters

`code`	Request processing status. For the key, see Error handling.
`rows`	Number of items in the response tree.
`rowN`	The 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).
`ID`	The banner ID.
`name`	Banner name.
`status`	Status. Acceptable values: `0`: Active. `1`: Suspended. `2`: Completed.
`statusName`	Status name.
`priority`	Priority.
`bannerTypeID`	Banner type ID.
`bannerTypeName`	Banner type name.
`impressions`	Total number of banner impressions.
`impressionsToday`	Number of impressions today.
`clicks`	Total number of banner clicks.
`clicksToday`	Number of clicks today.
`dateStart`	Delivery start date.
`dateEnd`	Delivery end date.
`dateAdded`	Add date.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=campaign&action=list&actionObject=banner&objectID=474205

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <rows>2</rows>
  <row0>
    <ID>1262260</ID>
    <name>test</name>
    <status>0</status>
    <statusName>active</statusName>
    <priority>100</priority>
    <bannerTypeID>77524</bannerTypeID>
    <bannerTypeName>240x400 js</bannerTypeName>
    <impressions>1</impressions>
    <impressionsToday>0</impressionsToday>
    <clicks>0</clicks>
    <clicksToday>0</clicksToday>
    <dateStart>2022-04-06 00:00:00</dateStart>
    <dateEnd/>
    <dateAdded>2022-04-06 15:25:20</dateAdded>
  </row0>
  <row1>...</row1>
</data>
</result>
</response>

Other actions with the object

See more actions with the campaign object:

Add a campaign.
Get a list of campaigns.
Delete a campaign.
Edit a campaign.
Place a campaign on a site, a site section, or a placement.

Was the article helpful?

targeting

modify