Getting a list of mobile ad units

Info

Console

Request

GET

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

Partner API

Query parameters

Name	Type	Description
filter	MobileAdUnitFilter	Mobile ad unit filter parameters
pageable	Pageable	Page-by-page output parameters

MobileAdUnitFilter

Mobile ad unit filter parameters

Name	Type	Description
appIds	integer<int64>[]	IDs of apps where to search for ad units
status	AdUnitStatus[]	Statuses of ad units to search Enum: `UNKNOWN`, `ENABLED`, `ARCHIVED`

Pageable

Page-by-page output parameters

Name	Type	Description
page	integer<int32>	Page number (zero-based) Default: `0`
size	integer<int32>	Page size Default: `20`

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	Type	Description
data	(AppOpenMobileAdUnit or RewardedMobileAdUnit or BannerMobileAdUnit or NativeMobileAdUnit or InterstitialMobileAdUnit)[]
warnings	string[]	List of warnings that occurred when performing an action

AppOpenMobileAdUnit

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

RewardedMobileAdUnit

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

BannerMobileAdUnit

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

NativeMobileAdUnit

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

InterstitialMobileAdUnit

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

MaxRevenueStrategy

Doesn't limit the impression cost

Name	Type	Description
type*	string	Strategy type

MinCpmVStrategy

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

Name	Type	Description
type*	string	Strategy type
mincpm*	number	Floor value

MinECpmStrategy

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

Name	Type	Description
type*	string	Strategy type
mincpm*	number	Floor value

Strategy

Doesn't limit the impression cost

Name	Type	Description
type*	string	Strategy type

Getting a list of mobile ad units

RequestRequest

Query parametersQuery parameters

MobileAdUnitFilterMobileAdUnitFilter

PageablePageable

AdUnitStatusAdUnitStatus

ResponsesResponses

200 OK200 OK

BodyBody

AppOpenMobileAdUnitAppOpenMobileAdUnit

RewardedMobileAdUnitRewardedMobileAdUnit

BannerMobileAdUnitBannerMobileAdUnit

NativeMobileAdUnitNativeMobileAdUnit

InterstitialMobileAdUnitInterstitialMobileAdUnit

MaxRevenueStrategyMaxRevenueStrategy

MinCpmVStrategyMinCpmVStrategy

MinECpmStrategyMinECpmStrategy

StrategyStrategy

Was the article helpful?