AdsApp.ShoppingAdGroup

Represents a shopping ad group.

Methods:

Member	Type	Description
ads	`AdsApp.ProductAdSelector`	Returns the selector of all product ads in the shopping ad group.
applyLabel	`void`	Applies a label to the shopping ad group.
bidding	`AdsApp.ShoppingAdGroupBidding`	Provides access to this shopping ad group's bidding fields.
createNegativeKeyword	`void`	Creates a new negative keyword with the specified text.
createRootProductGroup	`AdsApp.ProductGroupOperation`	Creates the root product group of the shopping ad group (if one doesn't already exist).
devices	`AdsApp.AdGroupDevices`	Returns an AdGroupDevices instance associated with the shopping ad group.
enable	`void`	Enables the shopping ad group.
getCampaign	`AdsApp.ShoppingCampaign`	Returns the shopping campaign to which this shopping ad group belongs.
getEntityType	`String`	Returns the type of this entity as a `String`, in this case, `"ShoppingAdGroup"`.
getId	`String`	Returns the ID of the shopping ad group.
~~getMobileBidModifier~~	`double`	Returns the mobile bid modifier for this ad group.
getName	`String`	Returns the name of the shopping ad group.
getResourceName	`String`	Returns the resource name of the shopping ad group.
getStatsFor	`AdsApp.Stats`	Returns stats for the specified date range.
getStatsFor	`AdsApp.Stats`	Returns stats for the specified custom date range.
isEnabled	`boolean`	Returns `true` if the shopping ad group is enabled.
isPaused	`boolean`	Returns `true` if the shopping ad group is paused.
isRemoved	`boolean`	Returns `true` if the shopping ad group is removed.
labels	`AdsApp.LabelSelector`	Creates a selector of all labels applied to the shopping ad group.
negativeKeywords	`AdsApp.NegativeKeywordSelector`	Returns a selector of all negative keywords in the ad group.
newAdBuilder	`AdsApp.ProductAdBuilder`	Returns a product ad builder.
pause	`void`	Pauses the shopping ad group.
productGroups	`AdsApp.ProductGroupSelector`	Returns the selector of all product groups in the shopping ad group.
recommendations	`AdsApp.RecommendationSelector`	Returns the selector of all recommendations for this ad group.
removeLabel	`void`	Removes a label from the shopping ad group.
rootProductGroup	`AdsApp.ProductGroup`	Returns the root product group of the shopping ad group or `null` if one does not exist.
~~setMobileBidModifier~~	`void`	Sets the mobile bid modifier for this ad group to the specified value.
setName	`void`	Sets the name of the shopping ad group.
targeting	`AdsApp.ShoppingAdGroupTargeting`	Provides access to this shopping ad group's targeting criteria: audiences

`ads()`

Returns the selector of all product ads in the shopping ad group.

Return values:

Type	Description
`AdsApp.ProductAdSelector`	The selector of all product ads in the shopping ad group.

`applyLabel(name)`

Applies a label to the shopping ad group. name of the label is case-sensitive. Operation will fail if the label with the specified name does not already exist in the account.

Note that the shopping ad group cannot have more than 50 labels.

Returns nothing.

Arguments:

Name	Type	Description
name	`String`	Name of the label to apply.

`bidding()`

Provides access to this shopping ad group's bidding fields.

Return values:

Type	Description
`AdsApp.ShoppingAdGroupBidding`	Access to this shopping ad group's bidding fields.

`createNegativeKeyword(keywordText)`

Creates a new negative keyword with the specified text.

Match type for the new negative keyword is specified as follows:

createNegativeKeyword("shoes") - broad match.
createNegativeKeyword("\"shoes\"") - phrase match.
createNegativeKeyword("[leather shoes]") - exact match.

Returns nothing.

Arguments:

Name	Type	Description
keywordText	`String`	The text of the new negative keyword.

`createRootProductGroup()`

Creates the root product group of the shopping ad group (if one doesn't already exist). Newly constructed shopping ad groups as well as ones modified by other means may not have any product groups.

Return values:

Type	Description
`AdsApp.ProductGroupOperation`	The operation resulting from trying to create the root product group for this shopping ad group.

`devices()`

Returns an AdGroupDevices instance associated with the shopping ad group.

Return values:

Type	Description
`AdsApp.AdGroupDevices`	An AdGroupDevices instance associated with the shopping ad group.

`enable()`

Enables the shopping ad group.

Returns nothing.

`getCampaign()`

Returns the shopping campaign to which this shopping ad group belongs.

Return values:

Type	Description
`AdsApp.ShoppingCampaign`	The shopping campaign to which this shopping ad group belongs.

`getEntityType()`

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

Return values:

Type	Description
`String`	Type of this entity: `"ShoppingAdGroup"`.

`getId()`

Returns the ID of the shopping ad group.

Return values:

Type	Description
`String`	The ID of the shopping ad group.

`getMobileBidModifier()`

Returns the mobile bid modifier for this ad group.

The bid modifier is a multiplier applied to the shopping ad group's bids on mobile devices. So, for instance, a bid modifier of 1.1 increases the bid to 110% of its original value, and changes a bid of $5.00 to $5.50.

Note that when you set a mobile bid modifier at both campaign- and ad group-level in a single campaign, the shopping ad group mobile bid modifier will be used when determining your bid.

For more information about bid modifiers, please see the Google Ads Help Center article.

Return values:

Type	Description
`double`	The mobile bid modifier.

`getName()`

Returns the name of the shopping ad group.

Return values:

Type	Description
`String`	Name of the shopping ad group.

`getResourceName()`

Returns the resource name of the shopping ad group.

Return values:

Type	Description
`String`	The resource name of the shopping ad group.

`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 = shoppingAdGroup.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.

`isEnabled()`

Returns true if the shopping ad group is enabled.

Return values:

Type	Description
`boolean`	`true` if the shopping ad group is enabled.

`isPaused()`

Returns true if the shopping ad group is paused.

Return values:

Type	Description
`boolean`	`true` if the shopping ad group is paused.

`isRemoved()`

Returns true if the shopping ad group is removed.

Return values:

Type	Description
`boolean`	`true` if the shopping ad group is removed.

`labels()`

Creates a selector of all labels applied to the shopping ad group.

Return values:

Type	Description
`AdsApp.LabelSelector`	Selector of all labels applied to the shopping ad group.

`negativeKeywords()`

Returns a selector of all negative keywords in the ad group.

Return values:

Type	Description
`AdsApp.NegativeKeywordSelector`	The selector of all negative keywords in the ad group.

`newAdBuilder()`

Returns a product ad builder.

Return values:

Type	Description
`AdsApp.ProductAdBuilder`	A product ad builder.

`pause()`

Pauses the shopping ad group.

Returns nothing.

`productGroups()`

Returns the selector of all product groups in the shopping ad group.

Return values:

Type	Description
`AdsApp.ProductGroupSelector`	The selector of all product groups in the shopping ad group.

`recommendations()`

Returns the selector of all recommendations for this ad group.

Return values:

Type	Description
`AdsApp.RecommendationSelector`	The selector of all recommendations for this ad group.

`removeLabel(name)`

Removes a label from the shopping ad group. name of the label is case-sensitive. Operation will fail if the label with the specified name does not already exist in the account.

Returns nothing.

Arguments:

Name	Type	Description
name	`String`	Name of the label.

`rootProductGroup()`

Returns the root product group of the shopping ad group or null if one does not exist.

Return values:

Type	Description
`AdsApp.ProductGroup`	The root product group of the shopping ad group or `null` if one does not exist.

`setMobileBidModifier(modifier)`

Sets the mobile bid modifier for this ad group to the specified value.

Note that when you set a mobile bid modifier at both campaign- and ad group-level in a single campaign, the shopping ad group mobile bid modifier will be used when determining your bid.

For more information about bid modifiers, please see the Google Ads Help Center article.

Returns nothing.

Arguments:

Name	Type	Description
modifier	`double`	The new mobile bid modifier.

`setName(name)`

Sets the name of the shopping ad group.

Returns nothing.

Arguments:

Name	Type	Description
name	`String`	The new name for the shopping ad group.

`targeting()`

Provides access to this shopping ad group's targeting criteria: audiences

ShoppingAdGroupAudience

Return values:

Type	Description
`AdsApp.ShoppingAdGroupTargeting`	Access to this ad group's targeting criteria.

AdsApp.​ShoppingAdGroup

Methods:

ads()

Return values:

applyLabel(name)

Arguments:

bidding()

Return values:

createNegativeKeyword(keywordText)

Arguments:

createRootProductGroup()

Return values:

devices()

Return values:

enable()

getCampaign()

Return values:

getEntityType()

Return values:

getId()

Return values:

getMobileBidModifier()

Return values:

getName()

Return values:

getResourceName()

Return values:

getStatsFor(dateRange)

Arguments:

Return values:

getStatsFor(dateFrom, dateTo)

Arguments:

Return values:

isEnabled()

Return values:

isPaused()

Return values:

isRemoved()

Return values:

labels()

Return values:

negativeKeywords()

Return values:

newAdBuilder()

Return values:

pause()

productGroups()

Return values:

recommendations()

Return values:

removeLabel(name)

Arguments:

rootProductGroup()

Return values:

setMobileBidModifier(modifier)

Arguments:

setName(name)

Arguments:

targeting()

Return values:

AdsApp.ShoppingAdGroup

`ads()`

`applyLabel(name)`

`bidding()`

`createNegativeKeyword(keywordText)`

`createRootProductGroup()`

`devices()`

`enable()`

`getCampaign()`

`getEntityType()`

`getId()`

`getMobileBidModifier()`

`getName()`

`getResourceName()`

`getStatsFor(dateRange)`

`getStatsFor(dateFrom, dateTo)`

`isEnabled()`

`isPaused()`

`isRemoved()`

`labels()`

`negativeKeywords()`

`newAdBuilder()`

`pause()`

`productGroups()`

`recommendations()`

`removeLabel(name)`

`rootProductGroup()`

`setMobileBidModifier(modifier)`

`setName(name)`

`targeting()`