targetingURL
Target a campaign by URL.
This type of targeting is convenient if you need to show ads on a specific list of website pages or prohibit impressions on individual pages.
Request format
https://adfox.yandex.com/api/v1
? object=campaign
& action=target
& actionObject=targetingURL
& objectID=<integer>
& [templateType=<integer>]
& [targetingUrlOn[]=<string>]
& [targetingUrlOff[]=<string>]
|
|
ID of the object that the action is performed on. |
|
|
Template type for targeting by URL. Acceptable values:
Default value: |
|
|
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. Sample entry: |
|
|
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. Sample entry: |
* Required
Response format
<response>
<status>
<code>{integer}</code>
</status>
</response>
Response parameters
|
|
Request processing status. 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.ru/*&targetingUrlOff[]=https://www.demo.site.com/*Response:
<response> <status> <code>0</code> </status> </response>
Other actions with the object
See more actions with the campaign object:
- Add a campaign.
- Get a list of campaigns.
- Delete a campaign.
- Edit a campaign.
- Get a list of campaign banners.
- Place a campaign on a site, a site section, or a placement.
ID of the object that the action is performed on.
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.
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.
Sample entry:
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.
Sample entry:
targetingUrlOff[]=url1&targetingUrlOff[]=url2...
Required