REST Resource: customers.customBiddingAlgorithms

  • A Custom Bidding Algorithm in Ads Data Hub is a resource that defines how impressions are scored using a custom bidding query.

  • Key fields of a Custom Bidding Algorithm include its unique name and ID, associated Ads Data Hub customer, title, the custom bidding query resource, linked DV360 Partner and Advertiser IDs, deletion time, and creator email.

  • Methods available for interacting with Custom Bidding Algorithms include creating, retrieving, listing, updating, and deleting them, as well as adding and removing DV360 advertisers and executing the algorithm to score impressions.

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.