AdWordsApp.​ProductItemId

Represents a product item ID.

Methods:

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

children()

Returns a selector of the child product groups of this product item id.

Return values:

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

exclude()

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

Returns nothing.

getAdGroup()

Returns the shopping ad group to which this product item id belongs.

Return values:

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

getCampaign()

Returns the shopping campaign to which this product item id belongs.

Return values:

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

getEntityType()

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

Return values:

TypeDescription
String Type of this entity: "ProductItemId".

getId()

Returns the ID of the product item id.

Return values:

TypeDescription
long The ID of the product item id.

getMaxCpc()

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

Return values:

TypeDescription
double The max cpc bid of the product item id.

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 = productItemId.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 item id or null if this is the root product group.

Return values:

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

include()

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

Returns nothing.

isExcluded()

Returns true if this is an excluded product item id.

Return values:

TypeDescription
boolean true if this is an excluded product item id.

isOtherCase()

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

Return values:

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

newChild()

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

Return values:

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

parent()

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

Return values:

TypeDescription
AdWordsApp.ProductGroup The parent product group of this product item id.

remove()

Removes the product item id.

Returns nothing.

removeAllChildren()

Will remove all child product groups of this product item id.

Returns nothing.

setMaxCpc(maxCpc)

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

Returns nothing.

Arguments:

NameTypeDescription
maxCpc double The new max cpc bid.

Feedback geben zu...

AdWords Scripts
AdWords Scripts