REST Resource: customBiddingAlgorithms

Resource: CustomBiddingAlgorithm

A single custom bidding algorithm.

JSON representation 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "displayName": string,
  "entityStatus": enum (EntityStatus),
  "customBiddingAlgorithmType": enum (CustomBiddingAlgorithmType),
  "sharedAdvertiserIds": [
    string
  ],
  "modelDetails": [
    {
      object (CustomBiddingModelDetails)
    }
  ],

  // Union field owner can be only one of the following:
  "partnerId": string,
  "advertiserId": string
  // End of list of possible types for union field owner.
}
Fields
name

string

Output only. The resource name of the custom bidding algorithm.
customBiddingAlgorithmId

string (int64 format)

Output only. The unique ID of the custom bidding algorithm. Assigned by the system.
displayName

string

Required. The display name of the custom bidding algorithm.

Must be UTF-8 encoded with a maximum size of 240 bytes.
entityStatus

enum (EntityStatus)

Controls whether or not the custom bidding algorithm can be used as a bidding strategy.

Accepted values are:

  • ENTITY_STATUS_ACTIVE
  • ENTITY_STATUS_ARCHIVED
customBiddingAlgorithmType

enum (CustomBiddingAlgorithmType)

Required. Immutable. The type of custom bidding algorithm.
sharedAdvertiserIds[]

string (int64 format)

The IDs of the advertisers who have access to this algorithm. If advertiserId is set, this field will only consist of that value.

This field will not be set if the algorithm owner is a partner and is being retrieved using an advertiser accessor.
modelDetails[]

object (CustomBiddingModelDetails)

Output only. The details of custom bidding models for each advertiser who has access.

This field may only include the details of the queried advertiser if the algorithm owner is a partner and is being retrieved using an advertiser accessor.
Union field owner. Identifies the DV360 entity that owns the custom bidding algorithm. It can be either a partner or an advertiser. owner can be only one of the following:
partnerId

string (int64 format)

Immutable. The unique ID of the partner that owns the custom bidding algorithm.
advertiserId

string (int64 format)

Immutable. The unique ID of the advertiser that owns the custom bidding algorithm.

CustomBiddingAlgorithmType

Possible types of custom bidding algorithms.

Enums
CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED Algorithm type is not specified or is unknown in this version.
SCRIPT_BASED Algorithm generated through customer-uploaded custom bidding script files.
ADS_DATA_HUB_BASED Algorithm created through Ads Data Hub product.
GOAL_BUILDER_BASED Algorithm created through goal builder in DV3 UI.
RULE_BASED

Algorithm based in defined rules. These rules are defined in the API using the AlgorithmRules object.

This algorithm type is only available to allowlisted customers. Other customers attempting to use this type will receive an error.

CustomBiddingModelDetails

The details of a custom bidding algorithm model for a single shared advertiser.

JSON representation 
{
  "advertiserId": string,
  "readinessState": enum (ReadinessState),
  "suspensionState": enum (SuspensionState)
}
Fields
advertiserId

string (int64 format)

The unique ID of the relevant advertiser.
readinessState

enum (ReadinessState)

The readiness state of custom bidding model.
suspensionState

enum (SuspensionState)

Output only. The suspension state of custom bidding model.

ReadinessState

Possible states of model readiness.

Enums
READINESS_STATE_UNSPECIFIED State is not specified or is unknown in this version.
READINESS_STATE_ACTIVE The model is trained and ready for serving.
READINESS_STATE_INSUFFICIENT_DATA There is not enough data to train the serving model.
READINESS_STATE_TRAINING The model is training and not ready for serving.
READINESS_STATE_NO_VALID_SCRIPT A valid custom bidding script has not been provided with which to train the model. This state will only be applied to algorithms whose customBiddingAlgorithmType is SCRIPT_BASED.
READINESS_STATE_EVALUATION_FAILURE A valid script was provided but failed evaluation. This is applicable for scripts that could not be evaluated in the alloted time.

SuspensionState

Possible suspension states of custom bidding models.

Enums
SUSPENSION_STATE_UNSPECIFIED State is not specified or is unknown in this version.
SUSPENSION_STATE_ENABLED Model is enabled, either recently used, currently used or scheduled to be used. The algorithm is actively scoring impressions for this advertiser.
SUSPENSION_STATE_DORMANT Model has not been used recently. Although the model still acts as ENABLED, it will eventually be suspended if not used.
SUSPENSION_STATE_SUSPENDED Model is suspended from scoring impressions and cannot serve. If the algorithm is assigned to a line item under this advertiser or otherwise updated, it will switch back to the ENABLED state and require time to prepare the serving model again.

Methods

create

 Creates a new custom bidding algorithm.

get

 Gets a custom bidding algorithm.

list

 Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies.

patch

 Updates an existing custom bidding algorithm.

uploadRules

 Creates a rules reference object for an AlgorithmRules file.

uploadScript

 Creates a custom bidding script reference object for a script file.