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

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 尚未提供可用于训练模型的有效自定义出价脚本。此状态将仅应用于 customBiddingAlgorithmTypeSCRIPT_BASED 的算法。

自定义出价算法的可能状态。

枚举
STATE_UNSPECIFIED 此版本未指定状态或状态未知。
ENABLED 算法已启用,无论最近使用过、当前使用还是计划使用。算法正在主动对展示进行评分。
DORMANT 最近未使用过该算法。虽然该算法仍充当 ENABLED,但如果不使用,它最终会被暂停。
SUSPENDED 算法在展示评分时暂停使用,并且没有经过训练的服务模型。如果算法已分配给订单项或以其他方式进行了更新,则将切换回 ENABLED 状态,并需要一些时间来重新准备投放模型。

方法

create

创建新的自定义出价算法。

get

获取自定义出价算法。

list

列出可供当前用户访问且可在出价策略中使用的自定义出价算法。

patch

更新现有的自定义出价算法。

uploadScript

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