Method: advertisers.adGroups.list

列出廣告群組。

HTTP 要求

GET https://displayvideo.googleapis.com/v3/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。