Patch v4custombiddingalgorithms+custombiddingalgorithmid

v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-13177414729.5 KB

customBiddingAlgorithms

Updates an existing custom bidding algorithm. Returns the updated custom bidding algorithm if successful. Requests updating a custom bidding algorithm assigned to a line item will return an error.

patch/v4/customBiddingAlgorithms/{+customBiddingAlgorithmId}

Path parameters

customBiddingAlgorithmIdstring required

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

Query parameters

updateMaskstring

Required. The mask to control which fields to update.

Request body

customBiddingAlgorithmIdstring int64

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

displayNamestring

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

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.

advertiserIdstring int64

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

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

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

partnerIdstring int64

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

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'CUSTOM_BIDDING_ALGORITHM_TYPE_UNSPECIFIED' | 'SCRIPT_BASED' | 'RULE_BASED'

Required. Immutable. The type of custom bidding algorithm.

namestring

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

Response

Successful response