AdWordsApp.​ProductGroup

Methods:

MemberTypeDescription
asBrand AdWordsApp.ProductBrand Returns this product group represented as a product brand.
asCategory AdWordsApp.ProductCategory Returns this product group represented as a product category.
asChannel AdWordsApp.ProductChannel Returns this product group represented as a product channel.
asChannelExclusivity AdWordsApp.ProductChannelExclusivity Returns this product group represented as a product channel exclusivity.
asCondition AdWordsApp.ProductCondition Returns this product group represented as a product condition.
asCustomLabel AdWordsApp.ProductCustomLabel Returns this product group represented as a product custom label.
asItemId AdWordsApp.ProductItemId Returns this product group represented as a product item ID.
asProductType AdWordsApp.ProductType Returns this product group represented as a product type.
children AdWordsApp.ProductGroupSelector Returns a selector of the child product groups of this product group.
exclude void Converts the product group into a negative product group.
getAdGroup AdWordsApp.ShoppingAdGroup Returns the shopping ad group to which this product group belongs.
getCampaign AdWordsApp.ShoppingCampaign Returns the shopping campaign to which this product group belongs.
getDimension String Returns the dimension of the product group.
getEntityType String Returns the type of this entity as a String, in this case, "ProductGroup".
getId long Returns the ID of the product group.
getMaxCpc double Returns the max cpc bid of the product group, in the currency of the account.
getStatsFor AdWordsApp.Stats Returns stats for the specified date range.
getStatsFor AdWordsApp.Stats Returns stats for the specified custom date range.
getValue String Returns the value of the product group or null if this is the root product group.
hasChildren boolean Returns true if and only if this product group has child product groups.
include void Converts the product group into a positive product group.
isExcluded boolean Returns true if this is an excluded product group.
isOtherCase boolean Returns true if the product group is a catch-all product group.
newChild AdWordsApp.ProductGroupBuilderSpace Returns access to the product group builder space or null if the product group is excluded.
parent AdWordsApp.ProductGroup Returns the parent product group of this product group or null if this is the root product group.
remove void Removes the product group.
removeAllChildren void Will remove all child product groups of this product group.
setMaxCpc void Sets the max cpc bid of the product group to the specified value.

asBrand()

Returns this product group represented as a product brand.

Return values:

TypeDescription
AdWordsApp.ProductBrand This product group represented as a product brand.

asCategory()

Returns this product group represented as a product category.

Return values:

TypeDescription
AdWordsApp.ProductCategory This product group represented as a product category.

asChannel()

Returns this product group represented as a product channel.

Return values:

TypeDescription
AdWordsApp.ProductChannel This product group represented as a product channel.

asChannelExclusivity()

Returns this product group represented as a product channel exclusivity.

Return values:

TypeDescription
AdWordsApp.ProductChannelExclusivity This product group represented as a product channel exclusivity.

asCondition()

Returns this product group represented as a product condition.

Return values:

TypeDescription
AdWordsApp.ProductCondition This product group represented as a product condition.

asCustomLabel()

Returns this product group represented as a product custom label.

Return values:

TypeDescription
AdWordsApp.ProductCustomLabel This product group represented as a product custom label.

asItemId()

Returns this product group represented as a product item ID.

Return values:

TypeDescription
AdWordsApp.ProductItemId This product group represented as a product item ID.

asProductType()

Returns this product group represented as a product type.

Return values:

TypeDescription
AdWordsApp.ProductType This product group represented as a product type.

children()

Returns a selector of the child product groups of this product group.

Return values:

TypeDescription
AdWordsApp.ProductGroupSelector A selector of the child product groups of this product group.

exclude()

Converts the product group into a negative product group. Does nothing if the product group has children or is already excluded.

Returns nothing.

getAdGroup()

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

Return values:

TypeDescription
AdWordsApp.ShoppingAdGroup The shopping ad group to which this product group belongs.

getCampaign()

Returns the shopping campaign to which this product group belongs.

Return values:

TypeDescription
AdWordsApp.ShoppingCampaign The shopping campaign to which this product group belongs.

getDimension()

Returns the dimension of the product group. Possible return values:

ROOT, BRAND, CATEGORY, CONDITION, CUSTOM_LABEL, ITEM_ID, PRODUCT_TYPE

Return values:

TypeDescription
String The dimension of the product group.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "ProductGroup".

getId()

Returns the ID of the product group.

Return values:

TypeDescription
long The ID of the product group.

getMaxCpc()

Returns the max cpc bid of the product group, in the currency of the account. Returns null if the campaign's bidding strategy is not MANUAL_CPC or the product group is excluded.

Return values:

TypeDescription
double The max cpc bid of the product 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 = productGroup.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.

getValue()

Returns the value of the product group or null if this is the root product group.

Return values:

TypeDescription
String The value of the product group or null if this is the root product group.

hasChildren()

Returns true if and only if this product group has child product groups.

Return values:

TypeDescription
boolean true if and only if this product group has child product groups.

include()

Converts the product group into a positive product group. Does nothing if the product group is not excluded.

Returns nothing.

isExcluded()

Returns true if this is an excluded product group.

Return values:

TypeDescription
boolean true if this is an excluded product group.

isOtherCase()

Returns true if the product group is a catch-all product group. i.e. 'Everything else'.

Return values:

TypeDescription
boolean true if the product group is a catch-all product group. i.e. 'Everything else'.

newChild()

Returns access to the product group builder space or null if the product group is excluded.

Return values:

TypeDescription
AdWordsApp.ProductGroupBuilderSpace Access to the product group builder space or null if the product group is excluded.

parent()

Returns the parent product group of this product group or null if this is the root product group.

Return values:

TypeDescription
AdWordsApp.ProductGroup The parent product group of this product group.

remove()

Removes the product group.

Returns nothing.

removeAllChildren()

Will remove all child product groups of this product group.

Returns nothing.

setMaxCpc(maxCpc)

Sets the max cpc bid of the product group to the specified value. The change will take effect only if the campaign's bidding strategy is MANUAL_CPC and the product group is not excluded.

Returns nothing.

Arguments:

NameTypeDescription
maxCpc double The new max cpc bid.

Send feedback about...

AdWords Scripts
AdWords Scripts
Need help? Visit our support page.