Editing a mobile ad unit by ID

Info

Console

Request

PATCH

https://partner.yandex.ru/api/mobile/adunit/{id}

Partner API

Path parameters

Name	Type	Description
id*	string	Mobile ad unit ID

Body

application/json

{}

Name	Type	Description
oneOf	UpdateBannerMobileAdUnit
oneOf	UpdateNativeMobileAdUnit
oneOf	UpdateInterstitialMobileAdUnit
oneOf	UpdateRewardedMobileAdUnit
oneOf	UpdateAppOpenMobileAdUnit

UpdateBannerMobileAdUnit

Name	Type	Description
caption	string	Description Min length: `1` Max length: `255`
id	string	Unit ID Min length: `7`
strategy	MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy	Ad traffic management strategy, CPM floors
type*	string	Type of ad unit or unit action

UpdateNativeMobileAdUnit

Name	Type	Description
caption	string	Description Min length: `1` Max length: `255`
id	string	Unit ID Min length: `7`
strategy	MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy	Ad traffic management strategy, CPM floors
type*	string	Type of ad unit or unit action

UpdateInterstitialMobileAdUnit

Name	Type	Description
caption	string	Description Min length: `1` Max length: `255`
id	string	Unit ID Min length: `7`
strategy	MaxRevenueStrategy or MinCpmVStrategy or MinECpmStrategy	Ad traffic management strategy, CPM floors
type*	string	Type of ad unit or unit action

UpdateRewardedMobileAdUnit

Name	Type	Description
caption	string	Description Min length: `1` Max length: `255`
id	string	Unit ID Min length: `7`
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

UpdateAppOpenMobileAdUnit

Name	Type	Description
caption	string	Description Min length: `1` Max length: `255`
id	string	Unit ID Min length: `7`
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

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"
    },
    "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

AdUnitStatus

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

Editing a mobile ad unit by ID

RequestRequest

Path parametersPath parameters

BodyBody

UpdateBannerMobileAdUnitUpdateBannerMobileAdUnit

UpdateNativeMobileAdUnitUpdateNativeMobileAdUnit

UpdateInterstitialMobileAdUnitUpdateInterstitialMobileAdUnit

UpdateRewardedMobileAdUnitUpdateRewardedMobileAdUnit

UpdateAppOpenMobileAdUnitUpdateAppOpenMobileAdUnit

MaxRevenueStrategyMaxRevenueStrategy

MinCpmVStrategyMinCpmVStrategy

MinECpmStrategyMinECpmStrategy

StrategyStrategy

ResponsesResponses

200 OK200 OK

BodyBody

AppOpenMobileAdUnitAppOpenMobileAdUnit

RewardedMobileAdUnitRewardedMobileAdUnit

BannerMobileAdUnitBannerMobileAdUnit

NativeMobileAdUnitNativeMobileAdUnit

InterstitialMobileAdUnitInterstitialMobileAdUnit

AdUnitStatusAdUnitStatus

Was the article helpful?

Request

Path parameters

Body

UpdateBannerMobileAdUnit

UpdateNativeMobileAdUnit

UpdateInterstitialMobileAdUnit

UpdateRewardedMobileAdUnit

UpdateAppOpenMobileAdUnit

MaxRevenueStrategy

MinCpmVStrategy

MinECpmStrategy

Strategy

Responses

200 OK

Body

AppOpenMobileAdUnit

RewardedMobileAdUnit

BannerMobileAdUnit

NativeMobileAdUnit

InterstitialMobileAdUnit

AdUnitStatus