Доступ

Для доступа к API необходим аккаунт в Adfox или связанный с ним аккаунт на Яндексе. Авторизация происходит при каждом запросе: нужно передавать OAuth-токен, сгенерированный для аккаунта на Яндексе.

Регистрация аккаунта в Adfox

Для регистрации аккаунта в Adfox вам потребуется аккаунт на Яндексе. Эти аккаунты будут связаны. После регистрации вы получите доступ не только к API Adfox, но и к веб-интерфейсам Adfox и Рекламной сети Яндекса.

У меня есть аккаунт на Яндексе

Войдите c Яндекс ID.

Примечание

Мы рекомендуем выбрать аккаунт, который не используется для работы с другими сервисами Яндекса (например, Яндекс Директом или Яндекс Маркетом). Также не стоит использовать личный аккаунт, поскольку мы будем отправлять вам документы и важные уведомления.

У меня нет аккаунта на Яндексе

Доступ к API для разных типов пользователей

При регистрации аккаунта в Adfox пользователю выдается доступ на уровне администратора. На одном аккаунте может быть только один администратор.

Администратор имеет полный набор прав по управлению рекламой и настройкой аккаунта, как в веб-интерфейсе, так и в API. Администратор делегирует часть прав другим пользователям, назначая им следующие роли:

  • Ассистент — имеет тот набор прав по управлению рекламой, который ему разрешит администратор в настройках пользователя. Не имеет прав по настройке аккаунта.

  • Ассистент API — имеет набор прав, указанных для него администратором аккаунта. Подробнее о правах и доступах к методам смотрите таблицу.

  • Рекламодатель — имеет права только по получению отчетов по собственным рекламным кампаниям.

  • Владелец сайта — имеет доступ в API только к методу получения списка баннеров.

Права доступа для ассистентов API

С помощью ассистентов API можно предоставить сотрудникам доступ к API Adfox с определенным набором прав:

  • RO — только чтение данных: получение списков (действия list, utility, info, listActiveBanners, listValues), получение отчетов (report);

  • RW — работа с объектами (добавление, редактирование, удаление): настройки аккаунта, сайтов, кампаний, баннеров. Запрещены только действия с пользователями (advertiser, assistant, webmaster);

  • RW + manage users — полный доступ к аккаунту.

Создавать и управлять ассистентами API может только администратор аккаунта из веб-интерфейса.

Контекст (object)

Действие (action)

Имя объекта действия (actionObject)

RO

RW

RW + MU

account

add

advertiser

-

-

+

assistant

-

-

+

banner

-

+

+

bannerType

-

+

+

campaign

-

+

+

category

-

+

+

place

-

+

+

position

-

+

+

superCampaign

-

+

+

tracingPoint

-

+

+

webmaster

-

-

+

website

-

+

+

zone

-

+

+

delete

assistant

-

-

+

banner

-

+

+

bannerType

-

+

+

campaign

-

+

+

category

-

+

+

place

-

+

+

position

-

+

+

superCampaign

-

+

+

template

-

+

+

tracingPoint

-

+

+

user

-

-

+

website

-

+

+

zone

-

+

+

list

+

+

+

modify

-

+

+

report

+

+

+

changePassword

-

-

+

auth

+

+

+

utility

+

+

+

advertiser

modify

-

-

+

assistant

modify

-

-

+

banner

info

+

+

+

modify

-

+

+

target

-

+

+

bannerType

list

+

+

+

modify

-

+

+

updateDefaultBanner

-

+

+

campaign

additionalUsers

-

+

+

clone

-

+

+

info

+

+

+

list

+

+

+

modify

-

+

+

placing

-

+

+

target (targetPlace, targetWebsite, targetZone)

-

+

+

upload

-

+

+

placement

info

+

+

+

position

modify

-

+

+

place

info

+

+

+

listActiveBanners

+

+

+

modify

-

+

+

updateDefaultBanner

-

+

+

superCampaign

additionalUsers

-

+

+

modify

-

+

+

tracingPoint

getCode

+

+

+

modify

-

+

+

userCriteria

addValue

-

+

+

listValues

+

+

+

modify

-

+

+

modifyValue

-

+

+

removeValue

-

+

+

webmaster

info

+

+

+

modify

-

-

+

website

modify

-

+

+

zone

modify

-

+

+

Предыдущая