AdWordsApp.​ShoppingAdGroup

Represents a shopping ad group.

Methods:

MemberTypeDescription
ads AdWordsApp.ProductAdSelector Returns the selector of all product ads in the shopping ad group.
applyLabel void Applies a label to the shopping ad group.
bidding AdWordsApp.ShoppingAdGroupBidding Provides access to this shopping ad group's bidding fields.
createNegativeKeyword void Creates a new negative keyword with the specified text.
createRootProductGroup Operation Creates the root product group of the shopping ad group (if one doesn't already exist).
devices AdWordsApp.AdGroupDevices Returns an AdGroupDevices instance associated with the shopping ad group.
enable void Enables the shopping ad group.
getCampaign AdWordsApp.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 long 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.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.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 AdWordsApp.LabelSelector Creates a selector of all labels applied to the shopping ad group.
newAdBuilder AdWordsApp.ProductAdBuilder Returns a product ad builder.
pause void Pauses the shopping ad group.
productGroups AdWordsApp.ProductGroupSelector Returns the selector of all product groups in the shopping ad group.
removeLabel void Removes a label from the shopping ad group.
rootProductGroup AdWordsApp.ProductGroup Returns the root product group of the shopping ad group (if there is one).
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 AdWordsApp.ShoppingAdGroupTargeting Provides access to this shopping ad group's targeting criteria: audiences ShoppingAdGroupAudience

ads()

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

Return values:

TypeDescription
AdWordsApp.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 not have more than 50 labels.

Returns nothing.

Arguments:

NameTypeDescription
name String Name of the label to apply.

bidding()

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

Return values:

TypeDescription
AdWordsApp.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:

NameTypeDescription
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:

TypeDescription
Operation 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:

TypeDescription
AdWordsApp.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:

TypeDescription
AdWordsApp.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:

TypeDescription
String Type of this entity: "ShoppingAdGroup".

getId()

Returns the ID of the shopping ad group.

Return values:

TypeDescription
long 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 AdWords Help Center article.

Return values:

TypeDescription
double The mobile bid modifier.

getName()

Returns the name of the shopping ad group.

Return values:

TypeDescription
String 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:

NameTypeDescription
dateRange String Date range for which the stats are requested.

Return values:

TypeDescription
AdWordsApp.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:

NameTypeDescription
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:

TypeDescription
AdWordsApp.Stats The stats for the specified date range.

isEnabled()

Returns true if the shopping ad group is enabled.

Return values:

TypeDescription
boolean true if the shopping ad group is enabled.

isPaused()

Returns true if the shopping ad group is paused.

Return values:

TypeDescription
boolean true if the shopping ad group is paused.

isRemoved()

Returns true if the shopping ad group is removed.

Return values:

TypeDescription
boolean true if the shopping ad group is removed.

labels()

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

Return values:

TypeDescription
AdWordsApp.LabelSelector Selector of all labels applied to the shopping ad group.

newAdBuilder()

Returns a product ad builder.

Return values:

TypeDescription
AdWordsApp.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:

TypeDescription
AdWordsApp.ProductGroupSelector The selector of all product groups in the shopping 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:

NameTypeDescription
name String Name of the label.

rootProductGroup()

Returns the root product group of the shopping ad group (if there is one).

Return values:

TypeDescription
AdWordsApp.ProductGroup The root product group of the shopping ad group (if there is one).

setMobileBidModifier(modifier)

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

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 AdWords Help Center article.

Returns nothing.

Arguments:

NameTypeDescription
modifier double The new mobile bid modifier.

setName(name)

Sets the name of the shopping ad group.

Returns nothing.

Arguments:

NameTypeDescription
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:

TypeDescription
AdWordsApp.ShoppingAdGroupTargeting Access to this ad group's targeting criteria.

Feedback geben zu...

AdWords Scripts
AdWords Scripts