modify

Edit the action tracing point parameters.

Request format

https://adfox.yandex.com/api/v1
  ? object=tracingPoint
  & action=modify
  & objectID=<integer>
  & [advertiserID=<integer>]
  & [name=<string>]
  & [categoryID=<integer>]
  & [templateTypeID=<integer>]
  & [referrer=<string>]
  & [weight=<integer>]
  & [userID=<integer>]

objectID*

The ID of the object that the action is performed on.

advertiserID

The ID of the advertiser that the action tracing point must be added to.

Duplicate entry for key “advertiser_id_user_id” error means that the advertiser already has a point with this identifier (the IDentifier field, not to be confused with ID).

name

Object name. It can contain Russian and Latin letters, numbers, and any symbols.

categoryID

Temporary category ID.

See also:

templateTypeID

Template type ID. To learn more about template types, see referer templates.

Acceptable values:

  • 0: Standard.
  • 1: POSIX.2.

referrer

The URL template for comparing with the page address from the request. If the address doesn't match the URL template, the action tracing point loading isn't counted.

Example entry:

  • For the standard template:

    ⃰site.com/index.php

  • For POSIX.2:

    homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|
^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.
٭s$

It can contain Russian and Latin letters, numbers, and any symbols.

weight

The action tracing point weight. Used for building reports. For example, the weight is less for the landing page after clicking on the banner. For the checkout page, the weight is more, because the purpose of the campaign is to increase sales.

Acceptable values: 0≤N≤100, where N is the action point weight that determines its importance for achieving your ad goals.

userID

The user ID of the action tracing point.

* 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=tracingPoint&action=modify&objectID=3&name=topline_click&weight=100

Response:

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

Other actions with the object

See also other actions with the tracingPoint object:

The ID of the object that the action is performed on.

The ID of the advertiser that the action tracing point must be added to.

Duplicate entry for key “advertiser_id_user_id” error means that the advertiser already has a point with this identifier (the IDentifier field, not to be confused with ID).

Object name. It can contain Russian and Latin letters, numbers, and any symbols.

Temporary category ID.

See also:

Template type ID. To learn more about template types, see referer templates.

Acceptable values:

  • 0: Standard.

  • 1: POSIX.2.

The URL template for comparing with the page address from the request. If the address doesn't match the URL template, the action tracing point loading isn't counted.

Example entry:

  • For the standard template:

    ⃰site.com/index.php

  • For POSIX.2:

    homer-simpson-tv\.blog4ever\.com|forum\.rojadirecta\.org|^hidan\.eklablog\.com.٭|^aniworld\.spb\.ru\/.٭\/adfox\/.٭s$

It can contain Russian and Latin letters, numbers, and any symbols.

The action tracing point weight. Used for building reports. For example, the weight is less for the landing page after clicking on the banner. For the checkout page, the weight is more, because the purpose of the campaign is to increase sales.

Acceptable values: 0≤N≤100, where N is the action point weight that determines its importance for achieving your ad goals.

The user ID of the action tracing point.

Required

Previous
getCode
Next
userCriteria