modify

Edit site section parameters.

Request format

https://adfox.yandex.com/api/v1
  ? object=zone
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [categoryID=<integer>]
  & [isAutoReferer=<integer>]
  & [templateTypeID=<integer>]
  & [template=<string>]
  & [templateExcluded=<string>]

objectID*

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

name

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

categoryID

Category ID.

See also:

isAutoReferer

Dynamic definition of site section by referer.

Each banner request contains information about the page address (referer) that the request comes from.

If you enable this option, you can use the ad tag from the site level. Based on the referer field of the request, the system automatically determines the site section of the request.

If you disable this option, you must use ad tags from the placement level.

Acceptable values:

  • 0: Disabled.
  • 1: Enabled.

templateTypeID

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

Acceptable values:

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

template

Specify the page templates that will be used to check the received address in the banner request.

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.

templateExcluded

Page templates that must not belong to this site section.

Example entry:

  • For the standard template:

    http://٭website.com
    

    Addresses that use this template:

    http://website.com
    
    http://example.website.com
    
  • For POSIX.2:

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

    Addresses that use this template:

    homer-simpson-tv.blog4ever.com
    
    http://homer-simpson-tv.blog4ever.com/?a=1212
    
    forum.rojadirecta.org
    
    https://www.forum.rojadirecta.org/?b=123
    
    hidan.eklablog.com/?b=123
    
    aniworld.spb.ru/123/adfox/s
    

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

* 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=zone&action=modify&objectID=543&name=site.ru/news

Response:

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

Other actions with the object

See also other actions with the zone object:

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

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

Category ID.

See also:

Dynamic definition of site section by referer.

Each banner request contains information about the page address (referer) that the request comes from.

If you enable this option, you can use the ad tag from the site level. Based on the referer field of the request, the system automatically determines the site section of the request.

If you disable this option, you must use ad tags from the placement level.

Acceptable values:

  • 0: Disabled.

  • 1: Enabled.

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

Acceptable values:

  • 0: Standard.

  • 1: POSIX.2.

Specify the page templates that will be used to check the received address in the banner request.

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.

Page templates that must not belong to this site section.

Example entry:

  • For the standard template:

    http://٭website.com
    

    Addresses that use this template:

    http://website.com
    
    http://example.website.com
    
  • For POSIX.2:

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

    Addresses that use this template:

    homer-simpson-tv.blog4ever.com
    
    http://homer-simpson-tv.blog4ever.com/?a=1212
    
    forum.rojadirecta.org
    
    https://www.forum.rojadirecta.org/?b=123
    
    hidan.eklablog.com/?b=123
    
    aniworld.spb.ru/123/adfox/s
    

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

Required

Previous