Getting a list of mobile ad units

Info

Console

Request

GET

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

Partner API

Query parameters

Name

Description

filter

Type: MobileAdUnitFilter

Mobile ad unit filter parameters

pageable

Type: Pageable

Page-by-page output parameters

MobileAdUnitFilter

Mobile ad unit filter parameters

Name

Description

appIds

Type: integer<int64>[]

IDs of apps where to search for ad units

Unique items

status

Type: AdUnitStatus[]

Statuses of ad units to search

Enum: UNKNOWN, ENABLED, ARCHIVED

Default: ENABLED

Unique items

Pageable

Page-by-page output parameters

Name

Description

page

Type: integer<int32>

Page number (zero-based)

Default: 0

Min value: 0

size

Type: integer<int32>

Page size

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[]

List of warnings that occurred when performing an action

AppOpenMobileAdUnit

Name	Description
applicationId*	Type: number App ID
id*	Type: string Unit ID Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Type of ad unit or unit action
caption	Type: string Description Min length: `1` Max length: `255`
createDate	Type: string<date-time> Unit creation date
editable	Type: boolean Editability
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy Ad traffic management strategy, CPM floors

RewardedMobileAdUnit

Name	Description
applicationId*	Type: number App ID
currencyType*	Type: string In-app currency name Min length: `1` Max length: `64`
currencyValue*	Type: number Reward amount for viewing the ad in the in-app currency Min value: `0` Max value: `100000000`
id*	Type: string Unit ID Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Type of ad unit or unit action
caption	Type: string Description Min length: `1` Max length: `255`
createDate	Type: string<date-time> Unit creation date
editable	Type: boolean Editability
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy Ad traffic management strategy, CPM floors

BannerMobileAdUnit

Name	Description
applicationId*	Type: number App ID
id*	Type: string Unit ID Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Type of ad unit or unit action
caption	Type: string Description Min length: `1` Max length: `255`
createDate	Type: string<date-time> Unit creation date
editable	Type: boolean Editability
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy Ad traffic management strategy, CPM floors

NativeMobileAdUnit

Name	Description
applicationId*	Type: number App ID
id*	Type: string Unit ID Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Type of ad unit or unit action
caption	Type: string Description Min length: `1` Max length: `255`
createDate	Type: string<date-time> Unit creation date
editable	Type: boolean Editability
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy Ad traffic management strategy, CPM floors

InterstitialMobileAdUnit

Name	Description
applicationId*	Type: number App ID
id*	Type: string Unit ID Min length: `7` Pattern: `R-M-\d{1,10}-\d{1,7}`
type*	Type: string Type of ad unit or unit action
caption	Type: string Description Min length: `1` Max length: `255`
createDate	Type: string<date-time> Unit creation date
editable	Type: boolean Editability
status	Type: AdUnitStatus Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`
strategy	Type: MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy Ad traffic management strategy, CPM floors

MaxRevenueStrategy

Doesn't limit the impression cost

Name

Description

type*

Type: string

Strategy type

MinCpmVStrategy

The threshold (floor) sets the cost per one thousand viewable impressions

Name

Description

mincpm*

Type: number

Floor value

type*

Type: string

Strategy type

MinECpmStrategy

The threshold (floor) sets the cost per one thousand impressions

Name

Description

mincpm*

Type: number

Floor value

type*

Type: string

Strategy type

Strategy

Ad traffic management strategy

Name

Description

type*

Type: string

Strategy type

Was the article helpful?

Overview

Adding a mobile ad unit