zone
Get a list of site sections.
Request format
Note
Pagination available.
https://adfox.yandex.com/api/v1
? object=account
& action=list
& actionObject=zone
& [actionObjectID=<integer>]
& [actionObjectID2=<integer>]
|
To get data for only one site section, specify its ID. Default value: |
|
Filter by site ID. |
* Required
Response format
<response>
<status>
<code>{integer}</code>
</status>
<result>
<data>
<row0>
<ID>{integer}</ID>
<name>{string}</name>
<siteID>{integer}</siteID>
<siteName>{string}</siteName>
<categoryID>{integer}</categoryID>
<categoryName>{string}</categoryName>
<isAutoReferer>{integer}</isAutoReferer>
<templateTypeID>{integer}</templateTypeID>
<dateAdded>{date}</dateAdded>
<template>
<template1>{string}</template1>
</template>
</row0>
</data>
</result>
</response>
Response parameters
|
Request processing status. If the value is |
|
Number of items in the response tree. |
|
Item number in the response tree, where N is a number from 0 to rows-1 (where |
|
Unique ID of the site section. |
|
Section name. |
|
ID of the site where the section is located. |
|
Name of the site where the section is located. |
|
ID of the category assigned to the section. |
|
Name of the category assigned to the section. |
|
Dynamic definition of a site by referer. |
|
Referer template type. |
|
Add date. |
|
List of templates. |
|
String with the referer template, where N is the string number. |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=account&action=list&actionObject=zone
Response:
<response> <status> <code>0</code> </status> <result> <data> <row0> <ID>60119</ID> <name>section 1</name> <siteID>27185</siteID> <siteName>site</siteName> <categoryID>0</categoryID> <categoryName/> <isAutoReferer>1</isAutoReferer> <templateTypeID>0</templateTypeID> <dateAdded>2021-11-27</dateAdded> <template> <template1>*</template1> </template> </row0> </data> </result> </response>
Other actions with the object
See more actions with the zone
object:
Filter by site ID.
Required
To get data for only one site section, specify its ID.
Default value: 0
(display the list of all site sections).