Method: accounts.adSources.adapters.list

列出广告来源的适配器。

HTTP 请求

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

网址采用 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

用于在 ListAdapterRequest 中设置 pageToken 以检索下一页。如果省略此字段，则不存在后续页面。

授权范围

需要以下 OAuth 范围之一：

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

有关详情，请参阅 OAuth 2.0 概览。

Adapter（改编者）

介绍每个中介广告来源支持的适配器。

适配器与广告来源的特定 SDK 实现相对应，而且与一个平台和一系列受支持的广告单元格式相关联。适配器可能还需要进行一些配置才能执行广告请求。您可以通过设置 adUnitConfigurations 键值对在 AdUnitMapping 中指定配置。例如，可以使用 adUnitConfigurations 将各种 ID 传递给适配器的第三方 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

仅供输出。此适配器的 ID。它用于设置 adapterId。
title

string

仅供输出。此适配器的显示名称。
platform

string

仅供输出。此适配器支持的移动应用平台。

支持的值包括：IOS、ANDROID、WINDOWS_PHONE
formats[]

string

仅供输出。指明此适配器支持的广告单元的格式。
adapterConfigMetadata[]

object (AdapterConfigMetadata)

仅供输出。与此适配器关联的配置元数据。

AdapterConfigMetadata

与此适配器关联的配置元数据。它们用于定义与此适配器的 AdUnitMapping 相关联的 adUnitConfigurations。

JSON 表示法 
{
  "adapterConfigMetadataId": string,
  "adapterConfigMetadataLabel": string,
  "isRequired": boolean
}
字段
adapterConfigMetadataId

string

此属性用于填充 adUnitConfigurations 的键。
adapterConfigMetadataLabel

string

适配器配置元数据的名称。
isRequired

boolean

配置 AdUnitMapping 时是否需要用到该元数据。