- Resource: CustomBiddingAlgorithm
- CustomBiddingAlgorithmType
- CustomBiddingModelDetails
- ReadinessState
- SuspensionState
- Methods
Resource: CustomBiddingAlgorithm
A single custom bidding algorithm.
JSON representation |
---|
{ "name": string, "customBiddingAlgorithmId": string, "displayName": string, "entityStatus": enum ( |
Fields | |
---|---|
name |
Output only. The resource name of the custom bidding algorithm. |
custom |
Output only. The unique ID of the custom bidding algorithm. Assigned by the system. |
display |
Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes. |
entity |
Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are:
|
custom |
Required. Immutable. The type of custom bidding algorithm. |
shared |
The IDs of the advertisers who have access to this algorithm. If This field will not be set if the algorithm |
model |
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 |
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: |
|
partner |
Immutable. The unique ID of the partner that owns the custom bidding algorithm. |
advertiser |
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 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 ( |
Fields | |
---|---|
advertiser |
The unique ID of the relevant advertiser. |
readiness |
The readiness state of custom bidding model. |
suspension |
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 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 |
|
---|---|
|
Creates a new custom bidding algorithm. |
|
Gets a custom bidding algorithm. |
|
Lists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. |
|
Updates an existing custom bidding algorithm. |
|
Creates a rules reference object for an AlgorithmRules file. |
|
Creates a custom bidding script reference object for a script file. |