modify

Edit website parameters.

Request format

https://adfox.yandex.com/api/v1
  ? object=website
  & action=modify
  & objectID=<integer>
  & [name=<string>]
  & [webmasterID=<integer>]
  & [categoryID=<integer>]
  & [sendToErir=<integer>]
  & [platformName=<string>]
  & [platformType=<integer>]
  & [contractorID=<integer>]
  & [url=<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.

webmasterID

Website owner ID. The website owner is only allowed access to website statistics.

See also:

categoryID

Category ID.

See also:

sendToErir

Submit data to the Russian state register.

Acceptable values:

  • 0: Don't submit data to the Russian state register. The other fields for the ad register are ignored.

  • 1: Submit data to the Russian state register (ad register is enabled). In this case platformName and platformType fields are required.

    • When the parameter changes from 0 to 1, the object is submitted to the state register.

    • When the parameter changes from 1 to 0, ad labeling is disabled in Adfox. The object is then resent to the ADO (advertising data operator) with a flag indicating it's no longer relevant.

platformName

Platform name. A parameter for ad register. Required if sendToErir=1.

Note

Changing the parameter submits the site and all related counterparties to the stage register for a review.

platformType

Platform type. A parameter for ad register. Required if sendToErir=1.

Acceptable values:

  • 0: App.
  • 1: Website.
  • 2: Information system (not used, deprecated).
  • 3: Smart TV.
  • 4: HbbTV.

The url field is required, if platformType=0 or platformType=1.

Note

Changing the parameter submits the site and all related counterparties to the stage register for a review.

contractorID

Contractor ID. A parameter for ad register.

Note

Changing the parameter submits the site and all related counterparties to the stage register for a review.

url

Website or video resource domain, a blog URL, or a link for downloading an app. A parameter for ad register.

The url field is required, if platformType=0 or platformType=1.

Note

Changing the parameter submits the site and all related counterparties to the stage register for a review.

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=website&action=modify&objectID=543&name=site.com

Response:

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

Other actions with the object

See also other actions with the website 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.

Website owner ID. The website owner is only allowed access to website statistics.

See also:

Category ID.

See also:

Submit data to the Russian state register.

Acceptable values:

  • 0: Don't submit data to the Russian state register. The other fields for the ad register are ignored.

  • 1: Submit data to the Russian state register (ad register is enabled). In this case platformName and platformType fields are required.

  • When the parameter changes from 0 to 1, the object is submitted to the state register.

  • When the parameter changes from 1 to 0, ad labeling is disabled in Adfox. The object is then resent to the ADO (advertising data operator) with a flag indicating it's no longer relevant.

Platform name. A parameter for ad register. Required if sendToErir=1.

Note

Changing the parameter submits the site and all related counterparties to the stage register for a review.

Platform type. A parameter for ad register. Required if sendToErir=1.

Acceptable values:

  • 0: App.

  • 1: Website.

  • 2: Information system (not used, deprecated).

  • 3: Smart TV.

  • 4: HbbTV.

The url field is required, if platformType=0 or platformType=1.

Changing the parameter submits the site and all related counterparties to the stage register for a review.

Contractor ID. A parameter for ad register.

Note

Changing the parameter submits the site and all related counterparties to the stage register for a review.

Website or video resource domain, a blog URL, or a link for downloading an app. A parameter for ad register.

The url field is required, if platformType=0 or platformType=1.

Changing the parameter submits the site and all related counterparties to the stage register for a review.

Required parameter.

Previous
website
Next
zone