defaultBanner

Get a list of backup ads (banners) for placements.

Request format

Note

Pagination available.

https://adfox.yandex.com/api/v1
  ? object=account
  & action=list
  & actionObject=defaultBanner
  & [listPlaceIDs=<integer>]

listPlaceIDs

List of placement IDs.

A comma is used as a separator.

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <adNetworkID>{integer}</adNetworkID>
    <adNetworkName>{string}</adNetworkName>
    <siteID>{integer}</siteID>
    <siteName>{string}</siteName>
    <placeID>{integer}</placeID>
    <bannerTypeID>{integer}</bannerTypeID>
    <bannerTypeName>{string}</bannerTypeName>
    <presentationTypeName>{string}</presentationTypeName>
    <defaultCodeType>{integer}</defaultCodeType>
    <defaultCode>{string}</defaultCode>
  </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.

rows

Number of items in the response tree.

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

siteID

ID of the site in management.

siteName

Name of the site in management.

bannerTypeID

Banner type ID.

bannerTypeName

Banner type name.

presentationTypeName

Load type for the banner type.

defaultCodeType

Code type for the backup ad.

Acceptable values:

  • 0: HTML code.
  • 1: JavaScript code.

defaultCode

Backup ad.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=defaultBanner&listAdNetworkIDs=506,566

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <adNetworkID>506</adNetworkID>
    <adNetworkName>240x400</adNetworkName>
    <siteID>24138</siteID>
    <siteName>test site</siteName>
    <placeID>632208</placeID>
    <bannerTypeID>82654</bannerTypeID>
    <bannerTypeName>728x90js</bannerTypeName>
    <presentationTypeName>Nondimensional</presentationTypeName>
    <defaultCodeType>0</defaultCodeType>
    <defaultCode><p></p></defaultCode>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the defaultBanner object:

Previous
contractor
Next
place
In this article: