targetingKeywords

Target a banner by keywords or phrases.

You can use targeting by keywords or phrases to send words or phrases in the banner request and use them to target campaigns and banners. Keyword targeting is helpful when the list of keywords isn't known in advance. For example, search queries entered on a website can be used as keywords.

Request format

https://adfox.yandex.com/api/v1
  ? object=banner
  & action=target
  & actionObject=targetingKeywords
  & objectID=<integer>
  & isRedefined=<integer>
  & [keywordsLogic=<integer>]
  & [keywords=<string>]
  & [keywordsNotAllowed=<string>]

objectID*

ID of the object that the action is performed on.

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.

keywordsLogic

Targeting method.

Acceptable values:

  • 0: by keywords.
  • 1: by phrases.

Default value: 0.

keywords

Specify keywords or phrase for targeting the object.

You can't target by both phrases and specific keywords at the same time.

Entry format:

  • Use a comma to separate phrases.
  • Use a space or comma to separate keywords.

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

keywordsNotAllowed

A keyword or words that can't be used in the banner request for serving the banner.

Entry format:

  • Use a comma to separate phrases.
  • Use a space or comma to separate keywords.

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

* 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=targetingKeywords&objectID=474205&isRedefined=1

Response:

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

Other actions with the object

See more actions with the banner object:

A keyword or words that can't be used in the banner request for serving the banner.

Entry format:

  • Use a comma to separate phrases.

  • Use a space or comma to separate keywords.

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

Required

ID of the object that the action is performed on.

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.

Targeting method.

Acceptable values:

  • 0: by keywords.

  • 1: by phrases.

Default value: 0.

Specify keywords or phrase for targeting the object.

You can't target by both phrases and specific keywords at the same time.

Entry format:

  • Use a comma to separate phrases.

  • Use a space or comma to separate keywords.

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

Previous
targetingGeobase
Next
targetingLogic