listValues

Get a list of values of a user targeting characteristic.

Request format

Note

https://adfox.yandex.com/api/v1
  ? object=userCriteria
  & action=listValues
  & [criteriaID=<integer>]
  & [objectID=<string>]

criteriaID

User characteristic ID.

Allowed values: 1≤N≤63, where N is the characteristic index from 1 to 63 inclusive.

objectID

Characteristic value ID.

Response format

<response>
  <status>
   <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <criteriaID>1</criteriaID>
     <ID>141140</ID>
     <userID>14234</userID>
     <name>Motorsport</name>
    </row0>
</response>

Response parameters

`code`	Request processing status. A value of `0` means 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).
`criteriaID`	User characteristic ID. Allowed values: `1≤N≤63`, where `N` is the characteristic index from 1 to 63 inclusive.
`ID`	User characteristic value ID.
`userID`	The ID passed to the ad tag.
`name`	Value name.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=userCriteria&action=listValues&criteriaID=8

Response:

<response>
  <status>
   <code>0</code>
  </status>
  <data>
   <result>
    <row0>
     <criteriaID>1</criteriaID>
     <ID>141140</ID>
     <userID>14234</userID>
     <name>Motorsport</name>
    </row0>
</response>

Other actions with the object

Read about other actions with the userCriteria object:

Was the article helpful?

addValue

modify