Skip to main content

custom_bidding_algorithms

Overview

Namecustom_bidding_algorithms
TypeResource
Idgoogledevelopers.displayvideo.custom_bidding_algorithms

Fields

NameDatatypeDescription
namestringOutput only. The resource name of the custom bidding algorithm.
entityStatusstringControls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: ENTITY_STATUS_ACTIVE ENTITY_STATUS_ARCHIVED
displayNamestringRequired. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.
sharedAdvertiserIdsarrayThe IDs of the advertisers who have access to this algorithm. If advertiser_id 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.
modelDetailsarrayOutput 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.
advertiserIdstringImmutable. The unique ID of the advertiser that owns the custom bidding algorithm.
customBiddingAlgorithmIdstringOutput only. The unique ID of the custom bidding algorithm. Assigned by the system.
customBiddingAlgorithmTypestringRequired. Immutable. The type of custom bidding algorithm.
partnerIdstringImmutable. The unique ID of the partner that owns the custom bidding algorithm.

Methods

NameAccessible byRequired ParamsDescription
customBiddingAlgorithms_getSELECTcustomBiddingAlgorithmsIdGets a custom bidding algorithm.
customBiddingAlgorithms_listSELECTLists custom bidding algorithms that are accessible to the current user and can be used in bidding stratgies. The order is defined by the order_by parameter.
customBiddingAlgorithms_createINSERTCreates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.
customBiddingAlgorithms_patchEXECcustomBiddingAlgorithmsIdUpdates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful.
customBiddingAlgorithms_uploadScriptEXECcustomBiddingAlgorithmsIdCreates a custom bidding script reference object for a script file. The resulting reference object provides a resource path to which the script file should be uploaded. This reference object should be included in when creating a new custom bidding script object.