Method: customBiddingAlgorithms.list

列出目前使用者可存取的自訂出價演算法,並用於出價策略。

順序是由 orderBy 參數定義。

HTTP 要求

GET https://displayvideo.googleapis.com/v2/customBiddingAlgorithms

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

查詢參數

參數
pageSize

integer

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

pageToken

string

用於識別伺服器應傳回之結果頁面的符記。一般而言,這是從先前呼叫 customBiddingAlgorithms.list 方法傳回的 nextPageToken 值。如果未指定,系統將傳回第一頁的結果。

orderBy

string

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

  • displayName (預設)

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

filter

string

允許按照自訂出價演算法欄位進行篩選。

支援的語法:

  • 篩選器運算式由一或多個限制組成。
  • 限制可以用 AND 合併。一組限制會隱含使用 AND
  • 限制的形式為 {field} {operator} {value}
  • customBiddingAlgorithmType 欄位必須使用 EQUALS (=) 運算子。
  • displayName 欄位必須使用 HAS (:) 運算子。

支援的欄位:

  • customBiddingAlgorithmType
  • displayName

範例:

  • 顯示名稱包含「政治」的所有自訂出價演算法:displayName:"politics"
  • 類型為「SCRIPT_BASED」的所有自訂出價演算法:customBiddingAlgorithmType=SCRIPT_BASED

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

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

聯集參數 accessor。必要欄位。指出發出請求的是哪個 DV360 實體。LIST 要求只會傳回自訂出價演算法實體,且這類實體可存取 accessor 中的 DV360 實體。如要執行 LIST 要求,使用者必須具備 accessor 實體的權限。accessor 只能採用下列其中一種設定:
partnerId

string (int64 format)

可存取自訂出價演算法的 DV360 合作夥伴 ID。

advertiserId

string (int64 format)

可存取自訂出價演算法的 DV360 廣告主 ID。

要求主體

要求主體必須為空白。

回應主體

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

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

object (CustomBiddingAlgorithm)

自訂出價演算法的清單。

如果留空,這份清單就不會顯示。

nextPageToken

string

用於擷取下一頁結果的符記。在對 ListCustomBiddingAlgorithmsRequest 方法的後續呼叫時,將這個值傳入 pageToken 欄位,即可擷取下一頁的結果。如果這個欄位為 null,表示這是最後一頁。

授權範圍

需要下列 OAuth 範圍:

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

詳情請參閱 OAuth 2.0 總覽