AdsApp.ProductBrand
Stay organized with collections
Save and categorize content based on your preferences.
Represents a product brand.
Methods:
children()
Returns a selector of the child product groups of this product brand.
Return values:
exclude()
Converts the product brand into a negative product brand. Does
nothing if the product brand has children or is already excluded.
Returns nothing.
getAdGroup()
Returns the shopping ad group to which this product brand belongs.
Return values:
getCampaign()
Returns the shopping campaign to which this product brand belongs.
Return values:
getEntityType()
Returns the type of this entity as a
String, in this case,
"ProductBrand".
Return values:
| Type | Description |
|---|
String |
Type of this entity: "ProductBrand". |
getId()
Returns the ID of the product brand.
Return values:
| Type | Description |
|---|
String |
The ID of the product brand. |
getMaxCpc()
Returns the max cpc bid of the product brand, in the currency of the
account. Returns
null if the
campaign's bidding
strategy is not
MANUAL_CPC or the product brand is
excluded.
Return values:
| Type | Description |
|---|
double |
The max cpc bid of the product brand or null if
the
product brand has no max cpc bid. |
getName()
Returns the name of the product brand.
Return values:
| Type | Description |
|---|
String |
The name of the product brand. |
getResourceName()
Returns the resource name of the product brand.
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 brand. |
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 = productBrand.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 brand or
null if this
is the root product group.
Return values:
| Type | Description |
|---|
String |
The value of the product brand or null if this
is the root product group. |
include()
Converts the product brand into a positive product brand. Does
nothing if the product brand is not excluded.
Returns nothing.
isExcluded()
Returns
true if this is an excluded product brand.
Return values:
| Type | Description |
|---|
boolean |
true if this is an excluded product brand. |
isOtherCase()
Returns
true if the product brand is a catch-all product brand. i.e.
'Everything else'.
Return values:
| Type | Description |
|---|
boolean |
true if the product brand is a catch-all product brand. i.e. 'Everything else'. |
newChild()
Returns access to the product group builder space or
null if
the
product brand is excluded.
Return values:
parent()
Returns the parent product group of this product brand or
null if this is the root product group.
Return values:
remove()
Removes the product brand.
Returns nothing.
removeAllChildren()
Will remove all child product groups of this product brand.
Returns nothing.
setMaxCpc(maxCpc)
Sets the max cpc bid of the product brand to the specified value. The
change will take effect only if the
campaign's bidding
strategy is
MANUAL_CPC and the product brand is not
excluded.
Returns nothing.
Arguments:
| Name | Type | Description |
|---|
| maxCpc |
double |
The new max cpc bid. |
