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*

ID of the object the action applies to.

name

Object name.

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

categoryID

Category ID.

Read also:

isAutoReferer

Dynamic definition of a 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. The system will automatically match the ad request to a site section based on its referer header. If you disable this option, you must use ad tags from the placement level.

Acceptable values:

  • 0: disabled.
  • 1: enabled.

Default value: 1.

templateTypeID

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

Acceptable values:

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

Default value: 0.

template

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

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

templateExcluded

Page templates that must not belong to this site section.

Example
  • For the standard template:

    http://٭site.com
    

    Addresses that use this template: http://site.com, http://example.site.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

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

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

Response:

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

Other actions with the object

Read about other actions with the zone object:

ID of the object the action applies to.

Object name.

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

Category ID.

Read also:

Dynamic definition of a 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. The system will automatically match the ad request to a site section based on its referer header. If you disable this option, you must use ad tags from the placement level.

Acceptable values:

  • 0: disabled.
  • 1: enabled.

Default value: 1.

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

Acceptable values:

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

Default value: 0.

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

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

Page templates that must not belong to this site section.

Example
  • For the standard template:

    http://٭site.com
    

    Addresses that use this template: http://site.com, http://example.site.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

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

Required parameter.

Previous