Method: customLists.list

列出自訂名單。

順序由 orderBy 參數定義。

HTTP 要求

GET https://displayvideo.googleapis.com/v1/customLists

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

查詢參數

參數
pageSize

integer

要求的頁面大小。必須介於 1 至 200 之間。如果未指定，則預設為 100。如果指定無效的值，則傳回錯誤代碼 INVALID_ARGUMENT。
pageToken

string

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

string

清單排序依據的欄位。可接受的值為：

  • customListId (預設)
  • displayName

預設的排序順序是遞增。如要為欄位指定遞減順序，請在欄位名稱中加入後置字串「desc」。範例：displayName desc。
filter

string

允許依自訂清單欄位進行篩選。

支援的語法：

  • 自訂清單的篩選運算式最多只能包含 1 項限制。
  • 限制的形式為 {field} {operator} {value}。
  • 所有欄位都必須使用 HAS (:) 運算子。

支援的欄位：

  • displayName

示例：

  • 顯示名稱包含「Google」的所有自訂清單：displayName:"Google"。

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

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

string (int64 format)

有權存取已擷取自訂名單的 DV360 廣告主 ID。

要求主體

要求主體必須為空白。

回應主體

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

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

object (CustomList)

自訂名單清單。

如果留空，這份清單將不會顯示。
nextPageToken

string

用於擷取下一頁結果的權杖。在對 customLists.list 方法的後續呼叫中將這個值傳入 pageToken 欄位，即可擷取下一頁的結果。

授權範圍

需要下列 OAuth 範圍：

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

詳情請參閱 OAuth 2.0 總覽。