Method: accounts.adUnits.list

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

HTTP-запрос

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

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

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

Параметры
parent

string

Необходимый. Имя ресурса аккаунта, для которого будет указан рекламный блок. Пример: account/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 .

Рекламный блок

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

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

string

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

adUnitId

string

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

appId

string

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

displayName

string

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

adFormat

string

AdFormat рекламного блока. Возможные значения следующие:

«APP_OPEN» — формат объявления при открытии приложения. «БАННЕР» — формат баннерной рекламы. «BANNER_INTERSTITIAL» – устаревший формат, который можно использовать как в качестве баннера, так и в качестве межстраничного объявления. Этот формат больше не может быть создан, но может использоваться группами медиации. «МЕЖСТРИЦИАЛЬНАЯ» – полноэкранная реклама. Поддерживаемые типы объявлений: «RICH_MEDIA» и «VIDEO». «НАТИВНЫЙ» — формат нативного объявления. «НАГРАЖДЕНИЕ» – объявление, которое после просмотра получает обратный вызов, подтверждающий просмотр, чтобы пользователю можно было предоставить вознаграждение. Поддерживаемые типы объявлений: «RICH_MEDIA» (интерактивные) и видео, из которых видео нельзя исключить. «REWARDED_INTERSTITIAL» — формат межстраничной рекламы с вознаграждением. Поддерживается только тип видеорекламы. См. https://support.google.com/admob/answer/9884467 .

adTypes[]

string

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

«RICH_MEDIA» — текст, изображения и другие носители, не относящиеся к видео. «ВИДЕО» - Видеомедиа.