Method: advertisers.campaigns.list

列出廣告主的廣告活動。

順序由 orderBy 參數定義。如未指定 filter (以 entityStatus 為單位)，結果就不會包含有 ENTITY_STATUS_ARCHIVED 的廣告活動。

HTTP 要求

GET https://displayvideo.googleapis.com/v3/advertisers/{advertiserId}/campaigns

這個網址使用 gRPC 轉碼語法。

路徑參數

參數
advertiserId

string (int64 format)

要列出廣告活動的廣告主 ID。

查詢參數

參數
pageSize

integer

要求的頁面大小。必須介於 1 至 200 之間。如果未指定，則預設為 100。
pageToken

string

這個符記可識別伺服器應傳回的結果頁面。通常這是先前呼叫 campaigns.list 方法時傳回的 nextPageToken 值。如未指定，系統會傳回第一頁的結果。
orderBy

string

用來排序清單的欄位。可接受的值如下：

  • displayName (預設)
  • entityStatus
  • updateTime

系統預設採遞增排序順序。如要針對欄位指定遞減順序，則應於欄位名稱後方加上「desc」，範例：displayName desc。
filter

string

可依廣告活動欄位篩選。

支援的語法：

  • 篩選運算式由一或多項限制組成。
  • 限制條件可透過 AND 或 OR 邏輯運算子合併。限制序列會隱含使用 AND。
  • 限制的格式為 {field} {operator} {value}。
  • updateTime 欄位必須使用 GREATER THAN OR EQUAL TO (>=) 或 LESS THAN OR EQUAL TO (<=) 運算子。
  • 其他所有欄位都必須使用 EQUALS (=) 運算子。

支援的欄位：

  • campaignId
  • displayName
  • entityStatus
  • updateTime (以 ISO 8601 格式輸入，或 YYYY-MM-DDTHH:MM:SSZ)

範例：

  • 廣告主底下的所有 ENTITY_STATUS_ACTIVE 或 ENTITY_STATUS_PAUSED 廣告活動：(entityStatus="ENTITY_STATUS_ACTIVE" OR entityStatus="ENTITY_STATUS_PAUSED")
  • 更新時間小於或等於 2020-11-04T18:54:47Z (ISO 8601 格式) 的所有廣告活動：updateTime<="2020-11-04T18:54:47Z"
  • 更新時間大於或等於 2020-11-04T18:54:47Z (ISO 8601 格式) 的所有廣告活動：updateTime>="2020-11-04T18:54:47Z"

這個欄位的長度不得超過 500 個字元。

詳情請參閱篩選器 LIST 要求指南。

要求主體

要求主體必須為空白。

回應主體

如果成功，回應主體即會包含具有以下結構的資料：

JSON 表示法 
{
  "campaigns": [
    {
      object (Campaign)
    }
  ],
  "nextPageToken": string
}
欄位
campaigns[]

object (Campaign)

廣告活動清單。

如果清單為空白，就不會顯示。
nextPageToken

string

用來擷取下一頁結果的符記。在後續呼叫 campaigns.list 方法時，將這個值傳遞至 pageToken 欄位，即可擷取下一頁結果。

授權範圍

需要下列其中一種 OAuth 範圍：

  • https://www.googleapis.com/auth/display-video
  • https://www.googleapis.com/auth/display-video-mediaplanning

詳情請參閱OAuth 2.0 Overview。