bannerPlacements

Get information about banner placement.

Request format

Note

Pagination available.

https://adfox.yandex.com/api/v1
  ? object=account
  & action=list
  & actionObject=bannerPlacements
  & bannerID=<integer>

bannerID*

ID of the banner to view the placement information for.

See also:

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <websiteID>{integer}</websiteID>
    <websiteName>{string}</websiteName>
    <isWebsiteOn>{integer}</isWebsiteOn>
    <sectionID>{integer}</sectionID>
    <sectionName>{string}</sectionName>
    <isSectionOn>{integer}</isSectionOn>
    <placeID>{integer}</placeID>
    <placeName>{string}</placeName>
    <isPlaceOn>{integer}</isPlaceOn>
  </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).

websiteID

ID of the site where the banner is placed.

websiteName

Name of the site where the banner is placed.

isWebsiteOn

Attribute of banner placement on the site:

  • 1: Enabled.
  • 0: Disabled.

sectionID

Site section ID.

sectionName

Name of the site section.

isSectionOn

Attribute of banner placement in the site section:

  • 1: Enabled.
  • 0: Disabled.

placeID

Placement ID.

placeName

Placement name.

isPlaceOn

Attribute of banner placement on the placement:

  • 1: Enabled.
  • 0: Disabled.

Sample request and response

Request:

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

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
   <websiteID>39310</websiteID>
   <websiteName>4416</websiteName>
   <isWebsiteOn>1</isWebsiteOn>
   <sectionID>83286</sectionID>
   <sectionName>all pages</sectionName>
   <isSectionOn>1</isSectionOn>
   <placeID>821550</placeID>
   <placeName>placement</placeName>
   <isPlaceOn>1</isPlaceOn>
  </row0>
</data>
</result>
</response>
Previous
banner
Next
bannerPlaceReport
In this article: