targetingURL

Target a campaign by URL.

This type of targeting is convenient if you need to show ads on specific site pages or prohibit impressions on certain pages.

Request format

https://adfox.yandex.com/api/v1
  ? object=campaign
  & action=target
  & actionObject=targetingURL
  & objectID=<integer>
  & [templateType=<integer>]
  & [targetingUrlOn[]=<string>]
  & [targetingUrlOff[]=<string>]

objectID*

ID of the object the action applies to.

templateType

Template type for targeting by URL.

Acceptable values:

  • 0: Standard. In the URL template, use the * symbol for a sequence of any characters of any length.
  • 1: POSIX. In the URL template, use regular expressions according to the POSIX standard.

Default value: 0.

targetingUrlOn[]

The URL of the page where ad serving is allowed.

If there are multiple URLs, every URL must be passed in a separate parameter. The maximum number of parameters with a URL is 5.

Example
targetingUrlOn[]=url1&targetingUrlOn[]=url2...

targetingUrlOff[]

URL of the page where ad serving is prohibited.

If there are multiple URLs, every URL must be passed in a separate parameter. The maximum number of parameters with a URL is 5.

Example
targetingUrlOff[]=url1&targetingUrlOff[]=url2...

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=campaign&action=target&actionObject=targetingURL&objectID=474205&templateType=0&targetingUrlOn[]=*site.com/&targetingUrlOn[]=*site.com/*&targetingUrlOff[]=https://www.demo.site.com/*

Response:

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

Other actions with the object

Read more about other actions with the campaign object:

ID of the object the action applies to.

Template type for targeting by URL.

Acceptable values:

  • 0: Standard. In the URL template, use the * symbol for a sequence of any characters of any length.
  • 1: POSIX. In the URL template, use regular expressions according to the POSIX standard.

Default value: 0.

The URL of the page where ad serving is allowed.

If there are multiple URLs, every URL must be passed in a separate parameter. The maximum number of parameters with a URL is 5.

Example
targetingUrlOn[]=url1&targetingUrlOn[]=url2...

URL of the page where ad serving is prohibited.

If there are multiple URLs, every URL must be passed in a separate parameter. The maximum number of parameters with a URL is 5.

Example
targetingUrlOff[]=url1&targetingUrlOff[]=url2...

Required parameter.

Previous
targetingTime
Next
targetingUser