REST Resource: customBiddingAlgorithms

資源：CustomBiddingAlgorithm

單一自訂出價演算法。

JSON 表示法 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
欄位
name

string

僅供輸出。自訂出價演算法的資源名稱。
customBiddingAlgorithmId

string (int64 format)

僅供輸出。自訂出價演算法的專屬 ID。由系統指派。
displayName

string

必要欄位。自訂出價演算法的顯示名稱。

必須採用 UTF-8 編碼，且大小不得超過 240 個位元組。
entityStatus

enum (EntityStatus)

控管自訂出價演算法是否能做為出價策略使用。

可接受的值如下：

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

必要欄位。無法變更。自訂出價演算法的類型。
sharedAdvertiserIds[]

string (int64 format)

有權存取這個演算法的廣告客戶 ID。如果已設定 advertiserId，這個欄位便只會包含該值。

如果演算法 owner 是合作夥伴，且是使用廣告客戶 accessor 進行擷取，系統就不會設定這個欄位。
modelDetails[]

object (CustomBiddingModelDetails)

僅供輸出。每個具有存取權的廣告客戶自訂出價模式的詳細資料。

這個欄位只能包含所查詢廣告客戶的詳細資料 (演算法 owner 是合作夥伴，且您使用廣告客戶 accessor 進行擷取)。
聯集欄位 owner。指出擁有自訂出價演算法的 DV360 實體。可以是合作夥伴或廣告客戶。owner 只能是下列其中一項：
partnerId

string (int64 format)

無法變更。擁有自訂出價演算法的合作夥伴專屬 ID。
advertiserId

string (int64 format)

無法變更。擁有自訂出價演算法的廣告客戶專屬 ID。

CustomBiddingAlgorithmType

可能的自訂出價演算法類型。

列舉
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED 未指定演算法類型，或這個版本中的不明演算法類型。
SCRIPT_BASED 透過客戶上傳的自訂出價指令碼檔案產生的演算法。
ADS_DATA_HUB_BASED 透過廣告資料中心產品建立的演算法。
GOAL_BUILDER_BASED 透過 DV3 UI 目標建立工具建立的演算法。
RULE_BASED

依據定義規則建立的演算法。這些規則是在 API 中使用 AlgorithmRules 物件定義。

這個演算法類型僅適用於許可清單中的客戶。其他嘗試使用這類類型的客戶會收到錯誤訊息。

CustomBiddingModelDetails

單一共用廣告客戶的自訂出價演算法模型詳細資料。

JSON 表示法 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
欄位
advertiserId

string (int64 format)

相關廣告客戶的專屬 ID。
readinessState

enum (ReadinessState)

自訂出價模型的完備性狀態。
suspensionState

enum (SuspensionState)

僅供輸出。自訂出價模型的停權狀態。

ReadinessState

模型完備性的可能狀態。

列舉
READINESS_STATE_UNSPECIFIED 未指定狀態，或這個版本不明。
READINESS_STATE_ACTIVE 模型已訓練並準備就緒，可以開始提供服務。
READINESS_STATE_INSUFFICIENT_DATA 資料不足，無法訓練提供模型。
READINESS_STATE_TRAINING 模型正在訓練中，尚未準備好提供服務。
READINESS_STATE_NO_VALID_SCRIPT 尚未提供用來訓練模型的有效自訂出價指令碼。此狀態只會套用至 customBiddingAlgorithmType 為 SCRIPT_BASED 的演算法。
READINESS_STATE_EVALUATION_FAILURE 已提供有效的指令碼，但評估失敗。這適用於無法於指定時間內評估的指令碼。

SuspensionState

自訂出價模型可能停權狀態。

列舉
SUSPENSION_STATE_UNSPECIFIED 未指定狀態，或這個版本不明。
SUSPENSION_STATE_ENABLED 模型已啟用 (最近使用、目前使用或已排定使用)。演算法正在主動為這個廣告主計算曝光。
SUSPENSION_STATE_DORMANT 最近並未使用過模型。雖然模型仍為 ENABLED，但如果未使用，最終會遭到停權。
SUSPENSION_STATE_SUSPENDED 模型在曝光曝光中暫停使用，因此無法放送。如果演算法已指派給這個廣告客戶的委刊項或以其他方式更新，則演算法會切換回 ENABLED 狀態，需要一段時間才能再次準備放送模型。

方法

create

 建立新的自訂出價演算法。

get

 取得自訂出價演算法。

list

 列出目前使用者能存取的自訂出價演算法，可在出價策略中使用。

patch

 更新現有的自訂出價演算法。

uploadRules

 建立 AlgorithmRules 檔案的規則參照物件。

uploadScript

 為指令碼檔案建立自訂出價指令碼參照物件。