Method: accounts.adSources.adapters.list

Перечислите адаптеры источника рекламы.

HTTP-запрос

GET https://admob.googleapis.com/v1beta/{parent=accounts/*/adSources/*}/adapters

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

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

Параметры
parent

string

Обязательно. Родительский узел, которому принадлежит эта коллекция адаптеров. Формат: accounts/{publisherId}/adSources/{adSourceId}

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

Параметры
pageSize

integer

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

pageToken

string

Токен страницы, полученный из предыдущего вызова adapters.list . Укажите его, чтобы получить следующую страницу.

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

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

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

Ответ на запрос ListAdaptersRequest.

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

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

object ( Adapter )

Адаптер.

nextPageToken

string

Используется для установки pageToken в ListAdapterRequest для получения следующей страницы. Если это поле опущено, последующих страниц не будет.

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

Требуется один из следующих диапазонов аутентификации OAuth:

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

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

Адаптер

Описывает адаптеры, поддерживаемые каждым источником посреднической рекламы.

Адаптеры соответствуют конкретной реализации SDK источника рекламы и каждый из них связан с одной платформой и списком поддерживаемых форматов рекламных блоков. Для выполнения запросов к рекламе адаптерам также может потребоваться настройка некоторых параметров. Параметры можно указать в AdUnitMapping, задав пары ключ/значение adUnitConfigurations . Например, adUnitConfigurations можно использовать для передачи различных идентификаторов стороннему SDK адаптера.

JSON-представление 
{
  "name": string,
  "adapterId": string,
  "title": string,
  "platform": string,
  "formats": [
    string
  ],
  "adapterConfigMetadata": [
    {
      object (AdapterConfigMetadata)
    }
  ]
}
Поля
name

string

Только вывод. Имя ресурса адаптера. Формат:

accounts/{publisherId}/adSources/{adSourceId}/adapters/{adapterId}.

adapterId

string

Только вывод. Идентификатор этого адаптера. Используется для установки adapterId .

title

string

Только для вывода. Отображаемое имя этого адаптера.

platform

string

Только вывод. Данный адаптер поддерживает мобильные приложения.

Поддерживаемые значения: IOS, ANDROID, WINDOWS_PHONE

formats[]

string

Только для вывода. Указывает форматы рекламных блоков, поддерживаемых этим адаптером.

adapterConfigMetadata[]

object ( AdapterConfigMetadata )

Только вывод. Метаданные конфигурации, связанные с этим адаптером.

AdapterConfigMetadata

Метаданные конфигурации, связанные с этим адаптером. Они используются для определения конфигураций adUnitConfigurations, связанных с сопоставлениями AdUnitMappings для этого адаптера.

JSON-представление 
{
  "adapterConfigMetadataId": string,
  "adapterConfigMetadataLabel": string,
  "isRequired": boolean
}
Поля
adapterConfigMetadataId

string

Это используется для заполнения ключа в adUnitConfigurations .

adapterConfigMetadataLabel

string

Название метаданных конфигурации адаптера.

isRequired

boolean

Требуется ли указание этих метаданных для настройки AdUnitMappings.