Method: partners.channels.list

列出夥伴或廣告主的頻道。

HTTP 要求

GET https://displayvideo.googleapis.com/v1/partners/{partnerId}/channels

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

路徑參數

參數
partnerId

string (int64 format)

擁有頻道的合作夥伴 ID。

查詢參數

參數
pageSize

integer

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

pageToken

string

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

orderBy

string

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

  • displayName (預設)
  • channelId

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

filter

string

允許依頻道欄位進行篩選。

支援的語法:

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

支援的欄位:

  • displayName

示例:

  • 所有顯示名稱包含「google」的管道:displayName : "google"

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

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

advertiserId

string (int64 format)

擁有管道的廣告客戶 ID。

要求主體

要求主體必須為空白。

回應主體

如果成功,回應主體會包含 ListChannelsResponse 的執行例項。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽