Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

BiddingStrategy

JSON representation
BiddingStrategyStatus
EnhancedCpc

A bidding strategy.

JSON representation

JSON representation
{ "resourceName": string, "status": enum (`BiddingStrategyStatus`), "type": enum (`BiddingStrategyType`), "currencyCode": string, "alignedCampaignBudgetId": string, "id": string, "name": string, "effectiveCurrencyCode": string, "campaignCount": string, "nonRemovedCampaignCount": string, // Union field `scheme` can be only one of the following: "enhancedCpc": { object (`EnhancedCpc`) }, "maximizeConversionValue": { object (`MaximizeConversionValue`) }, "maximizeConversions": { object (`MaximizeConversions`) }, "targetCpa": { object (`TargetCpa`) }, "targetImpressionShare": { object (`TargetImpressionShare`) }, "targetRoas": { object (`TargetRoas`) }, "targetSpend": { object (`TargetSpend`) } // End of list of possible types for union field `scheme`. }

{
  "resourceName": string,
  "status": enum (BiddingStrategyStatus),
  "type": enum (BiddingStrategyType),
  "currencyCode": string,
  "alignedCampaignBudgetId": string,
  "id": string,
  "name": string,
  "effectiveCurrencyCode": string,
  "campaignCount": string,
  "nonRemovedCampaignCount": string,

  // Union field scheme can be only one of the following:
  "enhancedCpc": {
    object (EnhancedCpc)
  },
  "maximizeConversionValue": {
    object (MaximizeConversionValue)
  },
  "maximizeConversions": {
    object (MaximizeConversions)
  },
  "targetCpa": {
    object (TargetCpa)
  },
  "targetImpressionShare": {
    object (TargetImpressionShare)
  },
  "targetRoas": {
    object (TargetRoas)
  },
  "targetSpend": {
    object (TargetSpend)
  }
  // End of list of possible types for union field scheme.
}

Fields
`resourceName`	`string` Immutable. The resource name of the bidding strategy. Bidding strategy resource names have the form: `customers/{customerId}/biddingStrategies/{biddingStrategyId}`
`status`	`enum (BiddingStrategyStatus)` Output only. The status of the bidding strategy. This field is read-only.
`type`	`enum (BiddingStrategyType)` Output only. The type of the bidding strategy. Create a bidding strategy by setting the bidding scheme. This field is read-only.
`currencyCode`	`string` Immutable. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this currency can be set on creation and defaults to the manager customer's currency. For serving customers, this field cannot be set; all strategies in a serving customer implicitly use the serving customer's currency. In all cases the effectiveCurrencyCode field returns the currency used by the strategy.
`alignedCampaignBudgetId`	`string (int64 format)` ID of the campaign budget that this portfolio bidding strategy is aligned with. When a portfolio and a campaign budget are aligned, that means that they are attached to the same set of campaigns. After a bidding strategy is aligned with a campaign budget, campaigns that are added to the bidding strategy must also use the aligned campaign budget.
`id`	`string (int64 format)` Output only. The ID of the bidding strategy.
`name`	`string` The name of the bidding strategy. All bidding strategies within an account must be named distinctly. The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).
`effectiveCurrencyCode`	`string` Output only. The currency used by the bidding strategy (ISO 4217 three-letter code). For bidding strategies in manager customers, this is the currency set by the advertiser when creating the strategy. For serving customers, this is the customer's currencyCode. Bidding strategy metrics are reported in this currency. This field is read-only.
`campaignCount`	`string (int64 format)` Output only. The number of campaigns attached to this bidding strategy. This field is read-only.
`nonRemovedCampaignCount`	`string (int64 format)` Output only. The number of non-removed campaigns attached to this bidding strategy. This field is read-only.
Union field `scheme`. The bidding scheme. Only one can be set. `scheme` can be only one of the following:
`enhancedCpc`	`object (EnhancedCpc)` A bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.
`maximizeConversionValue`	`object (MaximizeConversionValue)` An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.
`maximizeConversions`	`object (MaximizeConversions)` An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.
`targetCpa`	`object (TargetCpa)` A bidding strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.
`targetImpressionShare`	`object (TargetImpressionShare)` A bidding strategy that automatically optimizes towards a chosen percentage of impressions.
`targetRoas`	`object (TargetRoas)` A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).
`targetSpend`	`object (TargetSpend)` A bid strategy that sets your bids to help get as many clicks as possible within your budget.

BiddingStrategyStatus

The possible statuses of a BiddingStrategy.

Enums
`UNSPECIFIED`	No value has been specified.
`UNKNOWN`	The received value is not known in this version. This is a response-only value.
`ENABLED`	The bidding strategy is enabled.
`REMOVED`	The bidding strategy is removed.

EnhancedCpc

This type has no fields.

An automated bidding strategy that raises bids for clicks that seem more likely to lead to a conversion and lowers them for clicks where they seem less likely.

This bidding strategy is deprecated and cannot be created anymore. Use ManualCpc with enhancedCpcEnabled set to true for equivalent functionality.