Method: advertisers.adGroupAds.list

列出廣告群組廣告。

HTTP 要求

GET https://displayvideo.googleapis.com/v3/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"
  • 廣告群組下的所有廣告群組廣告，EntityStatus 為 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 總覽。