userCriterias

Get a list of user targeting characteristics.

Request format

Note

Pagination available.

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

actionObjectID

Parameter that points to one object with the specified ID.

* Required

Response format

<response>
<status>
  <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <criteriaID>{integer}</criteriaID>
    <criteriaName>{string}</criteriaName>
    <criteriaTargetingName>{string}</criteriaTargetingName>
    <criteriaReportName>{string}</criteriaReportName>
    <isDeleted>{integer}</isDeleted>
  </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.

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

criteriaID

User characteristic ID.

criteriaName

User characteristic name.

criteriaTargetingName

Name of the tab for targeting by user characteristic.

criteriaReportName

Name of the user characteristic report.

isDeleted

Attribute of deletion.

Acceptable values:

  • 0: Not deleted.
  • 1: Deleted.

Sample request and response

Request:

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

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <criteriaID>1</criteriaID>
    <criteriaName>example</criteriaName>
    <criteriaTargetingName>example_name</criteriaTargetingName>
    <criteriaReportName>example_report</criteriaReportName>
    <isDeleted>0</isDeleted>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the userCriteria object: