Method: advertisers.adGroupAds.list

列出广告组广告。

HTTP 请求

GET https://displayvideo.googleapis.com/v5/advertisers/{advertiserId}/adGroupAds

网址采用 gRPC 转码语法。

路径参数

参数
advertiserId

string (int64 format)

必需。广告所属广告客户的 ID。

查询参数

参数
pageSize

integer

可选。请求的页面大小。 必须介于 1 到 100 之间。如果未指定，则默认为 100。如果指定了无效值，则返回错误代码 INVALID_ARGUMENT。
pageToken

string

可选。标识服务器应返回的结果页面的令牌。通常，这是从上一次调用 adGroupAds.list 方法返回的 nextPageToken 值。如果未指定，则系统会返回第一页结果。
orderBy

string

可选。用于对列表进行排序的字段。可接受的值包括：

  • displayName（默认）
  • entityStatus

默认排序顺序为升序。如需将字段指定为降序排序，应在字段名称中添加后缀“desc”。示例：displayName desc。
filter

string

可选。允许按广告组广告字段进行过滤。

支持的语法：

  • 过滤表达式由一个或多个限制条件组成。
  • 限制条件可以通过 AND 和 OR 进行组合。一系列限制会隐式使用 AND。
  • 限制条件的格式为 {field} {operator} {value}。
  • 所有字段都必须使用 EQUALS (=) 运算符。

支持的字段：

  • adGroupId
  • displayName
  • entityStatus
  • adGroupAdId
  • parentCreativeId

示例：

  • 广告组“adGroupId="1234"”下的所有广告组广告
  • entityStatus 为 ENTITY_STATUS_ACTIVE 或 ENTITY_STATUS_PAUSED 的广告组下的所有广告组广告：(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupId="12345"
  • 父级广告素材下的所有广告组广告：parentCreativeId="12345"

此字段的长度不应超过 500 个字符。

如需了解详情，请参阅我们的过滤 LIST 请求指南。

请求正文

请求正文必须为空。

响应正文

如果成功，响应正文将包含结构如下的数据：

JSON 表示法 
{
  "adGroupAds": [
    {
      object (AdGroupAd)
    }
  ],
  "nextPageToken": string
}
字段
adGroupAds[]

object (AdGroupAd)

广告列表。

如果此列表为空，则不会显示。
nextPageToken

string

用于检索下一页结果的令牌。在后续调用 adGroupAds.list 方法时，在 pageToken 字段中传递此值，以检索下一页结果。

授权范围

需要以下 OAuth 范围：

  • https://www.googleapis.com/auth/display-video

如需了解详情，请参阅 OAuth 2.0 Overview。