Method: accounts.adUnits.list

列出指定 AdMob 帐号下的广告单元。

HTTP 请求

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

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

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

广告单元的外部可见 ID，可用于与 AdMob SDK 集成。这是一个只读属性。示例：ca-app-pub-9876543210987654/0123456789
appId

string

与此广告单元关联的应用的外部可见 ID。示例：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”- 视频媒体。