自
2025 年 9 月 8 日起,每個新委刊項都必須聲明是否會放送歐盟政治廣告。如果透過 Display & Video 360 API 和 SDF 上傳的檔案未提供聲明,系統就會失敗。如要進一步瞭解如何更新整合服務以進行這項聲明,請參閱
淘汰項目頁面。
Method: advertisers.adGroupAds.list
透過集合功能整理內容
你可以依據偏好儲存及分類內容。
HTTP 要求
GET https://displayvideo.googleapis.com/v4/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
範例:
- 廣告群組「
adGroupId="1234" 」下的所有廣告群組廣告
- 廣告群組下方所有廣告群組廣告,其中實體狀態為
ENTITY_STATUS_ACTIVE 或 ENTITY_STATUS_PAUSED :(entityStatus="ENTITY_STATUS_ACTIVE" OR
entityStatus="ENTITY_STATUS_PAUSED") AND
adGroupId="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。
除非另有註明,否則本頁面中的內容是採用創用 CC 姓名標示 4.0 授權,程式碼範例則為阿帕契 2.0 授權。詳情請參閱《Google Developers 網站政策》。Java 是 Oracle 和/或其關聯企業的註冊商標。
上次更新時間:2025-07-25 (世界標準時間)。
[null,null,["上次更新時間:2025-07-25 (世界標準時間)。"],[],["The Display & Video 360 API v4 allows listing ad group ads via a GET request to `https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroupAds`. The `advertiserId` path parameter is required. Query parameters include `pageSize`, `pageToken`, `orderBy` for sorting (e.g., `displayName`), and `filter` to filter by fields like `adGroupId`. The response contains a list of ad group ads and a `nextPageToken` for pagination. The request body must be empty. The API requires OAuth scope `https://www.googleapis.com/auth/display-video`.\n"],null,["# Method: advertisers.adGroupAds.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.ListAdGroupAdsResponse.SCHEMA_REPRESENTATION)\n- [Authorization scopes](#body.aspect)\n- [Try it!](#try-it)\n\nLists ad group ads.\n\n### HTTP request\n\n`GET https://displayvideo.googleapis.com/v4/advertisers/{advertiserId}/adGroupAds`\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 `100`. 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.adGroupAds/list#body.ListAdGroupAdsResponse.FIELDS.next_page_token) returned from the previous call to `adGroupAds.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 ad 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 fields: - `adGroupId` - `displayName` - `entityStatus` - `adGroupAdId` Examples: - All ad group ads under an ad group: `adGroupId=\"1234\"` - All ad group ads under an ad group with an entityStatus of `ENTITY_STATUS_ACTIVE` or `ENTITY_STATUS_PAUSED`: `(entityStatus=\"ENTITY_STATUS_ACTIVE\" OR entityStatus=\"ENTITY_STATUS_PAUSED\") AND adGroupId=\"12345\"` 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| ``` { \"adGroupAds\": [ { object (/display-video/api/reference/rest/v4/advertisers.adGroupAds#AdGroupAd) } ], \"nextPageToken\": string } ``` |\n\n| Fields ||\n|-----------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `adGroupAds[]` | `object (`[AdGroupAd](/display-video/api/reference/rest/v4/advertisers.adGroupAds#AdGroupAd)`)` The list of ad group ads. 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.adGroupAds/list#body.QUERY_PARAMETERS.page_token) field in the subsequent call to `adGroupAds.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)."]]