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 the action applies to.

advertiserID

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

Duplicate entry for key «advertiser_id_user_id»

The advertiser already has an action point with this identifier (see the Identifier field; don't confuse 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

Page template type. For more information about template types, see Referer templates.

Acceptable values:

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

Default value: 0.

referrer

URL template to compare against the page address retrieved from the request. If the address doesn't match the URL template, the action 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 ad campaign is to increase sales.

Allowed values: 0≤N≤100, where N is the action point weight used to determine its importance for reaching ad goals.

userID

The custom ID of the action point.

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=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 custom ID of the action point.

ID of the object the action applies to.

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

Duplicate entry for key «advertiser_id_user_id»

The advertiser already has an action point with this identifier (see the Identifier field; don't confuse with ID).

Object name.

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

Temporary category ID.

Read also:

Page template type. For more information about template types, see Referer templates.

Acceptable values:

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

Default value: 0.

URL template to compare against the page address retrieved from the request. If the address doesn't match the URL template, the action 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 ad campaign is to increase sales.

Allowed values: 0≤N≤100, where N is the action point weight used to determine its importance for reaching ad goals.

Required parameter.

Previous
getCode
Next
userCriteria