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),

  // 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 进行检索。
thirdPartyOptimizationPartner

enum (ThirdPartyOptimizationPartnerType)

可选。不可变。指定管理相应算法的第三方优化合作伙伴。
联合字段 owner。用于标识拥有自定义出价算法的 DV360 实体。可以是合作伙伴，也可以是广告客户。owner 只能是下列其中一项：
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

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