website

Add a website.

Request format

https://adfox.yandex.com/api/v1
  ? object=account
  & action=add
  & actionObject=website
  & name=<string>
  & [webmasterID=<integer>]
  & [categoryID=<integer>]
  & [platformName=<string>]
  & [platformType=<integer>]
  & [contractorID=<integer>]
  & [url=<string>]

name*

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

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.

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

Default value: 0.

platformName

Platform name. A parameter for ad register.

platformType

Platform type. A parameter for ad register.

Acceptable values:

  • 0: App.
  • 1: Website.
  • 2: Information system.

contractorID

Contractor ID. A parameter for ad register.

url

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

* Required

Response format

<response>
<status>
  <code>{integer}</code>
  <ID>{integer}</ID>
</status>
</response>

Response parameters

code

Request processing status. If the value is 0, the request was completed successfully. For the key, see Error handling.

ID

Object ID.

Sample request and response

Request:

https://adfox.yandex.com/api/v1?object=account&action=add&actionObject=website&name=Site&webmasterID=457&categoryID=3&platformName=Placement&platformType=1&contractorID=123&url=https://url.com

Response:

<response>
<status>
  <code>0</code>
  <ID>456789</ID>
</status>
</response>

Request:

https://adfox.yandex.com/api/v1?object=account&action=add&actionObject=website&name=site.com

Response:

<response>
<status>
  <code>0</code>
  <ID>456789</ID>
</status>
</response>

Other actions with the object

See more actions with the website object:

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

Required

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

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

See also:

Category ID.

See also:

Platform name. A parameter for ad register.

Platform type. A parameter for ad register.

Acceptable values:

  • 0: App.

  • 1: Website.

  • 2: Information system.

Contractor ID. A parameter for ad register.

Previous
Next