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

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