Получение групп источников

Метод	get.sources_groups
Описание	Получение групп источников
Кому доступен	Агент, Клиент
Необходимые компоненты для работы с методом	Data API для настройки
Вес метода	1 балл

Параметры запроса

Название	Тип	Обязательный	Описание
access_token	string	да	Ключ сессии аутентификации
user_id	number	нет	Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
limit	number	нет	Количество возвращаемых записей. См. раздел "Постраничный вывод"
offset	number	нет	Сдвиг - определяет с какого номера записи возвращать "limit" записей. По умолчанию "0". См. раздел "Постраничный вывод"
filter	object	нет	См. раздел "Критерии фильтрации"
fields	array	нет	См. раздел "Представление возвращаемых данных"
sort	array	нет	См. раздел "Сортировка данных"

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Ответ по умолчанию	Описание
id	number		да	да	да	Уникальный идентификатор группы источника
name	string		да	да	да	Название группы источника
channel_id	number		да	да	да	Идентификатор канала группы источников
channel_name	string		да	да	да	Название канала группы источников
channel_mnemonic	string		да	да	да	Мнемоника канала группы источников
is_custom	boolean		да	да	да	Создана ли группа пользователем клиента
state	enum	active Группа активена off Группа отключена removed Группа удалена	да	да	да	Статус источника источника

JSON структура запроса

{
    "jsonrpc":"2.0",
    "id":"number",
    "method":"get.sources_groups",
    "params":{
        "access_token":"string",
        "user_id":"number",
        "offset":"number",
        "limit":"number",
        "filter":{

        },
        "sort":[
        {
        "field":"string",
        "order":"string"
        }
        ],
        "fields":[
        "string"
        ]
    }
}

JSON структура ответа

{
    "jsonrpc": "2.0",
    "id": "number",
    "result": {
        "metadata": {

        },
        "data": [
            {
            "id": "number",
            "name": "string",
            "channel_id": "number",
            "channel_name": "string",
            "channel_mnemonic": "string",
            "is_custom": "boolean"
            }
        ]
    }
}

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

{
    "jsonrpc": "2.0",
    "id": "HXw4IeLYAfblv6FRkzRNd",
    "result": {
        "data": [
            {
                "id": -3,
                "name": "Bing Ads",
                "is_custom": false,
                "channel_id": -1,
                "channel_name": "Контекстная реклама",
                "channel_mnemonic": "context"
            },
            {
                "id": -1,
                "name": "Google Ads",
                "is_custom": false,
                "channel_id": -1,
                "channel_name": "Контекстная реклама",
                "channel_mnemonic": "context"
            },
            {
                "id": -4,
                "name": "Бегун",
                "is_custom": false,
                "channel_id": -1,
                "channel_name": "Контекстная реклама",
                "channel_mnemonic": "context"
            },
            {
                "id": -2,
                "name": "Яндекс.Директ",
                "is_custom": false,
                "channel_id": -1,
                "channel_name": "Контекстная реклама",
                "channel_mnemonic": "context"
            }
        ],
        "metadata": {
            "total_items": 4,
            "version": null,
            "limits": {}
        }
    }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"