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. Поле url обязательно для заполнения, если platformType=0 или platfromType=1.

Значение по умолчанию: 0.

platformName

Название площадки. Параметр для маркировки рекламы.

platformType

Тип площадки. Параметр для маркировки рекламы.

Допустимые значения:

  • 0 — приложение;
  • 1 — сайт;
  • 2 — информационная система.

contractorID

ID контрагента. Параметр для маркировки рекламы.

url

Домен сайта или видеоресурса, URL блога или ссылка для скачивания приложения. Параметр для маркировки рекламы.

Требования к параметру url:

  • URL начинается с протокола http или https;
  • путь не должен содержать punycode или urlencode.

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

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

<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:

Предыдущая
Следующая