Method: accounts.adUnits.list

Перечислите рекламные блоки в указанном аккаунте AdMob.

HTTP-запрос

GET https://admob.googleapis.com/v1/{parent=accounts/*}/adUnits

В URL-адресе используется синтаксис транскодирования gRPC .

Параметры пути

Параметры
parent

string

Обязательно. Имя ресурса учетной записи, для которой нужно отобразить рекламные блоки. Пример: accounts/pub-9876543210987654

Параметры запроса

Параметры
pageSize

integer

Максимальное количество возвращаемых рекламных блоков. Если значение не указано или равно 0, будет возвращено не более 10 000 рекламных блоков. Максимальное значение — 20 000; значения выше 20 000 будут преобразованы в 20 000.

pageToken

string

Значение, возвращаемое последним ListAdUnitsResponse , указывает на то, что это продолжение предыдущего вызова adUnits.list , и система должна вернуть следующую страницу данных.

Текст запроса

Тело запроса должно быть пустым.

Ответный текст

Ответ на запрос списка рекламных блоков.

В случае успеха тело ответа будет содержать данные следующей структуры:

JSON-представление 
{
  "adUnits": [
    {
      object (AdUnit)
    }
  ],
  "nextPageToken": string
}
Поля
adUnits[]

object ( AdUnit )

Полученные рекламные блоки для запрошенного аккаунта.

nextPageToken

string

Если значение не пустое, это указывает на то, что для запроса могут быть доступны и другие рекламные блоки; это значение следует передавать в новом объекте ListAdUnitsRequest .

Области полномочий

Требуется следующая область действия OAuth:

  • https://www.googleapis.com/auth/admob.readonly

Для получения более подробной информации см.OAuth 2.0 Overview .

AdUnit

Описывает рекламный блок AdMob.

JSON-представление 
{
  "name": string,
  "adUnitId": string,
  "appId": string,
  "displayName": string,
  "adFormat": string,
  "adTypes": [
    string
  ]
}
Поля
name

string

Имя ресурса для этого рекламного блока. Формат: accounts/{publisherId}/adUnits/{ad_unit_id_fragment}. Пример: accounts/pub-9876543210987654/adUnits/0123456789

adUnitId

string

Внешний идентификатор рекламного блока, который можно использовать для интеграции с SDK AdMob. Это свойство доступно только для чтения. Пример: ca-app-pub-9876543210987654/0123456789

appId

string

Внешний видимый идентификатор приложения, с которым связан данный рекламный блок. Пример: ca-app-pub-9876543210987654~0123456789

displayName

string

Название рекламного блока, отображаемое в пользовательском интерфейсе AdMob, предоставляется пользователем. Максимальная допустимая длина — 80 символов.

adFormat

string

AdFormat — формат рекламного блока. Возможные значения:

"APP_OPEN" — формат объявления "Открытие приложения". "BANNER" — формат баннерного объявления. "BANNER_INTERSTITIAL" — устаревший формат, который можно использовать как баннер или межстраничное объявление. Этот формат больше нельзя создать, но его можно использовать в группах медиации. "INTERSTITIAL" — полноэкранное объявление. Поддерживаемые типы объявлений: "RICH_MEDIA" и "VIDEO". "NATIVE" — формат нативного объявления. "REWARDED" — объявление, которое после просмотра получает обратный вызов, подтверждающий просмотр, чтобы пользователь мог получить вознаграждение. Поддерживаемые типы объявлений: "RICH_MEDIA" (интерактивное) и видео, при этом видео нельзя исключить. "REWARDED_INTERSTITIAL" — формат межстраничного объявления с вознаграждением. Поддерживается только видео. См. https://support.google.com/admob/answer/9884467 .

adTypes[]

string

Тип рекламного носителя, поддерживаемый данным рекламным блоком. Возможные значения:

"RICH_MEDIA" — Текст, изображения и другие невидеоматериалы. "VIDEO" — Видеоматериалы.