自
2025 年 9 月 8 日起,每个新订单项都需要声明是否会投放欧盟 (EU) 政治广告。Display & Video 360 API 和未提供声明的 SDF 上传操作将会失败。如需详细了解如何更新集成以进行此声明,请参阅我们的
弃用页面。
Method: advertisers.adGroups.list
使用集合让一切井井有条
根据您的偏好保存内容并对其进行分类。
HTTP 请求
GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups
网址采用 gRPC 转码语法。
路径参数
参数 |
advertiserId |
string (int64 format)
必需。广告组所属的广告客户的 ID。
|
查询参数
参数 |
pageSize |
integer
可选。请求的页面大小。 必须介于 1 到 200 之间。如果未指定,则默认为 100 。如果指定的值无效,则返回错误代码 INVALID_ARGUMENT 。
|
pageToken |
string
可选。标识服务器应返回的结果页面的令牌。 通常,这是上次调用 adGroups.list 方法返回的 nextPageToken 值。如果未指定,则返回第一页的结果。
|
orderBy |
string
可选。表示要按哪个字段对此列表进行排序。可接受的值包括:
displayName (默认)
entityStatus
默认排序顺序为升序。如需将字段指定为降序,应将后缀“desc”添加到字段名称中。示例:displayName desc 。
|
filter |
string
可选。允许按自定义广告组字段进行过滤。 支持的语法:
- 过滤条件表达式由一个或多个限制条件组成。
- 限制条件可以通过
AND 和 OR 组合使用。一系列限制会隐式使用 AND 。
- 限制的格式为
{field} {operator} {value} 。
- 所有字段都必须使用
EQUALS (=) 运算符。
支持的房源:
adGroupId
displayName
entityStatus
lineItemId
adGroupFormat
示例:
- 订单项“
lineItemId="1234" ”下的所有广告组
- 广告客户
(entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupFormat="AD_GROUP_FORMAT_IN_STREAM" 下的所有 ENTITY_STATUS_ACTIVE 或 ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM 广告组
此字段的长度不得超过 500 个字符。 如需了解详情,请参阅我们的过滤 LIST 请求指南。
|
响应正文
JSON 表示法 |
{
"adGroups": [
{
object (AdGroup )
}
],
"nextPageToken": string
} |
字段 |
adGroups[] |
object (AdGroup )
广告组列表。 如果为空,则不会显示此列表。
|
nextPageToken |
string
用于检索下一页结果的令牌。在对 adGroups.list 方法的后续调用中,将此值传入 pageToken 字段,以检索下一页结果。
|
授权范围
需要以下 OAuth 范围:
https://www.googleapis.com/auth/display-video
如需了解详情,请参阅 OAuth 2.0 Overview。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2025-07-25。
[null,null,["最后更新时间 (UTC):2025-07-25。"],[],["This document outlines the `adGroups.list` method in the Display & Video 360 API v4. It details how to retrieve a list of ad groups associated with a specific advertiser. Key actions include sending a GET request to a specified URL, using the `advertiserId` as a path parameter. Optional query parameters like `pageSize`, `pageToken`, `orderBy`, and `filter` enable result customization. The response returns a list of `adGroups` and a `nextPageToken` for pagination. The request body should be empty, and specific OAuth scopes are needed for authorization.\n"],null,["# Method: advertisers.adGroups.list\n\n- [HTTP request](#body.HTTP_TEMPLATE)\n- [Path parameters](#body.PATH_PARAMETERS)\n- [Query parameters](#body.QUERY_PARAMETERS)\n- [Request body](#body.request_body)\n- [Response body](#body.response_body)\n - [JSON representation](#body.ListAdGroupsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ad groups.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroups`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\n### Path parameters\n\n| Parameters ||\n|----------------|--------------------------------------------------------------------------------------------------------------------------------------------------|\n| `advertiserId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Required. The ID of the advertiser the ad groups belongs to. |\n\n### Query parameters\n\n| Parameters ||\n|-------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `pageSize` | `integer` Optional. Requested page size. Must be between `1` and `200`. If unspecified will default to `100`. Returns error code `INVALID_ARGUMENT` if an invalid value is specified. |\n| `pageToken` | `string` Optional. A token identifying a page of results the server should return. Typically, this is the value of [nextPageToken](/display-video/api/reference/rest/v4/advertisers.adGroups/list#body.ListAdGroupsResponse.FIELDS.next_page_token) returned from the previous call to `adGroups.list` method. If not specified, the first page of results will be returned. |\n| `orderBy` | `string` Optional. Field by which to sort the list. Acceptable values are: - `displayName` (default) - `entityStatus` The default sorting order is ascending. To specify descending order for a field, a suffix \"desc\" should be added to the field name. Example: `displayName desc`. |\n| `filter` | `string` Optional. Allows filtering by custom ad group fields. Supported syntax: - Filter expressions are made up of one or more restrictions. - Restrictions can be combined by `AND` and `OR`. A sequence of restrictions implicitly uses `AND`. - A restriction has the form of `{field} {operator} {value}`. - All fields must use the `EQUALS (=)` operator. Supported properties: - `adGroupId` - `displayName` - `entityStatus` - `lineItemId` - `adGroupFormat` Examples: - All ad groups under an line item: `lineItemId=\"1234\"` - All `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED` `AD_GROUP_FORMAT_IN_STREAM` ad groups under an advertiser: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupFormat=\"AD_GROUP_FORMAT_IN_STREAM\"` The length of this field should be no more than 500 characters. Reference our [filter `LIST` requests](/display-video/api/guides/how-tos/filters) guide for more information. |\n\n### Request body\n\nThe request body must be empty.\n\n### Response body\n\nIf successful, the response body contains data with the following structure:\n\n| JSON representation |\n|-------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"adGroups\": [ { object (/display-video/api/reference/rest/v4/advertisers.adGroups#AdGroup) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adGroups[]` | `object (`[AdGroup](/display-video/api/reference/rest/v4/advertisers.adGroups#AdGroup)`)` The list of ad groups. This list will be absent if empty. |\n| `nextPageToken` | `string` A token to retrieve the next page of results. Pass this value in the [pageToken](/display-video/api/reference/rest/v4/advertisers.adGroups/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `adGroups.list` method to retrieve the next page of results. |\n\n### Authorization scopes\n\nRequires the following OAuth scope:\n\n- `https://www.googleapis.com/auth/display-video`\n\nFor more information, see the [OAuth 2.0 Overview](/identity/protocols/OAuth2)."]]