REST Resource: customBiddingAlgorithms

資源：CustomBiddingAlgorithm

單一自訂出價演算法。

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

  // 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 擷取，系統就不會設定這個欄位。
modelReadiness[]

object (CustomBiddingModelReadinessState)

僅供輸出。每個具備存取權的使用者，自訂出價模型的完備性狀態。

如果演算法 owner 是夥伴，且使用廣告主 accessor 擷取，這個欄位就只能包含所查詢廣告主的狀態。
customBiddingAlgorithmState

enum (State)

僅供輸出。自訂出價演算法的狀態。
聯集欄位 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 中透過目標建立工具建立的演算法。

CustomBiddingModelReadinessState

單一共用廣告主的自訂出價演算法模型完備性狀態。

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

string (int64 format)

相關廣告主的專屬 ID。
readinessState

enum (ReadinessState)

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

ReadinessState

模型完備性的可能狀態。

列舉
READINESS_STATE_UNSPECIFIED 未指定狀態，或在這個版本中不明。
READINESS_STATE_ACTIVE 模型已訓練完成，隨時可供提供。
READINESS_STATE_INSUFFICIENT_DATA 資料不足，無法訓練提供模型。
READINESS_STATE_TRAINING 模型正在訓練中，目前還無法提供。
READINESS_STATE_NO_VALID_SCRIPT 未提供用於訓練模型的有效自訂出價指令碼。這個狀態只會套用至 customBiddingAlgorithmType 為 SCRIPT_BASED 的演算法。

州

自訂出價演算法的可能狀態。

列舉
STATE_UNSPECIFIED 未指定狀態，或在這個版本中不明。
ENABLED 演算法已啟用，包括最近使用、目前正在使用或已排定使用的時間。演算法正在主動為曝光評分。
DORMANT 最近未使用演算法。雖然演算法仍然是 ENABLED，但如果未使用，最終將遭到停權。
SUSPENDED 演算法使用評分指標，且並未訓練放送模型。如果演算法已指派給委刊項或更新演算法，就會切換回「ENABLED」狀態，需要時間重新準備放送模型。

方法

create

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

get

 取得自訂出價演算法。

list

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

patch

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

uploadScript

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