AdPump — Агентский API: AgencyClients, Client-Login, Use-Operator-Units

Агентский API — управление множеством клиентских аккаунтов через один OAuth-токен.

Коротко: agencyclients; Client-Login; Use-Operator-Units: true.

← Каталог API Директа · Введение · Версии API · OAuth и доступ · Сервисы v5 · Лимиты и баллы · Ограничения · Кампании · Группы и объявления · Ключи и ставки · Минус-фразы и площадки · Отчёты · Песочница · Примеры JSON · Ошибки · Автоматизация · Документация Яндекса

Содержание

AgencyClients
Client-Login
Use-Operator-Units
Workflow
Ограничения

agencyclients — список клиентов

POST https://api.direct.yandex.com/json/v5/agencyclients

Authorization: Bearer <agency_token>

Accept-Language: ru

{

  "method": "get",

  "params": {

    "SelectionCriteria": {"Archived": "NO"},

    "FieldNames": ["Login", "ClientId", "Archived", "Grants"]

  }

}

agencyclients.get — список клиентов агентства. Документация.

Важно: AgencyClients.add — создание новых клиентов только через UI кабинета (Ограничения).

Client-Login — выбор клиента

Authorization: Bearer <agency_token>

Client-Login: client-company-login

Use-Operator-Units: true

Accept-Language: ru

Без Client-Login запрос выполняется от имени агентства, а не клиента — ошибка 54.

Use-Operator-Units

Заголовок Use-Operator-Units: true — списание баллов с квоты агентства, а не клиента. Рекомендуется для агентских интеграций.

true — баллы с агентства.
Без заголовка или false — с квоты клиента.

Workflow для агентства

agencyclients.get — получить список клиентов и их Login.
Для каждого клиента — запросы с Client-Login: <login>.
clients.get — проверка баланса клиента.
campaigns.get / Reports — статистика по клиенту.
Управление кампаниями — с тем же Client-Login.

Ограничения агентского API

Один токен — много клиентов, но каждый запрос — с правильным Client-Login.
Лимит 5 параллельных запросов — на всё приложение (Лимиты).
Нельзя создавать клиентов через API.

Перейти в инструмент