This is legacy documentation, and may not be complete. To see the latest documentation, if you are a marketer, refer to theMarketerssite. If you are a measurement partner, refer to theMeasurement Partnerssite.
Output only. Immutable. Name that uniquely identifies an Ads Data Hub custom bidding algorithm. It has the form customers/[customerId]/customBiddingAlgorithms/[customBiddingAlgorithmId]
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.
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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-09-18 UTC."],[[["\u003cp\u003eDefines a Custom Bidding Algorithm resource within Ads Data Hub for managing custom bidding strategies.\u003c/p\u003e\n"],["\u003cp\u003eProvides a JSON representation of the algorithm with fields like name, ID, customer ID, and query.\u003c/p\u003e\n"],["\u003cp\u003eOffers methods for managing algorithms like adding/removing advertisers, creating, deleting, executing, and updating.\u003c/p\u003e\n"],["\u003cp\u003eAlgorithm scores impressions using data from a linked Ads Data Hub customer for the last 30 days.\u003c/p\u003e\n"],["\u003cp\u003eCan be used by specified DV360 partners and advertisers.\u003c/p\u003e\n"]]],["Custom Bidding Algorithms in Ads Data Hub are defined by a unique ID, linked to an Ads Data Hub customer and DV360 partner. They have a title, a custom bidding query for impression scoring, and associated DV360 advertiser IDs. Key actions include creating, deleting, retrieving, listing, and updating algorithms. Additionally, users can add or remove DV360 advertisers. Algorithms are also capable of scoring the last 30 days of impressions.\n"],null,["# REST Resource: customers.customBiddingAlgorithms\n\n- [Resource: CustomBiddingAlgorithm](#CustomBiddingAlgorithm)\n - [JSON representation](#CustomBiddingAlgorithm.SCHEMA_REPRESENTATION)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CustomBiddingAlgorithm\n--------------------------------\n\nDefines an Ads Data Hub-managed custom bidding algorithm.\n\n| JSON representation |\n|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"customBiddingAlgorithmId\": string, \"adsDataCustomerId\": string, \"title\": string, \"customBiddingQuery\": string, \"dv360PartnerId\": string, \"dv360AdvertiserId\": [ string ], \"deleteTime\": string, \"createEmail\": string } ``` |\n\n| Fields ||\n|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Immutable. Name that uniquely identifies an Ads Data Hub custom bidding algorithm. It has the form customers/\\[customerId\\]/customBiddingAlgorithms/\\[customBiddingAlgorithmId\\] |\n| `customBiddingAlgorithmId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` 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. |\n| `adsDataCustomerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` 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. |\n| `title` | `string` Required. Custom Bidding Algorithm title, which is unique for the specified adsDataCustomerId. |\n| `customBiddingQuery` | `string` Required. Immutable. The Ads Data Hub custom bidding query resource that specifies how impressions are scored for this custom bidding algorithm. |\n| `dv360PartnerId` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` Immutable. DV360 Partner ID that this custom bidding algorithm is for. |\n| `dv360AdvertiserId[]` | `string (`[int64](https://developers.google.com/discovery/v1/type-format)` format)` DV360 Advertiser IDs that can use this custom bidding algorithm. |\n| `deleteTime` | `string (`[Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#google.protobuf.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\"`. |\n| `createEmail` | `string` Output only. Immutable. Email address of the user that created this custom bidding algorithm. |\n\n| Methods ------- ||\n|------------------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------|\n| ### [addAdvertiser](/ads-data-hub/reference/rest/v1/customers.customBiddingAlgorithms/addAdvertiser) | Add a DV360 advertiser to the custom bidding algorithm's advertisers. |\n| ### [create](/ads-data-hub/reference/rest/v1/customers.customBiddingAlgorithms/create) | Creates an Ads Data Hub-managed custom bidding algorithm. |\n| ### [delete](/ads-data-hub/reference/rest/v1/customers.customBiddingAlgorithms/delete) | Delete this custom bidding algorithm. |\n| ### [execute](/ads-data-hub/reference/rest/v1/customers.customBiddingAlgorithms/execute) | Scores the last 30 days of impressions for the custom bidding models. |\n| ### [get](/ads-data-hub/reference/rest/v1/customers.customBiddingAlgorithms/get) | Retrieves the requested Ads Data Hub-managed custom bidding algorithm. |\n| ### [list](/ads-data-hub/reference/rest/v1/customers.customBiddingAlgorithms/list) | Lists the custom bidding algorithms managed by the specified Ads Data Hub customer. |\n| ### [patch](/ads-data-hub/reference/rest/v1/customers.customBiddingAlgorithms/patch) | Updates the requested Ads Data Hub-managed custom bidding algorithm. |\n| ### [removeAdvertiser](/ads-data-hub/reference/rest/v1/customers.customBiddingAlgorithms/removeAdvertiser) | Remove a DV360 advertiser from the custom bidding algorithm's advertisers. |"]]
