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*

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.

Error Duplicate entry for key “advertiser_id_user_id”

Advertiser already has a point with this identifier (the Identifier field, not to be confused with ID).

name

Object name.

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

categoryID

Temporary category ID.

Read also:

templateTypeID

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

Acceptable values:

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

Default value: 0.

referrer

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

  • 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$

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

weight

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.

userID

The user ID of the action tracing point.

Response format

<response>
  <status>
    <code>{integer}</code>
  </status>
</response>

Response parameters

code

Request processing status. If the value is 0, the request was completed successfully. 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 more actions with the tracingPoint object:

The user ID of the action tracing point.

ID of the object that the action is performed on.

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

Error Duplicate entry for key “advertiser_id_user_id”

Advertiser already has a point with this identifier (the Identifier field, not to be confused with ID).

Object name.

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

Temporary category ID.

Read also:

Template type ID. 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

  • 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$

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: 0≤N≤100, where N is the action tracing point weight that determines its importance for achieving your ad goals.

Required parameter.

Previous
getCode
Next
userCriteria