modify

Редактировать параметры сайта.

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

https://adfox.yandex.ru/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 объекта, над которым производится действие.

name

Название объекта.

Может содержать русские и латинские буквы, цифры и любые символы.

webmasterID

ID владельца сайта. Владельцу сайта предоставляется доступ только к статистике по сайту.

Читайте также:

categoryID

ID категории.

Читайте также:

sendToErir

Передавать данные в ЕРИР.

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

  • 0 — не передавать данные в ЕРИР. Остальные поля для маркировки рекламы игнорируются.
  • 1 — передавать данные в ЕРИР (маркировка включена). В этом случае обязательны для заполнения поля platformName иplatformType.

Примечание

  • При изменении значения параметра с 0 на 1 объект отправляется в ЕРИР.

  • При изменении значения параметра с 1 на 0 маркировка в Adfox отключается, производится повторная отправка объекта в ОРД (оператору рекламных данных) с признаком неактуальности.

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>
</status>
</response>

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

code

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

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

Запрос:

https://adfox.yandex.ru/api/v1?object=website&action=modify&objectID=543&name=site.ru

Ответ:

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

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

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

ID объекта, над которым производится действие.

Название объекта.

Может содержать русские и латинские буквы, цифры и любые символы.

ID владельца сайта. Владельцу сайта предоставляется доступ только к статистике по сайту.

Читайте также:

ID категории.

Читайте также:

Передавать данные в ЕРИР.

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

  • 0 — не передавать данные в ЕРИР. Остальные поля для маркировки рекламы игнорируются.
  • 1 — передавать данные в ЕРИР (маркировка включена). В этом случае обязательны для заполнения поля platformName иplatformType.

Примечание

  • При изменении значения параметра с 0 на 1 объект отправляется в ЕРИР.

  • При изменении значения параметра с 1 на 0 маркировка в Adfox отключается, производится повторная отправка объекта в ОРД (оператору рекламных данных) с признаком неактуальности.

Название площадки. Параметр для маркировки рекламы. Обязателен, если sendToErir=1.

Примечание

Изменение параметра приведет к отправке в ЕРИР на проверку сайта и всех связанных с ним контрагентов.

Тип площадки. Параметр для маркировки рекламы. Обязателен, если sendToErir=1.

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

  • 0 — приложение;
  • 1 — сайт;
  • 2 — информационная система (не используется, deprecated);
  • 3 — Smart TV;
  • 4 — HbbTV.

Если platformType=0 или platfromType=1, поле url обязательно для заполнения.

Примечание

Изменение параметра приведет к отправке в ЕРИР на проверку сайта и всех связанных с ним контрагентов.

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

Примечание

Изменение параметра приведет к отправке в ЕРИР на проверку сайта и всех связанных с ним контрагентов.

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

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

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

Поле url обязательно для заполнения, если platformType=0 или platfromType=1.

Примечание

Изменение параметра приведет к отправке в ЕРИР на проверку сайта и всех связанных с ним контрагентов.

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

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