modify

Enable or edit a user targeting characteristic. There are 63 characteristics that you can use to configure references with values for targeting campaigns in Adfox.

Additional targeting is a type of targeting where the characteristics for selecting the target audience are determined by the Adfox client. Every characteristic contains a set of values that represent what the website knows about the loaded page or its visitor. The targeting values are sent from the website using the ad tag.

You can use this request to perform two actions:

  1. Enable a new characteristic for user targeting. The criteriaName, criteriaTargetingName, and criteriaReportName parameters are required.

  2. Edit an enabled characteristic. The criteriaName, criteriaTargetingName, and criteriaReportName parameters are optional.

Request format

https://adfox.yandex.com/api/v1
  ? object=userCriteria
  & action=modify
  & criteriaID=<integer>
  & [isOn=<integer>]
  & criteriaName=<string>
  & criteriaTargetingName=<string>
  & criteriaReportName=<string>

criteriaID*

User characteristic ID.

Acceptable values: 1≤N≤63, where N is the characteristic number from 1 to 63 inclusive.

isOn

Enable/disable the object.

Acceptable values:

  • 0: Disabled.
  • 1: Enabled.

criteriaName*

User characteristic name.

It can contain Russian and Latin letters, numbers, and any symbols.

If you're enabling a new characteristic, this parameter is required.

criteriaTargetingName*

The name of the tab for targeting by user characteristics for a campaign and banner.

It can contain Russian and Latin letters, numbers, and any symbols.

If you're enabling a new characteristic, this parameter is required.

criteriaReportName*

The name of the user characteristic targeting report.

It can contain Russian and Latin letters, numbers, and any symbols.

If you're enabling a new characteristic, this parameter is required.

* Required

Response format

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

Response parameters

code

Request processing status. For the key, see Error handling.

Sample request and response

Request:

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

Response:

<response>
<status>
  <code>0</code>
</status>
</response>

Other actions with the object

See also other actions with the userCriteria object:

User characteristic ID.

Acceptable values: 1≤N≤63, where N is the characteristic number from 1 to 63 inclusive.

Enable/disable the object.

Acceptable values:

  • 0: Disabled.

  • 1: Enabled.

User characteristic name.

It can contain Russian and Latin letters, numbers, and any symbols.

If you're enabling a new characteristic, this parameter is required.

The name of the tab for targeting by user characteristics for a campaign and banner.

It can contain Russian and Latin letters, numbers, and any symbols.

If you're enabling a new characteristic, this parameter is required.

The name of the user characteristic targeting report.

It can contain Russian and Latin letters, numbers, and any symbols.

If you're enabling a new characteristic, this parameter is required.

Required

Previous
listValues
Next
modifyValue