REST Resource: customers.customBiddingAlgorithms

  • A Custom Bidding Algorithm is a resource used to define an Ads Data Hub-managed custom bidding algorithm, using impression data to generate scores for bidding strategies in DV360.

  • It utilizes a custom bidding query to score impressions and can be linked to specific DV360 partners and advertisers.

  • Key fields include name, customBiddingAlgorithmId, adsDataCustomerId, title, customBiddingQuery, dv360PartnerId, dv360AdvertiserId, deleteTime, and createEmail.

  • Several methods are available to manage these algorithms, such as creating, updating, deleting, executing scoring, and adding or removing advertisers.

Resource: CustomBiddingAlgorithm

Defines an Ads Data Hub-managed custom bidding algorithm.

JSON representation 
{
  "name": string,
  "customBiddingAlgorithmId": string,
  "adsDataCustomerId": string,
  "title": string,
  "customBiddingQuery": string,
  "dv360PartnerId": string,
  "dv360AdvertiserId": [
    string
  ],
  "deleteTime": string,
  "createEmail": string
}
Fields
name

string

Output only. Immutable. Name that uniquely identifies an Ads Data Hub custom bidding algorithm. It has the form customers/[customerId]/customBiddingAlgorithms/[customBiddingAlgorithmId]
customBiddingAlgorithmId

string (int64 format)

Output only. Immutable. Custom Bidding Algorithm ID. This field is generated by the service and is used in DV360 to reference this algorithm when setting the bidding strategy.
adsDataCustomerId

string (int64 format)

Immutable. Linked Ads Data Hub customer ID associated with this custom bidding algorithm. This customer's data is used when running ScoreImpressionsForCustomBidding on this custom bidding algorithm.
title

string

Required. Custom Bidding Algorithm title, which is unique for the specified adsDataCustomerId.
customBiddingQuery

string

Required. Immutable. The Ads Data Hub custom bidding query resource that specifies how impressions are scored for this custom bidding algorithm.
dv360PartnerId

string (int64 format)

Immutable. DV360 Partner ID that this custom bidding algorithm is for.
dv360AdvertiserId[]

string (int64 format)

DV360 Advertiser IDs that can use this custom bidding algorithm.
deleteTime

string (Timestamp format)

Output only. If set, the time this custom bidding algorithm was deleted. If unset, this custom bidding algortihm is active.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".
createEmail

string

Output only. Immutable. Email address of the user that created this custom bidding algorithm.

Methods

addAdvertiser

 Add a DV360 advertiser to the custom bidding algorithm's advertisers.

create

 Creates an Ads Data Hub-managed custom bidding algorithm.

delete

 Delete this custom bidding algorithm.

execute

 Scores the last 30 days of impressions for the custom bidding models.

get

 Retrieves the requested Ads Data Hub-managed custom bidding algorithm.

list

 Lists the custom bidding algorithms managed by the specified Ads Data Hub customer.

patch

 Updates the requested Ads Data Hub-managed custom bidding algorithm.

removeAdvertiser

 Remove a DV360 advertiser from the custom bidding algorithm's advertisers.