targeting

Get summary information on targeting at the banner level.

Request format

https://adfox.yandex.com/api/v1
  ? object=banner
  & action=info
  & actionObject=targeting
  & objectID=<integer>

objectID*

ID of the object that the action is performed on.

* Required

Response format

<response>
<status>
   <code>{integer}</code>
</status>
<result>
<data>
  <row0>
    <title>{string}</title>
    <name>{string}</name>
    <isRedefined>{integer}</isRedefined>
    <description>{string}</description>
  </row0>
</data>
</result>
</response>

Response parameters

code

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

rows

Number of items in the response tree.

rowN

The item number in the response tree, where N is a number from 0 to rows-1 (where rows is the total number of items in the response).

title

Targeting name.

name

The targeting name in the database.

isRedefined

Redefine targeting at the banner level.

Acceptable values:

  • 0: Not redefined. The banner inherits targeting settings from a higher level (placement or campaign).
  • 1: Redefined. The banner uses targeting settings from the banner level. Settings at higher levels (placement and campaign) aren't taken into account for redefined targeting.

description

Targeting value.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=banner&action=info&actionObject=targeting&objectID=474205

Response:

<response>
<status>
  <code>0</code>
</status>
<result>
<data>
  <row0>
    <title>Frequency</title>
    <name>frequency</name>
    <isRedefined>0</isRedefined>
    <description>not set</description>
  </row0>
</data>
</result>
</response>

Other actions with the object

See more actions with the banner object:

ID of the object that the action is performed on.

Required

Previous
bannerFields
Next
banner