REST Resource: customBiddingAlgorithms.rules

资源:CustomBiddingAlgorithmRules

单个自定义出价算法规则。

JSON 表示法
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "customBiddingAlgorithmRulesId": string,
  "createTime": string,
  "active": boolean,
  "state": enum (State),
  "error": {
    object (CustomBiddingAlgorithmRulesError)
  },
  "rules": {
    object (CustomBiddingAlgorithmRulesRef)
  }
}
字段
name

string

仅限输出。规则资源的资源名称。

customBiddingAlgorithmId

string (int64 format)

仅限输出。规则资源所属的自定义出价算法的唯一 ID。

customBiddingAlgorithmRulesId

string (int64 format)

仅限输出。规则资源的唯一 ID。

createTime

string (Timestamp format)

仅限输出。规则资源的创建时间。

采用 RFC 3339 标准,生成的输出将始终进行 Z 规范化(即转换为 UTC 零时区格式并在末尾附加 Z),并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例:"2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

active

boolean

仅限输出。父级算法当前是否正在使用规则资源进行评分。

state

enum (State)

仅限输出。规则资源的状态。

error

object (CustomBiddingAlgorithmRulesError)

仅限输出。被拒规则资源的错误代码。仅当状态为 REJECTED 时,系统才会填充此字段。

rules

object (CustomBiddingAlgorithmRulesRef)

必需。不可变。对已上传 AlgorithmRules 文件的引用。

州

CustomBiddingAlgorithmRules 资源的可能状态。

枚举
STATE_UNSPECIFIED 此版本中未指定规则状态,或规则状态未知。
ACCEPTED 这些规则已被接受,可用于对展示进行评分。
REJECTED 规则已被后端流水线拒绝。这些内容可能存在错误。

CustomBiddingAlgorithmRulesError

CustomBiddingAlgorithmRules 资源的出错提示。

JSON 表示法
{
  "errorCode": enum (ErrorCode)
}
字段
errorCode

enum (ErrorCode)

错误类型。

ErrorCode

CustomBiddingAlgorithmRules 资源的可能错误代码。

枚举
ERROR_CODE_UNSPECIFIED 此版本中未指定错误,或错误未知。
SYNTAX_ERROR 规则存在语法错误。
CONSTRAINT_VIOLATION_ERROR 这些规则存在违反限制条件的错误。
INTERNAL_ERROR 处理规则时抛出了内部错误。

CustomBiddingAlgorithmRulesRef

对已上传 AlgorithmRules 文件的引用。使用 customBiddingAlgorithms.uploadRules 检索要将新 AlgorithmRules 文件上传到的位置。

JSON 表示法
{
  "resourceName": string
}
字段
resourceName

string

要在 media.download 中使用的资源名称,用于下载规则文件。或 media.upload,以上传规则文件。资源名称的格式为 customBiddingAlgorithms/{customBiddingAlgorithmId}/rulesRef/{ref_id}。

方法

create

创建新的规则资源。

get

检索规则资源。

list

列出属于给定算法的规则资源。