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.

REST Resource: customers.accessibleBiddingStrategies

Resource: AccessibleBiddingStrategy

Represents a view of BiddingStrategies owned by and shared with the customer.

In contrast to BiddingStrategy, this resource includes strategies owned by managers of the customer and shared with this customer - in addition to strategies owned by this customer. This resource does not provide metrics and only exposes a limited subset of the BiddingStrategy attributes.

JSON representation
{
  "resourceName": string,
  "id": string,
  "name": string,
  "type": enum (BiddingStrategyType),
  "ownerCustomerId": string,
  "ownerDescriptiveName": string,

  // Union field scheme can be only one of the following:
  "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

Output only. The resource name of the accessible bidding strategy. AccessibleBiddingStrategy resource names have the form:

customers/{customerId}/accessibleBiddingStrategies/{biddingStrategyId}

id

string (int64 format)

Output only. The ID of the bidding strategy.

name

string

Output only. The name of the bidding strategy.

type

enum (BiddingStrategyType)

Output only. The type of the bidding strategy.

ownerCustomerId

string (int64 format)

Output only. The ID of the Customer which owns the bidding strategy.

ownerDescriptiveName

string

Output only. descriptiveName of the Customer which owns the bidding strategy.

Union field scheme. The bidding scheme.

Only one can be set. scheme can be only one of the following:

maximizeConversionValue

object (MaximizeConversionValue)

Output only. An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.

maximizeConversions

object (MaximizeConversions)

Output only. An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.

targetCpa

object (TargetCpa)

Output only. 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)

Output only. A bidding strategy that automatically optimizes towards a desired percentage of impressions.

targetRoas

object (TargetRoas)

Output only. A bidding strategy that helps you maximize revenue while averaging a specific target Return On Ad Spend (ROAS).

targetSpend

object (TargetSpend)

Output only. A bid strategy that sets your bids to help get as many clicks as possible within your budget.

MaximizeConversionValue

An automated bidding strategy to help get the most conversion value for your campaigns while spending your budget.

JSON representation
{
  "targetRoas": number
}
Fields
targetRoas

number

Output only. The target return on ad spend (ROAS) option. If set, the bid strategy will maximize revenue while averaging the target return on ad spend. If the target ROAS is high, the bid strategy may not be able to spend the full budget. If the target ROAS is not set, the bid strategy will aim to achieve the highest possible ROAS for the budget.

MaximizeConversions

An automated bidding strategy to help get the most conversions for your campaigns while spending your budget.

JSON representation
{
  "targetCpa": string
}
Fields
targetCpa

string (int64 format)

Output only. The target cost per acquisition (CPA) option. This is the average amount that you would like to spend per acquisition.

TargetCpa

An automated bid strategy that sets bids to help get as many conversions as possible at the target cost-per-acquisition (CPA) you set.

JSON representation
{
  "targetCpaMicros": string
}
Fields
targetCpaMicros

string (int64 format)

Output only. Average CPA target. This target should be greater than or equal to minimum billable unit based on the currency for the account.

TargetImpressionShare

An automated bidding strategy that sets bids so that a certain percentage of search ads are shown at the top of the first page (or other targeted location).

JSON representation
{
  "location": enum (TargetImpressionShareLocation),
  "locationFractionMicros": string,
  "cpcBidCeilingMicros": string
}
Fields
location

enum (TargetImpressionShareLocation)

Output only. The targeted location on the search results page.

locationFractionMicros

string (int64 format)

The desired fraction of ads to be shown in the targeted location in micros. E.g. 1% equals 10,000.

cpcBidCeilingMicros

string (int64 format)

Output only. The highest CPC bid the automated bidding system is permitted to specify. This is a required field entered by the advertiser that sets the ceiling and specified in local micros.

TargetRoas

An automated bidding strategy that helps you maximize revenue while averaging a specific target return on ad spend (ROAS).

JSON representation
{
  "targetRoas": number
}
Fields
targetRoas

number

Output only. The desired revenue (based on conversion data) per unit of spend.

TargetSpend

An automated bid strategy that sets your bids to help get as many clicks as possible within your budget.

JSON representation
{
  "targetSpendMicros": string,
  "cpcBidCeilingMicros": string
}
Fields
targetSpendMicros
(deprecated)

string (int64 format)

Output only. The spend target under which to maximize clicks. A TargetSpend bidder will attempt to spend the smaller of this value or the natural throttling spend amount. If not specified, the budget is used as the spend target. This field is deprecated and should no longer be used. See https://ads-developers.googleblog.com/2020/05/reminder-about-sunset-creation-of.html for details.

cpcBidCeilingMicros

string (int64 format)

Output only. Maximum bid limit that can be set by the bid strategy. The limit applies to all keywords managed by the strategy.

Methods

get

Returns the requested accessible bidding strategy in full detail.