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 界面中的目标构建工具创建的算法。
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

 为脚本文件创建自定义出价脚本引用对象。