position

Get a list of positions.

Request format

Note

Pagination available.

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

actionObjectID

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

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

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <ID>{integer}</ID>
    <name>{string}</name>
    <isPredefined>{integer}</isPredefined>
    <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.

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

ID

Unique position ID.

name

Position name.

isPredefined

Object type.

Acceptable values:

  • 0: Custom.
  • 1: System.

dateAdded

Add date.

Sample request and response

Request:

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

Response:

<response>
<status>
   <code>0</code>
</status>
<result>
<data>
  <row0>
    <ID>6</ID>
    <name>page top</name>
    <isPredefined>1</isPredefined>
    <dateAdded>2005-08-25</dateAdded>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the position object:

Previous
place
Next
superCampaign
In this article: