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"」的所有廣告群組
  • 廣告主底下的所有 ENTITY_STATUS_ACTIVE 或 ENTITY_STATUS_PAUSED AD_GROUP_FORMAT_IN_STREAM 廣告群組：(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED") AND adGroupFormat="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。