AdWordsApp.​ProductCustomLabel

Represents a product custom label.

Methods:

MemberTypeDescription
children AdWordsApp.ProductGroupSelector Returns a selector of the child product groups of this product custom label.
exclude void Converts the product custom label into a negative product custom label.
getAdGroup AdWordsApp.ShoppingAdGroup Returns the shopping ad group to which this product custom label belongs.
getCampaign AdWordsApp.ShoppingCampaign Returns the shopping campaign to which this product custom label belongs.
getEntityType String Returns the type of this entity as a String, in this case, "ProductCustomLabel".
getId long Returns the ID of the product custom label.
getMaxCpc double Returns the max cpc bid of the product custom label, 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.
getType String Returns the type of the product custom label.
getValue String Returns the value of the product custom label or null if this is the root product group.
include void Converts the product custom label into a positive product custom label.
isExcluded boolean Returns true if this is an excluded product custom label.
isOtherCase boolean Returns true if the product custom label is a catch-all product custom label.
newChild AdWordsApp.ProductGroupBuilderSpace Returns access to the product group builder space or null if the product custom label is excluded.
parent AdWordsApp.ProductGroup Returns the parent product group of this product custom label or null if this is the root product group.
remove void Removes the product custom label.
removeAllChildren void Will remove all child product groups of this product custom label.
setMaxCpc void Sets the max cpc bid of the product custom label to the specified value.

children()

Returns a selector of the child product groups of this product custom label.

Return values:

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

exclude()

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

Returns nothing.

getAdGroup()

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

Return values:

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

getCampaign()

Returns the shopping campaign to which this product custom label belongs.

Return values:

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

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "ProductCustomLabel".

getId()

Returns the ID of the product custom label.

Return values:

TypeDescription
long The ID of the product custom label.

getMaxCpc()

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

Return values:

TypeDescription
double The max cpc bid of the product custom label.

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 = productCustomLabel.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.

getType()

Returns the type of the product custom label. Possible values: * CUSTOM_LABEL_0, CUSTOM_LABEL_1, CUSTOM_LABEL_2, CUSTOM_LABEL_3, CUSTOM_LABEL_4

Return values:

TypeDescription
String The type of the product custom label.

getValue()

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

Return values:

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

include()

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

Returns nothing.

isExcluded()

Returns true if this is an excluded product custom label.

Return values:

TypeDescription
boolean true if this is an excluded product custom label.

isOtherCase()

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

Return values:

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

newChild()

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

Return values:

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

parent()

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

Return values:

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

remove()

Removes the product custom label.

Returns nothing.

removeAllChildren()

Will remove all child product groups of this product custom label.

Returns nothing.

setMaxCpc(maxCpc)

Sets the max cpc bid of the product custom label to the specified value. The change will take effect only if the campaign's bidding strategy is MANUAL_CPC and the product custom label 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.