addValue
Add a value for a user targeting characteristic.
Request format
https://adfox.yandex.com/api/v1
? object=userCriteria
& action=addValue
& criteriaID=<integer>
& userID=<string>
& name=<string>
& [isOn=<integer>]
|
User characteristic ID. Acceptable values: |
|
The ID that's passed to the ad tag. |
|
Object name. It can contain Russian and Latin letters, numbers, and any symbols. |
|
The targeting setting of current campaigns when adding a new characteristic value. Acceptable values:
Default value: |
* Required
Response format
<response>
<status>
<code>{integer}</code>
<ID>{integer}</ID>
</status>
</response>
Response parameters
|
Request processing status. For the key, see Error handling. |
|
Object ID. |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=userCriteria&action=addValue&criteriaID=1&userID=man&name=man&isOn=0
Response:
<response> <status> <code>0</code> <ID>39377</ID> </status> </response>
Other actions with the object
See also other actions with the userCriteria
object:
- Enable or edit a user characteristic.
- Get a list of characteristic values.
- Edit a characteristic value.
- Delete a characteristic value.
User characteristic ID.
Acceptable values: 1≤N≤63
, where N is the characteristic number from 1 to 63 inclusive.
The ID that's passed to the ad tag.
Object name. It can contain Russian and Latin letters, numbers, and any symbols.
The targeting setting of current campaigns when adding a new characteristic value.
Acceptable values:
-
0
: Don't target by the new value. A new characteristic value is added to the existing campaigns and banners ** enabled**, regardless of previous targeting settings. -
1
: Target by the new value. A new characteristic value is added to the existing campaigns and banners:- Enabled: If all previously added values are included in the targeting of this characteristic (the object isn't targeted).
- Disabled: If there's at least one disabled value in the targeting of this characteristic (the object was targeted).
Default value: 0
.
Required