customBiddingAlgorithms

Changed on

Creates a new custom bidding algorithm. Returns the newly created custom bidding algorithm if successful.

post/v4/customBiddingAlgorithms

Request

  • Base URL: https://displayvideo.googleapis.com
  • URL: https://displayvideo.googleapis.com/v4/customBiddingAlgorithms
  • Auth: OAuth 2 (implicit, authorization URL https://accounts.google.com/o/oauth2/auth, scopes: https://www.googleapis.com/auth/display-video) and OAuth 2 (authorization code, authorization URL https://accounts.google.com/o/oauth2/auth, token URL https://accounts.google.com/o/oauth2/token, scopes: https://www.googleapis.com/auth/display-video)

Request body

advertiserIdstring int64

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

customBiddingAlgorithmIdstring int64

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

customBiddingAlgorithmType'CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED' | 'SCRIPT_BASED' | 'RULE_BASED'

Required. Immutable. The type of custom bidding algorithm.

displayNamestring

Required. The display name of the custom bidding algorithm. Must be UTF-8 encoded with a maximum size of 240 bytes.

entityStatus'ENTITY_STATUS_UNSPECIFIED' | 'ENTITY_STATUS_ACTIVE' | 'ENTITY_STATUS_ARCHIVED' | 'ENTITY_STATUS_DRAFT' | 'ENTITY_STATUS_PAUSED' | 'ENTITY_STATUS_SCHEDULED_FOR_DELETION'

Controls whether or not the custom bidding algorithm can be used as a bidding strategy. Accepted values are: * ENTITY_STATUS_ACTIVE * ENTITY_STATUS_ARCHIVED

namestring

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

partnerIdstring int64

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

sharedAdvertiserIdsstring[]

The 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.

thirdPartyOptimizationPartner'UNKNOWN' | 'SCIBIDS' | 'ADELAIDE'

Optional. Immutable. Designates the third party optimization partner that manages this algorithm.

Response

Successful response

Changes

  • 52cdb4885336Revision changes
    • breaking

      removed the request body

    • breaking

      removed the media type */* for the response with the status