REST Resource: customBiddingAlgorithms.rules

  • Custom Bidding Algorithm Rules represent a single set of rules for a custom bidding algorithm.

  • The state of the rules can be ACCEPTED, meaning they are used for scoring, or REJECTED, indicating an error.

  • Errors in custom bidding algorithm rules are described by an ErrorCode which can indicate syntax, constraint violations, or internal issues.

  • A CustomBiddingAlgorithmRulesRef provides a reference to the uploaded algorithm rules file.

  • Methods are available to create, get, and list custom bidding algorithm rules resources.

Resource: CustomBiddingAlgorithmRules

A single custom bidding algorithm rules.

JSON representation 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "customBiddingAlgorithmRulesId": string,
  "createTime": string,
  "active": boolean,
  "state": enum (State),
  "error": {
    object (CustomBiddingAlgorithmRulesError)
  },
  "rules": {
    object (CustomBiddingAlgorithmRulesRef)
  }
}
Fields
name

string

Output only. The resource name of the rules resource.
customBiddingAlgorithmId

string (int64 format)

Output only. The unique ID of the custom bidding algorithm that the rules resource belongs to.
customBiddingAlgorithmRulesId

string (int64 format)

Output only. The unique ID of the rules resource.
createTime

string (Timestamp format)

Output only. The time when the rules resource was created.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
active

boolean

Output only. Whether the rules resource is currently being used for scoring by the parent algorithm.
state

enum (State)

Output only. The state of the rules resource.
error

object (CustomBiddingAlgorithmRulesError)

Output only. Error code of the rejected rules resource. This field will only be populated when the state is REJECTED.
rules

object (CustomBiddingAlgorithmRulesRef)

Required. Immutable. The reference to the uploaded AlgorithmRules file.

State

Possible states of a CustomBiddingAlgorithmRules resource.

Enums
STATE_UNSPECIFIED The rules state are unspecified or unknown in this version.
ACCEPTED The rules have been accepted for scoring impressions.
REJECTED The rules have been rejected by backend pipelines. They may have errors.

CustomBiddingAlgorithmRulesError

An error message for a CustomBiddingAlgorithmRules resource.

JSON representation 
{
  "errorCode": enum (ErrorCode)
}
Fields
errorCode

enum (ErrorCode)

The type of error.

ErrorCode

Possible error codes of a CustomBiddingAlgorithmRules resource.

Enums
ERROR_CODE_UNSPECIFIED The error is not specified or is unknown in this version.
SYNTAX_ERROR The rules have a syntax error.
CONSTRAINT_VIOLATION_ERROR The rules have a constraint violation error.
INTERNAL_ERROR Internal errors were thrown while processing the rules.

CustomBiddingAlgorithmRulesRef

The reference to the uploaded AlgorithmRules file. Retrieve the location to upload new AlgorithmRules file to using customBiddingAlgorithms.uploadRules.

JSON representation 
{
  "resourceName": string
}
Fields
resourceName

string

A resource name to be used in media.download to download the rules files. Or media.upload to upload the rules files. Resource names have the format customBiddingAlgorithms/{customBiddingAlgorithmId}/rulesRef/{ref_id}.

Methods

create

 Creates a new rules resource.

get

 Retrieves a rules resource.

list

 Lists rules resources that belong to the given algorithm.