AdsApp.​BiddingStrategyArgsBuilder

Builder for setting arguments when applying a bidding strategy to a campaign.

Methods:

MemberTypeDescription
args AdsApp.BiddingStrategyArgs Returns a JavaScript object representation of the specified args.
withCpcBidCeiling AdsApp.BiddingStrategyArgsBuilder Sets the cpc bid ceiling for a bidding strategy (specified in the account's currency).
withEnhancedCpcEnabled AdsApp.BiddingStrategyArgsBuilder Enables or disables enhanced cpc for a bidding strategy.
withLocationFraction AdsApp.BiddingStrategyArgsBuilder Sets the desired percentage of ads to be shown in the targeted location.
withLocationType AdsApp.BiddingStrategyArgsBuilder Sets the targeted location for ads.
withTargetRoas AdsApp.BiddingStrategyArgsBuilder Sets the target roas for a bidding strategy.

args()

Returns a JavaScript object representation of the specified args.

Return values:

TypeDescription
AdsApp.BiddingStrategyArgs A JavaScript object representation of the builder.

withCpcBidCeiling(cpc)

Sets the cpc bid ceiling for a bidding strategy (specified in the account's currency).

Arguments:

NameTypeDescription
cpc double The cpc bid ceiling.

Return values:

TypeDescription
AdsApp.BiddingStrategyArgsBuilder A BiddingStrategyArgsBuilder with the specified cpc bid ceiling.

withEnhancedCpcEnabled(enhancedCpcEnabled)

Enables or disables enhanced cpc for a bidding strategy.

Arguments:

NameTypeDescription
enhancedCpcEnabled boolean Whether enhanced cpc is enabled or disabled.

Return values:

TypeDescription
AdsApp.BiddingStrategyArgsBuilder A BiddingStrategyArgsBuilder with the specified value for enhanced cpc.

withLocationFraction(locationFraction)

Sets the desired percentage of ads to be shown in the targeted location. Specified as a percentage from 0-100. To specify the targeted location, call withLocationType.

Arguments:

NameTypeDescription
locationFraction double The location fraction.

Return values:

TypeDescription
AdsApp.BiddingStrategyArgsBuilder A BiddingStrategyArgsBuilder with the specified location fraction.

withLocationType(locationType)

Sets the targeted location for ads. Accepted values are: ANYWHERE_ON_PAGE, TOP_OF_PAGE, ABSOLUTE_TOP_OF_PAGE

To specify the desired percentage of ads to show at the targeted location, call withLocationFraction.

Arguments:

NameTypeDescription
locationType String The location type.

Return values:

TypeDescription
AdsApp.BiddingStrategyArgsBuilder A BiddingStrategyArgsBuilder with the specified location type.

withTargetRoas(targetRoas)

Sets the target roas for a bidding strategy. This is the desired revenue (based on conversion data) per unit of spend. Value must be between 0.01 and 1000.0 inclusive.

Arguments:

NameTypeDescription
targetRoas double The cpc bid floor.

Return values:

TypeDescription
AdsApp.BiddingStrategyArgsBuilder A BiddingStrategyArgsBuilder with the specified target roas.