Получить список рекламодателей с учетом фильтров

Возвращает список рекламодателей с учетом пользовательских значений offset и limit.

Request

GET

https://api.media.metrika.yandex.net/v1/management/advertisers_list

Query parameters

Name	Description
campaign_status	Type: string Статус кампании. Enum: `active`, `archived`
filter	Type: string Фильтр рекламодателей по идентификатору и названию.
limit	Type: integer<int32> Количество строк, которое нужно вывести.
offset	Type: integer<int32> Количество строк, которое нужно пропустить перед тем, как начать возвращать строки.
only_own	Type: boolean Возвращать только рекламодателей, которыми владеет пользователь, или всех рекламодателей, к которым есть доступ`true` — только рекламодатели, которыми владеет пользователь. `false` — все доступные рекламодатели.
reversed	Type: boolean Обратный порядок элементов выборки.

Responses

200 OK

Body

application/json

{
    "advertisers": [
        {
            "advertiser_id": 0,
            "name": "string",
            "permission": "own",
            "grants": [
                {
                    "user_login": "string",
                    "created_at": "2022-12-29T18:02:01Z",
                    "comment": "string",
                    "permission": "edit"
                }
            ],
            "create_time": "string",
            "owner": "string",
            "counters": [
                {
                    "counter_id": 0,
                    "name": "string",
                    "site": "string",
                    "owner_login": "string",
                    "permission": "edit",
                    "favorite": false
                }
            ],
            "active_campaigns_cnt": 0,
            "archived_campaigns_cnt": 0,
            "goals_cnt": 0,
            "landings_cnt": 0
        }
    ],
    "total": 0
}

Name

Description

advertisers

Type: AdvertiserInfo[]

Информация о рекламодателях.

total

Type: integer<int32>

Количество рекламодателей

AdvertiserInfo

Name	Description
active_campaigns_cnt	Type: integer<int32> Количество активных кампаний.
advertiser_id	Type: integer<int32> Идентификатор рекламодателя.
archived_campaigns_cnt	Type: integer<int32> Количество архивированных кампаний.
counters	Type: CounterIdEnhanced[] Информация о счетчиках, к которым привязаны рекламные кампании рекламодателя. Min items: `0` Max items: `100`
create_time	Type: string Время создания рекламодателя.
goals_cnt	Type: integer<int32> Количество целей.
grants	Type: grant[] Разрешения на управление рекламодателем и просмотр статистики.
landings_cnt	Type: integer<int32> Количество посадочных страниц.
name	Type: string Название рекламодателя. Min length: `1` Max length: `256`
owner	Type: string Логин пользователя, имеющего доступ владельца рекламодателя.
permission	Type: string Уровень доступа. Enum: `own`, `view`, `edit`

CounterIdEnhanced

Информация о счетчиках, к которым привязаны рекламные кампании рекламодателя.

Name	Description
counter_id	Type: integer<int32> Идентификатор счетчика.
favorite	Type: boolean Добавлен ли счетчик в избранное.
name	Type: string Название счетчика.
owner_login	Type: string Логин владельца счетчика.
permission	Type: string Уровень доступа к счетчику. Enum: `edit`, `view`, `view_access_filter`
site	Type: string Сайт, на котором установлен счетчик.

grant

Разрешения на управление рекламодателем и просмотр статистики.

Name	Description
user_login*	Type: string Логин пользователя, которому выдано разрешение на управление сегментом.
comment	Type: string Произвольный комментарий. Количество символов не должно превышать 255. Min length: `0` Max length: `255`
created_at	Type: string<date-time> Дата предоставления доступа в формате YYYY-MM-DD'T'hh:mm:ssZ.
permission	Type: string Уровень доступа. Enum: `edit`, `view`

Была ли статья полезна?

Создать нового рекламодателя

Получить информацию о рекламодателе