tracingPoint
Add action tracing points. Action tracing points are used to track the behavior of users who interacted with the advertiser's ads on the advertiser's website. Action tracing points can also be used to label audience in order to show certain campaigns to this audience in the future.
Request format
https://adfox.yandex.com/api/v1
? object=account
& action=add
& actionObject=tracingPoint
& name=<string>
& advertiserID=<integer>
& [categoryID=<integer>]
& [templateTypeID=<integer>]
& [referrer=<string>]
& [weight=<integer>]
|
|
Object name. An entry can contain Russian and Latin letters, numbers, and any special characters. |
|
|
ID of the advertiser to whom the action tracing point will belong. See also: |
|
|
ID of the category to which the audience that interacts with the action tracing point will be labeled into. Acceptable values:
Default value: |
|
|
Page template type. To learn more about template types, see Referer templates. Acceptable values:
Default value: |
|
|
URL template for comparing with the site page address from the request. If the address doesn't match the URL template, the action tracing point loading isn't counted. Sample entry:
An entry can contain Russian and Latin letters, numbers, and any special characters. |
|
|
Action point weight. Used for building reports. For example, going to the landing page after clicking on the banner has less weight than going to the checkout page, which has more weight because the purpose of the campaign is to increase sales. Acceptable values:
|
* Required
Response format
<response>
<status>
<code>{integer}</code>
<ID>{integer}</ID>
</status>
</response>
Response parameters
|
|
Request processing status. If the value is |
|
|
Object ID. |
Sample request and response
Request:
https://adfox.yandex.com/api/v1?object=account&action=add&actionObject=tracingPoint&name=avto&advertiserID=3&weight=1Response:
<response> <status> <code>0</code> <ID>4</ID> </status> </response>
Other actions with the object
See more actions with the tracingPoint and advertiser objects:
- Add an advertiser.
- Get a list of advertisers.
- Edit an action tracing point.
- Get an ad tag for the action tracing point.
Action point weight. Used for building reports. For example, going to the landing page after clicking on the banner has less weight than going to the checkout page, which has more weight because the purpose of the campaign is to increase sales.
Acceptable values:
0≤N≤100, where N is the action tracing point weight that determines its importance for achieving your ad goals.
Required
Object name. An entry can contain Russian and Latin letters, numbers, and any special characters.
ID of the advertiser to whom the action tracing point will belong.
See also:
ID of the category to which the audience that interacts with the action tracing point will be labeled into.
Acceptable values:
-
0: Category not specified. -
N: Category ID.
Default value: 0.
Page template type. To learn more about template types, see Referer templates.
Acceptable values:
-
0: Standard. -
1: POSIX.2.
Default value: 0.
URL template for comparing with the site page address from the request. If the address doesn't match the URL template, the action tracing point loading isn't counted.
Sample entry:
-
For the standard template:
-
For POSIX.2:
An entry can contain Russian and Latin letters, numbers, and any special characters.