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

 为脚本文件创建自定义出价脚本参考对象。