targetingUser

Target campaign placement in the site section by user characteristics.

Request format

https://adfox.yandex.com/api/v1
  ? object=campaign
  & action=targetZone
  & actionObject=targetingUser
  & objectID=<integer>
  & zoneID=<integer>
  & isRedefined=<integer>
  & criteriaID=<integer>
  & vN=<integer>

objectID*

ID of the object that the action is performed on.

zoneID*

Site section ID.

isRedefined*

Redefine targeting.

Acceptable values:

  • 0: Inherit targeting settings from a higher level. Level hierarchy from top to bottom:

    • Campaign.
    • Campaign on the site.
    • Campaign in the site section.
    • Campaign on the placement.
    • Banner.
  • 1: Cancel targeting settings at higher levels and use the settings of the current level.

criteriaID*

Characteristic ID.

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

vN*

Where N in the parameter name is the ID of the characteristic value.

Acceptable values:

  • 0: Disable.
  • 1: Enable.

* 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=campaign&action=targetZone&actionObject=targetingUser&objectID=474205&criteriaID=1&v5345=1&zoneID=234&isRedefined=1

Response:

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

Other actions with the object

See more actions with the campaign object:

Previous
Next