category

Add a category. A category is a tool for labeling a site (for example, using thematic zones) that you can use to get statistics on impressions and clicks for the category and to group sites by category in ad networks. Categories are also used to label audience and set up behavioral targeting.

Request format

https://adfox.yandex.com/api/v1
  ? object=account
  & action=add
  & actionObject=category
  & name=<string>
  & [type=<integer>]
  & [timeout=<integer>]

name*

Object name. An entry can contain Russian and Latin letters, numbers, and any special characters.

type

Category type.

Acceptable values:

  • 0: Permanent category. Used to label sites, sections, and placements.
  • 1: Temporary category. Used to set up behavioral targeting.

Default value: 0.

timeout

Activity (days).

Default value: not set.

* Required

Response format

<response>
<status>
  <code>{integer}</code>
  <ID>{integer}</ID>
</status>
</response>

Response parameters

code

Request processing status. If the value is 0, the request was completed successfully. For the key, see Error handling.

ID

Object ID.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=add&actionObject=category&name=avto&type=1

Response:

<response>
<status>
  <code>0</code>
  <ID>4</ID>
</status>
</response>

Other actions with the object

See more actions with the category object:

Previous