Represents a generic product group.
Methods:
asBrand()
Returns this product group represented as a product brand.
Return values:
asCategory()
Returns this product group represented as a product category.
Return values:
asChannel()
Returns this product group represented as a product channel.
Return values:
asChannelExclusivity()
Returns this product group represented as a product channel exclusivity.
Return values:
asCondition()
Returns this product group represented as a product condition.
Return values:
asCustomLabel()
Returns this product group represented as a product custom label.
Return values:
asItemId()
Returns this product group represented as a product item ID.
Return values:
asProductType()
Returns this product group represented as a product type.
Return values:
children()
Returns a selector of the child product groups of this product group.
Return values:
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:
getCampaign()
Returns the shopping campaign to which this product group belongs.
Return values:
getDimension()
Returns the dimension of the product group. Possible return values:
ROOT, BRAND, CATEGORY, CHANNEL, CHANNEL_EXCLUSIVITY, CONDITION,
CUSTOM_LABEL, ITEM_ID, PRODUCT_TYPE
Return values:
| Type | Description |
|---|
String |
The dimension of the product group. |
getEntityType()
Returns the type of this entity as a
String, in this case,
"ProductGroup".
Return values:
| Type | Description |
|---|
String |
Type of this entity: "ProductGroup". |
getId()
Returns the ID of the product group.
Return values:
| Type | Description |
|---|
String |
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:
| Type | Description |
|---|
double |
The max cpc bid of the product group or null if
the
product group has no max cpc bid. |
getResourceName()
Returns the resource name of the product group.
A product group can be identified by an ad_group_criterion resource name or
a product_group_view resource name. This method will return an
ad_group_criterion resource name although either is compatible with
ProductGroupSelector.withResourceNames.
Return values:
| Type | Description |
|---|
String |
The resource name 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:
| 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. |
getValue()
Returns the value of the product group or
null if this
is the root product group.
Return values:
| Type | Description |
|---|
String |
The value of the product group or null if this
is the root product group. |
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:
| Type | Description |
|---|
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:
| Type | Description |
|---|
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:
parent()
Returns the parent product group of this product group or
null if this is the root product group.
Return values:
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:
| Name | Type | Description |
|---|
| maxCpc |
double |
The new max cpc bid. |
