modify

Edit site 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*

ID of the object the action applies to.

name

Object name.

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

webmasterID

Site owner ID. The site owner is only allowed access to site statistics.

Read also:

categoryID

Category ID.

Read also:

sendToErir

Submit data to the state register (ERIR).

Acceptable values:

  • 0: Do not submit data to the state register. All other ad labeling fields are ignored.
  • 1: Submit data to state register (labeling enabled). In this case, the platformName and platformType fields are required.

Note

  • 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

Placement name. Ad labeling parameter. Required if sendToErir=1.

Note

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

platformType

Placement type. Ad labeling parameter. Required if sendToErir=1.

Acceptable values:

  • 0: App.
  • 1: Site.
  • 2: Information system (no longer used, deprecated).
  • 3: Smart TV.
  • 4: HbbTV.

If platformType=0 or platfromType=1, the url field is required.

Note

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

contractorID

Counterparty ID. Ad labeling parameter.

Note

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

url

Website or video resource domain, blog URL, or app download link. Ad labeling parameter.

Requirements for url values:

  • The URL must start with the http or https protocol.
  • The path must not contain punycode or urlencode.

The url field is required if platformType=0 or platfromType=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. 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=website&action=modify&objectID=543&name=site.com

Response:

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

Other actions with the object

Read about other actions with the website object:

ID of the object the action applies to.

Object name.

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

Site owner ID. The site owner is only allowed access to site statistics.

Read also:

Category ID.

Read also:

Submit data to the state register (ERIR).

Acceptable values:

  • 0: Do not submit data to the state register. All other ad labeling fields are ignored.
  • 1: Submit data to state register (labeling enabled). In this case, the platformName and platformType fields are required.

Note

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

Placement name. Ad labeling parameter. Required if sendToErir=1.

Note

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

Placement type. Ad labeling parameter. Required if sendToErir=1.

Acceptable values:

  • 0: App.
  • 1: Site.
  • 2: Information system (no longer used, deprecated).
  • 3: Smart TV.
  • 4: HbbTV.

If platformType=0 or platfromType=1, the url field is required.

Note

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

Counterparty ID. Ad labeling parameter.

Note

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

Website or video resource domain, blog URL, or app download link. Ad labeling parameter.

Requirements for url values:

  • The URL must start with the http or https protocol.
  • The path must not contain punycode or urlencode.

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

Note

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

Required parameter.

Previous
website
Next
zone