AdWordsApp.​ProductChannel

Represents a product channel.

Methods:

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

children()

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

Return values:

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

exclude()

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

Returns nothing.

getAdGroup()

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

Return values:

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

getCampaign()

Returns the shopping campaign to which this product channel belongs.

Return values:

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

getChannel()

Returns the name of this product channel. Possible values: LOCAL, ONLINE.

Return values:

TypeDescription
String The name of this product channel.

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "ProductChannel".

getId()

Returns the ID of the product channel.

Return values:

TypeDescription
long The ID of the product channel.

getMaxCpc()

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

Return values:

TypeDescription
double The max cpc bid of the product channel.

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 = productChannel.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 channel or null if this is the root product group.

Return values:

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

include()

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

Returns nothing.

isExcluded()

Returns true if this is an excluded product channel.

Return values:

TypeDescription
boolean true if this is an excluded product channel.

isOtherCase()

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

Return values:

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

newChild()

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

Return values:

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

parent()

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

Return values:

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

remove()

Removes the product channel.

Returns nothing.

removeAllChildren()

Will remove all child product groups of this product channel.

Returns nothing.

setMaxCpc(maxCpc)

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

Returns nothing.

Arguments:

NameTypeDescription
maxCpc double The new max cpc bid.

Оставить отзыв о...

Текущей странице
AdWords Scripts
AdWords Scripts
Нужна помощь? Обратитесь в службу поддержки.