website

Добавить сайт.

Формат запроса

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

`name`*	Название объекта. Может содержать русские и латинские буквы, цифры и любые символы.
`webmasterID`	ID владельца сайта. Владельцу сайта предоставляется доступ только к статистике по сайту. Читайте также: создать владельца сайта; получить списка владельцев сайтов.
`categoryID`	ID категории. Читайте также: добавить категорию; получить список категорий.
`sendToErir`	Передавать данные в ЕРИР. Допустимые значения: `0` — не передавать данные в ЕРИР. Остальные поля для маркировки рекламы игнорируются. `1` — передавать данные в ЕРИР (маркировка включена). В этом случае обязательны для заполнения поля `platformName` и`platformType`. Значение по умолчанию: `0`.
`platformName`	Название площадки. Параметр для маркировки рекламы. Обязателен, если `sendToErir=1`.
`platformType`	Тип площадки. Параметр для маркировки рекламы. Обязателен, если `sendToErir=1`. Допустимые значения: `0` — приложение; `1` — сайт; `2` — информационная система (не используется, deprecated); `3` — Smart TV; `4` — HbbTV. Если `platformType=0` или `platfromType=1`, поле `url` обязательно для заполнения.
`contractorID`	ID контрагента. Параметр для маркировки рекламы.
`url`	Домен сайта или видеоресурса, URL блога или ссылка для скачивания приложения. Параметр для маркировки рекламы. Требования к параметру `url`: URL начинается с протокола http или https; путь не должен содержать `punycode` или `urlencode`. Поле `url` обязательно для заполнения, если `platformType=0` или `platfromType=1`.

* Обязательный параметр

Формат ответа

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

Параметры ответа

`code`	Статус обработки запроса. Значение `0` — запрос выполнен успешно. Расшифровку смотрите в разделе Обработка ошибок.
`ID`	Идентификатор созданного объекта.

Пример запроса и ответа

Полный запрос

Короткий запрос

Запрос:

https://adfox.yandex.ru/api/v1?object=account&action=add&actionObject=website&name=Сайт&webmasterID=457&categoryID=3&platformName=Площадка&platformType=1&contractorID=123&url=https://url.ru

Ответ:

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

Запрос:

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

Ответ:

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

Другие действия с объектом

Читайте также о других действиях с объектом website:

Была ли статья полезна?

webmaster

zone