targetingRevenue

Target a banner by user income levels.

Targeting by income levels is based on audience data about visitors to the website.

For targeting by gender, age, and income, Adfox uses the Crypta technology data.

by default, this type of targeting is disabled for all campaigns and banners. This means that the banners are shown to users with any gender, age, and income characteristics.

You can enable this targeting type (the Enable targeting parameter) and select the values to use in campaign targeting. Once targeting is enabled, you can view a report on impressions for the campaign based on user data.

Request format

https://adfox.yandex.com/api/v1
  ? object=banner
  & action=target
  & actionObject=targetingRevenue
  & objectID=<integer>
  & revenue=<integer>
  & revenueValues=<integer>
  & isRedefined=<integer>

objectID*

ID of the object that the action is performed on.

revenue*

Enable targeting by income (revenue).

Acceptable values:

  • 0: Disabled.
  • 1: Enabled.

revenueValues*

Select the income value.

The parameter is required if revenue=1.

Acceptable values:

  • 1: Below average.
  • 2: Average.
  • 3: Above average.

You can pass multiple values separated with a vertical line \| without spaces.

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.

* 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=banner&action=target&actionObject=targetingRevenue&objectID=2783648&revenue=1&revenueValues=1&isRedefined

Response:

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

Other actions with the object

See more actions with the banner object: