AdsApp.​BiddingStrategy

AI-generated Key Takeaways

• A flexible bidding strategy is an account-level object that stores shared bidding configuration data.

• You can retrieve ad groups, campaigns, keywords, shopping ad groups, and shopping campaigns associated with a bidding strategy.

• Methods are available to get the bidding strategy's ID, name, resource name, entity type, and specific type.

• You can get performance statistics for a bidding strategy for standard or custom date ranges.

Represents a flexible bidding strategy. Bidding strategies store shared bidding configuration data and are account-level objects. For more information, refer to Using flexible bid strategies.

Methods:

Member	Type	Description
adGroups()	AdsApp.AdGroupSelector	Returns the selector of all ad groups that use this bidding strategy.
campaigns()	AdsApp.CampaignSelector	Returns the selector of all search and display campaigns that use this bidding strategy.
getEntityType()	String	Returns the type of this entity as a String, in this case, "BiddingStrategy".
getId()	String	Returns the ID of the bidding strategy.
getName()	String	Returns the name of the bidding strategy.
getResourceName()	String	Returns the resource name of the bidding strategy.
getStatsFor(dateRange)	AdsApp.Stats	Returns stats for the specified date range.
getStatsFor(dateFrom, dateTo)	AdsApp.Stats	Returns stats for the specified custom date range.
getType()	String	Returns the type of the bidding strategy.
keywords()	AdsApp.KeywordSelector	Returns the selector of all keywords that use this bidding strategy.
shoppingAdGroups()	AdsApp.ShoppingAdGroupSelector	Returns the selector of all shopping ad groups that use this bidding strategy.
shoppingCampaigns()	AdsApp.ShoppingCampaignSelector	Returns the selector of all shopping campaigns that use this bidding strategy.

adGroups()

Returns the selector of all ad groups that use this bidding strategy.

Return values:

Type	Description
AdsApp.AdGroupSelector	The selector of all ad groups that use this bidding strategy.

campaigns()

Returns the selector of all search and display campaigns that use this bidding strategy.

Return values:

Type	Description
AdsApp.CampaignSelector	The selector of all search and display campaigns that use this bidding strategy.

getEntityType()

Returns the type of this entity as a String, in this case, "BiddingStrategy".

Return values:

Type	Description
String	Type of this entity: "BiddingStrategy".

getId()

Returns the ID of the bidding strategy.

Return values:

Type	Description
String	The ID of the bidding strategy.

getName()

Returns the name of the bidding strategy.

Return values:

Type	Description
String	Name of the bidding strategy.

getResourceName()

Returns the resource name of the bidding strategy.

Return values:

Type	Description
String	The resource name of the bidding strategy.

getStatsFor(dateRange)

Returns stats for the specified date range. Supported values:

TODAY, YESTERDAY, LAST_7_DAYS, THIS_WEEK_SUN_TODAY, LAST_WEEK, LAST_14_DAYS, LAST_30_DAYS, LAST_BUSINESS_WEEK, LAST_WEEK_SUN_SAT, THIS_MONTH, LAST_MONTH, ALL_TIME.

Example:

var stats = biddingStrategy.getStatsFor("THIS_MONTH");

Arguments:

Name	Type	Description
dateRange	String	Date range for which the stats are requested.

Return values:

Type	Description
AdsApp.Stats	The stats for the specified date range.

getStatsFor(dateFrom, dateTo)

Returns stats for the specified custom date range. Both parameters can be either an object containing year, month, and day fields, or an 8-digit string in YYYYMMDD form. For instance, March 24th, 2013 is represented as either {year: 2013, month: 3, day: 24} or "20130324". The date range is inclusive on both ends, so forDateRange("20130324", "20130324") defines a range of a single day.

Arguments:

Name	Type	Description
dateFrom	Object	Start date of the date range. Must be either a string in YYYYMMDD form, or an object with year, month and day properties.
dateTo	Object	End date of the date range. Must be either a string in YYYYMMDD form, or an object with year, month and day properties.

Return values:

Type	Description
AdsApp.Stats	The stats for the specified date range.

getType()

Returns the type of the bidding strategy.

Return values:

Type	Description
String	Type of the bidding strategy.

keywords()

Returns the selector of all keywords that use this bidding strategy.

Return values:

Type	Description
AdsApp.KeywordSelector	The selector of all keywords that use this bidding strategy.

shoppingAdGroups()

Returns the selector of all shopping ad groups that use this bidding strategy.

Return values:

Type	Description
AdsApp.ShoppingAdGroupSelector	The selector of all shopping ad groups that use this bidding strategy.

shoppingCampaigns()

Returns the selector of all shopping campaigns that use this bidding strategy.

Return values:

Type	Description
AdsApp.ShoppingCampaignSelector	The selector of all shopping campaigns that use this bidding strategy.