REST Resource: customBiddingAlgorithms

資源：CustomBiddingAlgorithm

單一自訂出價演算法。

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "partnerId": string,
  "advertiserId": string
  // End of mutually exclusive fields.
}
欄位
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 擷取時，這個欄位才能包含所查詢廣告主的詳細資料。
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

(選用步驟) 不可變動。指定管理這項演算法的第三方最佳化合作夥伴。
用來識別擁有自訂出價演算法的 DV360 實體。擁有者可以是夥伴或廣告主。以下列出互斥欄位。回應中最多會設定一個欄位：
partnerId

string (int64 format)

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

string (int64 format)

不可變動。擁有自訂出價演算法的廣告主專屬 ID。
互斥欄位的結尾。

CustomBiddingAlgorithmType

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

列舉
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED 這個版本未指定演算法類型或類型不明。
SCRIPT_BASED 透過客戶上傳的自訂出價指令碼檔案產生演算法。
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 狀態，需要時間再次準備放送模型。

ThirdPartyOptimizationPartnerType

可能的第三方最佳化合作夥伴類型。

列舉
UNKNOWN 這個版本未指定類型值，或類型值不明。
SCIBIDS DV3 合作夥伴/廣告主可與之合作的第三方資料科學服務供應商。
ADELAIDE DV3 合作夥伴/廣告主可與之合作的第三方注意力評估服務供應商。

方法

create

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

get

 取得自訂出價演算法。

list

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

patch

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

uploadRules

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

uploadScript

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