place

Get a list of placements.

Request format

Note

Pagination available.

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

actionObjectID

To get data for only one placement, specify its ID.

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

actionObjectID2

Filter by site ID.

See also:

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <name>{string}</name>
    <positionID>{integer}</positionID>
    <positionName>{string}</positionName>
    <zoneID>{integer}</zoneID>
    <zoneName>{string}</zoneName>
    <siteID>{integer}</siteID>
    <siteName>{string}</siteName>
    <categoryID>{integer}</categoryID>
    <categoryName>{string}</categoryName>
    <bannerTypeID>{integer}</bannerTypeID>
    <bannerTypeName>{string}</bannerTypeName>
    <presentationTypeID>{integer}</presentationTypeID>
    <presentationTypeName>{string}</presentationTypeName>
    <dateAdded>{date}</dateAdded>
  </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.

row0

List item with its corresponding number.

ID

Unique ID of the placement.

name

Placement name.

positionID

Position ID.

positionName

Position name.

zoneID

ID of the site section where the placement is located.

zoneName

Name of the site section where the placement is located.

siteID

ID of the site where the placement is located.

siteName

Name of the site where the placement is located.

categoryID

Placement category ID.

categoryName

Category name.

bannerTypeID

Banner type ID.

bannerTypeName

Banner type name.

presentationTypeID

Presentation type ID tells the server in what form banners are to be uploaded to the site.

Acceptable values:

  • 0: Standard. The banner code will be uploaded as HTML code in an iframe with the specified dimensions.
  • 4: Nondimensional. The banner code will be uploaded as JavaScript code.
  • 5: XML. The banner code will be uploaded as XML code.

presentationTypeName

Name of the presentation type for the banner type.

dateAdded

Add date.

Sample request and response

Request:

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

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>667290</ID>
    <name>placement1</name>
    <positionID>6</positionID>
    <positionName>page top</positionName>
    <zoneID>60119</zoneID>
    <zoneName>section1</zoneName>
    <siteID>27185</siteID>
    <siteName>site</siteName>
    <categoryID>0</categoryID>
    <categoryName/>
    <bannerTypeID>17</bannerTypeID>
    <bannerTypeName>600x90</bannerTypeName>
    <presentationTypeID>0</presentationTypeID>
    <presentationTypeName>Standard</presentationTypeName>
    <dateAdded>2021-11-27</dateAdded>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the place object:

Filter by site ID.

See also:

Required

To get data for only one placement, specify its ID.

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

Previous
erirRegions
Next
position