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

Request

GET

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

Partner API

Query parameters

Name

Type

Description

filter

MobileAdUnitFilter

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

pageable

Pageable

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

MobileAdUnitFilter

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

Name

Type

Description

appIds

integer<int64>[]

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

status

AdUnitStatus[]

Статусы искомых блоков
Enum: UNKNOWN, ENABLED, ARCHIVED

Pageable

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

Name

Type

Description

page

integer<int32>

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

size

integer<int32>

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

AdUnitStatus

Type

Description

AdUnitStatus

Enum: UNKNOWN, ENABLED, ARCHIVED

Responses

200 OK

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

Type

Description

data

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

warnings

string[]

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

AppOpenMobileAdUnit

Name

Type

Description

applicationId*

number

Идентификатор приложения

caption

string

Описание
Min length: 1
Max length: 255

createDate

string<date-time>

Дата создания блока

editable

boolean

Допустимость редактирования

id*

string

Идентификатор блока
Min length: 7

status

AdUnitStatus

Enum: UNKNOWN, ENABLED, ARCHIVED

strategy

MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy

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

type*

string

Тип блока или тип операции над ним

RewardedMobileAdUnit

Name

Type

Description

applicationId*

number

Идентификатор приложения

caption

string

Описание
Min length: 1
Max length: 255

createDate

string<date-time>

Дата создания блока

editable

boolean

Допустимость редактирования

id*

string

Идентификатор блока
Min length: 7

status

AdUnitStatus

Enum: UNKNOWN, ENABLED, ARCHIVED

strategy

MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy

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

type*

string

Тип блока или тип операции над ним

currencyType*

string

Название внутренней валюты приложения
Min length: 1
Max length: 64

currencyValue*

number

Сумма вознаграждения за просмотр во внутренней валюте приложения

BannerMobileAdUnit

Name

Type

Description

applicationId*

number

Идентификатор приложения

caption

string

Описание
Min length: 1
Max length: 255

createDate

string<date-time>

Дата создания блока

editable

boolean

Допустимость редактирования

id*

string

Идентификатор блока
Min length: 7

status

AdUnitStatus

Enum: UNKNOWN, ENABLED, ARCHIVED

strategy

MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy

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

type*

string

Тип блока или тип операции над ним

NativeMobileAdUnit

Name

Type

Description

applicationId*

number

Идентификатор приложения

caption

string

Описание
Min length: 1
Max length: 255

createDate

string<date-time>

Дата создания блока

editable

boolean

Допустимость редактирования

id*

string

Идентификатор блока
Min length: 7

status

AdUnitStatus

Enum: UNKNOWN, ENABLED, ARCHIVED

strategy

MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy

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

type*

string

Тип блока или тип операции над ним

InterstitialMobileAdUnit

Name

Type

Description

applicationId*

number

Идентификатор приложения

caption

string

Описание
Min length: 1
Max length: 255

createDate

string<date-time>

Дата создания блока

editable

boolean

Допустимость редактирования

id*

string

Идентификатор блока
Min length: 7

status

AdUnitStatus

Enum: UNKNOWN, ENABLED, ARCHIVED

strategy

MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy

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

type*

string

Тип блока или тип операции над ним

MaxRevenueStrategy

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

Name

Type

Description

type*

string

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

MinCpmVStrategy

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

Name

Type

Description

type*

string

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

mincpm*

number

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

MinECpmStrategy

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

Name

Type

Description

type*

string

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

mincpm*

number

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

Strategy

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

Name

Type

Description

type*

string

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