modify

Enable or edit a user targeting characteristic. There are 63 characteristics that you can use to configure references with values for targeting ad 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 with information about the loaded site pages or its visitor. The targeting values are sent from the site using the ad tag.

You can use this request to:

  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.

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

isOn

Enable/disable the object.

Acceptable values:

  • 0: disabled.
  • 1: enabled.

Default value: 1.

criteriaName*

User characteristic name.

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

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

criteriaTargetingName*

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

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

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

criteriaReportName*

The name of the user characteristic targeting report.

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

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

Response format

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

Response parameters

code

Request processing status. A value of 0 means the request was completed successfully. 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

Read about other actions with the userCriteria object:

User characteristic ID.

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

Enable/disable the object.

Acceptable values:

  • 0: disabled.
  • 1: enabled.

Default value: 1.

User characteristic name.

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

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

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

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

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

The name of the user characteristic targeting report.

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

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

Required parameter.

Previous
listValues
Next
modifyValue