Represents a product type.
Methods:
Member | Type | Description |
children |
AdsApp.ProductGroupSelector |
Returns a selector of the child product groups of this product type. |
exclude |
void |
Converts the product type into a negative product type. |
getAdGroup |
AdsApp.ShoppingAdGroup |
Returns the shopping ad group to which this product type belongs. |
getCampaign |
AdsApp.ShoppingCampaign |
Returns the shopping campaign to which this product type belongs. |
getEntityType |
String |
Returns the type of this entity as a String , in this case, "ProductType" . |
getId |
long |
Returns the ID of the product type. |
getMaxCpc |
Double |
Returns the max cpc bid of the product type, in the currency of the account. |
getStatsFor |
AdsApp.Stats |
Returns stats for the specified date range. |
getStatsFor |
AdsApp.Stats |
Returns stats for the specified custom date range. |
getType |
String |
Returns the name of the product type. |
getValue |
String |
Returns the value of the product type or null if this is the root product
group. |
include |
void |
Converts the product type into a positive product type. |
isExcluded |
boolean |
Returns true if this is an excluded product type. |
isOtherCase |
boolean |
Returns true if the product type is a catch-all product type. |
newChild |
AdsApp.ProductGroupBuilderSpace |
Returns access to the product group builder space or null if the
product type is excluded. |
parent |
AdsApp.ProductGroup |
Returns the parent product group of this product type or null if this is
the root product group. |
remove |
void |
Removes the product type. |
removeAllChildren |
void |
Will remove all child product groups of this product type. |
setMaxCpc |
void |
Sets the max cpc bid of the product type to the specified value. |
children()
Returns a selector of the child product groups of this product type.
Return values:
exclude()
Converts the product type into a negative product type. Does nothing if
the product type has children or is already excluded.
Returns nothing.
getAdGroup()
Returns the shopping ad group to which this product type belongs.
Return values:
getCampaign()
Returns the shopping campaign to which this product type belongs.
Return values:
getEntityType()
Returns the type of this entity as a
String
, in this case,
"ProductType"
.
Return values:
Type | Description |
String |
Type of this entity: "ProductType" . |
getId()
Returns the ID of the product type.
Return values:
Type | Description |
long |
The ID of the product type. |
getMaxCpc()
Returns the max cpc bid of the product type, in the currency of the account.
Returns
null
if the
campaign's bidding strategy
is not
MANUAL_CPC
or the product type is excluded.
Return values:
Type | Description |
Double |
The max cpc bid of the product type or null if the
product type has no max cpc bid. |
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 = productType.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. |
getType()
Returns the name of the product type.
Return values:
Type | Description |
String |
The name of the product type. |
getValue()
Returns the value of the product type or
null
if this is the root product
group.
Return values:
Type | Description |
String |
The value of the product type or null if this is the root product
group. |
include()
Converts the product type into a positive product type. Does nothing if
the product type is not excluded.
Returns nothing.
isExcluded()
Returns
true
if this is an excluded product type.
Return values:
Type | Description |
boolean |
true if this is an excluded product type. |
isOtherCase()
Returns
true
if the product type is a catch-all product type.
i.e.
'Everything else'
.
Return values:
Type | Description |
boolean |
true if the product type is a catch-all product type.
i.e. 'Everything else' . |
newChild()
Returns access to the product group builder space or
null
if the
product type is excluded.
Return values:
parent()
Returns the parent product group of this product type or
null
if this is
the root product group.
Return values:
remove()
Removes the product type.
Returns nothing.
removeAllChildren()
Will remove all child product groups of this product type.
Returns nothing.
setMaxCpc(maxCpc)
Sets the max cpc bid of the product type to the specified value. The change will
take effect only if the
campaign's bidding strategy is
MANUAL_CPC
and the product type is not excluded.
Returns nothing.
Arguments:
Name | Type | Description |
maxCpc |
double |
The new max cpc bid. |