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

Info

Console

Request

GET

https://partner.yandex.ru/api/mobile/adunit

Partner API

Query parameters

Name

Description

filter

Type: MobileAdUnitFilter

Параметры фильтрации мобильных блоков

pageable

Type: Pageable

Параметры постраничного вывода

MobileAdUnitFilter

Параметры фильтрации мобильных блоков

Name

Description

appIds

Type: integer<int64>[]

Идентификаторы приложений, на которых ищем блоки

Unique items: true

status

Type: AdUnitStatus[]

Статусы искомых блоков

Enum: UNKNOWN, ENABLED, ARCHIVED

Default: ENABLED

Unique items: true

Pageable

Параметры постраничного вывода

Name

Description

page

Type: integer<int32>

Номер страницы (zero-based)

Default: 0

Min value: 0

size

Type: integer<int32>

Размер страницы

Default: 20

Min value: 1

Max value: 100

AdUnitStatus

Type	Description
AdUnitStatus	Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`

Responses

200 OK

Body

application/json

{
    "data": [
        {
            "applicationId": 0,
            "caption": "string",
            "createDate": "2022-12-29T18:02:01Z",
            "editable": false,
            "id": "string",
            "status": "UNKNOWN",
            "strategy": {
                "type": "string"
            },
            "type": "string"
        },
        {
            "applicationId": 0,
            "caption": "string",
            "createDate": "2022-12-29T18:02:01Z",
            "editable": false,
            "id": "string",
            "status": "UNKNOWN",
            "strategy": {
                "type": "string"
            },
            "type": "string",
            "currencyType": "string",
            "currencyValue": 0
        },
        {
            "applicationId": 0,
            "caption": "string",
            "createDate": "2022-12-29T18:02:01Z",
            "editable": false,
            "id": "string",
            "status": "UNKNOWN",
            "strategy": {
                "type": "string"
            },
            "type": "string"
        },
        {
            "applicationId": 0,
            "caption": "string",
            "createDate": "2022-12-29T18:02:01Z",
            "editable": false,
            "id": "string",
            "status": "UNKNOWN",
            "strategy": {
                "type": "string"
            },
            "type": "string"
        },
        {
            "applicationId": 0,
            "caption": "string",
            "createDate": "2022-12-29T18:02:01Z",
            "editable": false,
            "id": "string",
            "status": "UNKNOWN",
            "strategy": {
                "type": "string"
            },
            "type": "string"
        }
    ],
    "warnings": [
        "string"
    ]
}

Name

Description

data

Type: (AppOpenMobileAdUnit or RewardedMobileAdUnit or BannerMobileAdUnit or NativeMobileAdUnit or InterstitialMobileAdUnit)[]

warnings

Type: string[]

Список предупреждений, возникших в ходе выполнения операции

AppOpenMobileAdUnit

Name	Description
applicationId*	Type: number Идентификатор приложения
id*	Type: string Идентификатор блока Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Тип блока или тип операции над ним
caption	Type: string Описание Min length: `1` Max length: `255`
createDate	Type: string<date-time> Дата создания блока
editable	Type: boolean Допустимость редактирования
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmStrategy or MinCpmVStrategy or MinECpmStrategy Стратегия управления рекламным трафиком, пороги CPM

RewardedMobileAdUnit

Name	Description
applicationId*	Type: number Идентификатор приложения
currencyType*	Type: string Название внутренней валюты приложения Min length: `1` Max length: `64`
currencyValue*	Type: number Сумма вознаграждения за просмотр во внутренней валюте приложения Min value: `0` Max value: `100000000`
id*	Type: string Идентификатор блока Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Тип блока или тип операции над ним
caption	Type: string Описание Min length: `1` Max length: `255`
createDate	Type: string<date-time> Дата создания блока
editable	Type: boolean Допустимость редактирования
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmStrategy or MinCpmVStrategy or MinECpmStrategy Стратегия управления рекламным трафиком, пороги CPM

BannerMobileAdUnit

Name	Description
applicationId*	Type: number Идентификатор приложения
id*	Type: string Идентификатор блока Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Тип блока или тип операции над ним
caption	Type: string Описание Min length: `1` Max length: `255`
createDate	Type: string<date-time> Дата создания блока
editable	Type: boolean Допустимость редактирования
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmStrategy or MinCpmVStrategy or MinECpmStrategy Стратегия управления рекламным трафиком, пороги CPM

NativeMobileAdUnit

Name	Description
applicationId*	Type: number Идентификатор приложения
id*	Type: string Идентификатор блока Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Тип блока или тип операции над ним
caption	Type: string Описание Min length: `1` Max length: `255`
createDate	Type: string<date-time> Дата создания блока
editable	Type: boolean Допустимость редактирования
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmStrategy or MinCpmVStrategy or MinECpmStrategy Стратегия управления рекламным трафиком, пороги CPM

InterstitialMobileAdUnit

Name	Description
applicationId*	Type: number Идентификатор приложения
id*	Type: string Идентификатор блока Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Тип блока или тип операции над ним
caption	Type: string Описание Min length: `1` Max length: `255`
createDate	Type: string<date-time> Дата создания блока
editable	Type: boolean Допустимость редактирования
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmStrategy or MinCpmVStrategy or MinECpmStrategy Стратегия управления рекламным трафиком, пороги CPM

MaxRevenueStrategy

Не ограничивает стоимость показа

Name

Description

type*

Type: string

Тип стратегии

MinCpmStrategy

Порог определяет стоимость тысячи видимых показов

Name

Description

mincpm*

Type: number

Значение порога

type*

Type: string

Тип стратегии

MinCpmVStrategy

Порог определяет стоимость тысячи видимых показов (Deprecated)

Name

Description

mincpm*

Type: number

Значение порога

type*

Type: string

Тип стратегии

MinECpmStrategy

Порог определяет стоимость тысячи показов (Deprecated)

Name

Description

mincpm*

Type: number

Значение порога

type*

Type: string

Тип стратегии

Strategy

Стратегия управления рекламным трафиком

Name

Description

type*

Type: string

Тип стратегии

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

Обзор

Добавление мобильного блока