Получение мобильного блока по идентификатору

Request

GET

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

Partner API

Path parameters

Name

Description

id

Type: string

Идентификатор мобильного блока

Pattern: R-M-\d{1,10}-\d{1,7}

Example: ``

Responses

200 OK

OK

Body

application/json
{
  "data": {
    "applicationId": 0.5,
    "caption": "example",
    "createDate": "2025-01-01T00:00:00Z",
    "editable": true,
    "id": "example",
    "status": "UNKNOWN",
    "strategy": null,
    "type": "example"
  },
  "warnings": [
    "example"
  ]
}

Name

Description

data

Type: string

Example
{
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": null,
  "type": "example"
}

warnings

Type: string[]

Example
[
  "example"
]

AdUnitStatus

Type: string

Enum: UNKNOWN, ENABLED, ARCHIVED

Strategy

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

Name

Description

type

Type: string

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

Example: example
Example
{
  "type": "example"
}

MaxRevenueStrategy

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

All of 1 type

  • Type: Strategy

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

    Example
    {
  "type": "example"
}
Example
{
  "type": "example"
}

MinCpmStrategy

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

All of 2 types

  • Type: Strategy

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

    Example
    {
  "type": "example"
}
  • Type: object

    mincpm

    Type: number

    Значение порога
    Example
    {
  "mincpm": 0.5
}
Example
{
  "type": "example",
  "mincpm": 0.5
}

MinCpmVStrategy

Deprecated

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

All of 2 types

  • Type: Strategy

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

    Example
    {
  "type": "example"
}
  • Type: object

    mincpm

    Type: number

    Значение порога
    Example
    {
  "mincpm": 0.5
}
Example
{
  "type": "example",
  "mincpm": 0.5
}

MinECpmStrategy

Deprecated

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

All of 2 types

  • Type: Strategy

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

    Example
    {
  "type": "example"
}
  • Type: object

    mincpm

    Type: number

    Значение порога
    Example
    {
  "mincpm": 0.5
}
Example
{
  "type": "example",
  "mincpm": 0.5
}

BaseMobileAdUnit

Name

Description

applicationId

Type: number

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

id

Type: string

Идентификатор блока

Min length: 7

Pattern: R-M-\d{1,10}-\d{1,7}

Example: example

type

Type: string

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

Example: example

caption

Type: string

Описание

Min length: 1

Max length: 255

Example: example

createDate

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z

editable

Type: boolean

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

status

Type: AdUnitStatus

Текущий статус

Enum: UNKNOWN, ENABLED, ARCHIVED

strategy
One of 4 types

  • Максимальный доход

    Type: MaxRevenueStrategy

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

    Example
    {
  "type": "example"
}

  • Минимальный порог CPM

    Type: MinCpmStrategy

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

    Example
    {
  "type": "example",
  "mincpm": 0.5
}

  • Минимальный порог CPMV

    Deprecated

    Type: MinCpmVStrategy

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

    Example
    {
  "type": "example",
  "mincpm": 0.5
}

  • Минимальный порог eCPM

    Deprecated

    Type: MinECpmStrategy

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

    Example
    {
  "type": "example",
  "mincpm": 0.5
}

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

Example
{
  "type": "example"
}
Example
{
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

AppOpenMobileAdUnit

All of 2 types

  • Type: BaseMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

  • Блок рекламы при открытии

    Type: unknown

    Блок рекламы при открытии

    Example: null

Example
{
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

RewardedMobileAdUnit

All of 2 types

  • Type: BaseMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}
  • Type: Блок с вознаграждением

    currencyType

    Type: string

    Название внутренней валюты приложения

    Min length: 1

    Max length: 64

    Example: example

    currencyValue

    Type: number

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

    Min value: 0

    Max value: 100000000

    Блок с вознаграждением

    Example
    {
  "currencyType": "example",
  "currencyValue": 0
}
Example
{
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example",
  "currencyType": "example",
  "currencyValue": 0
}

BannerMobileAdUnit

All of 2 types

  • Type: BaseMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

  • Баннер

    Type: unknown

    Баннер

    Example: null

Example
{
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

NativeMobileAdUnit

All of 2 types

  • Type: BaseMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

  • Блок нативной рекламы

    Type: unknown

    Блок нативной рекламы

    Example: null

Example
{
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

InterstitialMobileAdUnit

All of 2 types

  • Type: BaseMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

  • Блок межстраничной рекламы

    Type: unknown

    Блок межстраничной рекламы

    Example: null

Example
{
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

MobileAdUnit

One of 5 types

  • Type: AppOpenMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

  • Type: RewardedMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example",
  "currencyType": "example",
  "currencyValue": 0
}

  • Type: BannerMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

  • Type: NativeMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}

  • Type: InterstitialMobileAdUnit

    Example
    {
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": {
    "type": "example"
  },
  "type": "example"
}
Example
{
  "applicationId": 0.5,
  "caption": "example",
  "createDate": "2025-01-01T00:00:00Z",
  "editable": true,
  "id": "example",
  "status": "UNKNOWN",
  "strategy": null,
  "type": "example"
}
Предыдущая
Добавление мобильного блока
Следующая
Удаление мобильного блока по идентификатору (занесение в архив)