Для AI-агентов: markdown этой страницы — /docs-content/entities/crm-tracking/ad-account-list.md индекс документации — /llms.txt

Метод в процессе раскатки — выходит в обновлении crm 26.2100.0. Доступен не на всех порталах Битрикс24. Если на вашем портале метод ещё не доступен, API вернёт 422 METHOD_NOT_YET_AVAILABLE — это не ошибка интеграции, а признак того, что обновление пока не приехало на портал.

Получить список рекламных кабинетов

GET /v1/crm-tracking/sources/:id/ad-accounts

Получить доступные рекламные кабинеты источника сквозной аналитики перед подключением одного из них.

Нужны скоуп crm и флаг crm-tracking-v3. Ключи READONLY поддерживаются.

Параметры

Параметр Тип Обяз. Описание
Параметрid (path) Типnumber Обяз.да ОписаниеПоложительный целочисленный ID источника из списка источников.

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

Примеры

curl — личный ключ

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2/ad-accounts" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth-приложение

Terminal 
curl "https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2/ad-accounts" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — личный ключ

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2/ad-accounts', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})
const result = await res.json()
console.log(result)

JavaScript — OAuth-приложение

javascript 
const res = await fetch('https://vibecode.bitrix24.tech/v1/crm-tracking/sources/2/ad-accounts', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const result = await res.json()
console.log(result)

Поля ответа

Поле Тип Описание
Полеsuccess Типboolean Описаниеtrue при успехе.
Полеdata Типarray ОписаниеДоступные рекламные кабинеты.
Полеdata[].provider Типstring ОписаниеИдентификатор рекламного сервиса.
Полеdata[].clientId Типstring ОписаниеИдентификатор клиента для подключения рекламного кабинета.
Полеdata[].accountId Типstring or null ОписаниеИдентификатор кабинета для подключения; null, если не задан.
Полеdata[].name Типstring ОписаниеНазвание кабинета.
Полеdata[].capabilities Типobject ОписаниеПоддерживаемые рекламные операции.
Полеdata[].capabilities.import Типboolean ОписаниеПоддерживается ли загрузка расходов.
Полеdata[].capabilities.tree Типstring[] ОписаниеПоддерживаемые уровни дерева рекламы.
Полеdata[].isConnected Типboolean ОписаниеПодключён ли кабинет к этому источнику.

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

JSON 
{
  "success": true,
  "data": [
    {
      "provider": "google",
      "clientId": "DUMMY_CLIENT",
      "accountId": null,
      "name": "Campaign account",
      "capabilities": {
        "import": true,
        "tree": [
          "campaign"
        ]
      },
      "isConnected": true
    }
  ]
}

Пример ответа при ошибке

400 — источник не поддерживает рекламные кабинеты:

JSON 
{
  "success": false,
  "error": {
    "code": "CRM_TRACKING_AD_PROVIDER_UNSUPPORTED",
    "message": "CRM_TRACKING_AD_PROVIDER_UNSUPPORTED"
  }
}

Ошибки

HTTP Код Описание
HTTP400 КодCRM_TRACKING_AD_PROVIDER_UNSUPPORTED ОписаниеИсточник не поддерживает работу с рекламными кабинетами.
HTTP400 КодINVALID_PARAMS ОписаниеID в пути не является положительным безопасным целым числом или передано тело запроса.
HTTP400 КодUNKNOWN_FILTER_FIELD ОписаниеПередан неподдерживаемый параметр запроса.
HTTP404 КодENTITY_NOT_FOUND ОписаниеИсточник не найден или недоступен.
HTTP403 КодSCOPE_DENIED ОписаниеКлюч не имеет скоупа crm.
HTTP401 КодTOKEN_MISSING ОписаниеУ ключа нет настроенных токенов.
HTTP422 КодMETHOD_NOT_YET_AVAILABLE ОписаниеФлаг выключен или метод ещё не включён на портале Битрикс24. error.release — crm 26.2100.0.
HTTP502 КодBITRIX_UNAVAILABLE ОписаниеБитрикс24 вернул ответ неверного формата.

Остальные коды отказов Битрикс24, HTTP-статусы и сообщения сохраняются. Общие ошибки API: Ошибки.

Смотрите также