AdsApp.​ProductCondition

AI-generated Key Takeaways

• Represents the condition of a product, such as new, used, or refurbished.

• Provides methods to manage bids, retrieve performance statistics, and modify the product condition's attributes.

• Allows for creating and managing child product groups within the condition.

• Can be used to exclude or include specific product conditions in shopping campaigns.

• Offers access to essential information like ID, condition name, and parent product group.

Represents a product condition.

Methods:

Member	Type	Description
children()	AdsApp.ProductGroupSelector	Returns a selector of the child product groups of this product condition.
exclude()	void	Converts the product condition into a negative product condition.
getAdGroup()	AdsApp.ShoppingAdGroup	Returns the shopping ad group to which this product condition belongs.
getCampaign()	AdsApp.ShoppingCampaign	Returns the shopping campaign to which this product condition belongs.
getCondition()	String	Returns the name of the product condition.
getEntityType()	String	Returns the type of this entity as a String, in this case, "ProductCondition".
getId()	String	Returns the ID of the product condition.
getMaxCpc()	double	Returns the max cpc bid of the product condition, in the currency of the account.
getResourceName()	String	Returns the resource name of the product condition.
getStatsFor(dateRange)	AdsApp.Stats	Returns stats for the specified date range.
getStatsFor(dateFrom, dateTo)	AdsApp.Stats	Returns stats for the specified custom date range.
getValue()	String	Returns the value of the product condition or null if this is the root product group.
include()	void	Converts the product condition into a positive product condition.
isExcluded()	boolean	Returns true if this is an excluded product condition.
isOtherCase()	boolean	Returns true if the product condition is a catch-all product condition.
newChild()	AdsApp.ProductGroupBuilderSpace	Returns access to the product group builder space or null if the product condition is excluded.
parent()	AdsApp.ProductGroup	Returns the parent product group of this product condition or null if this is the root product group.
remove()	void	Removes the product condition.
removeAllChildren()	void	Will remove all child product groups of this product condition.
setMaxCpc(maxCpc)	void	Sets the max cpc bid of the product condition to the specified value.

children()

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

Return values:

Type	Description
AdsApp.ProductGroupSelector	A selector of the child product groups of this product condition.

exclude()

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

Returns nothing.

getAdGroup()

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

Return values:

Type	Description
AdsApp.ShoppingAdGroup	The shopping ad group to which this product condition belongs.

getCampaign()

Returns the shopping campaign to which this product condition belongs.

Return values:

Type	Description
AdsApp.ShoppingCampaign	The shopping campaign to which this product condition belongs.

getCondition()

Returns the name of the product condition. Possible values: NEW, USED, REFURBISHED

Return values:

Type	Description
String	The name of the product condition.

getEntityType()

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

Return values:

Type	Description
String	Type of this entity: "ProductCondition".

getId()

Returns the ID of the product condition.

Return values:

Type	Description
String	The ID of the product condition.

getMaxCpc()

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

Return values:

Type	Description
double	The max cpc bid of the product condition or null if the product condition has no max cpc bid.

getResourceName()

Returns the resource name of the product condition. 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 condition.

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

Return values:

Type	Description
String	The value of the product condition or null if this is the root product group.

include()

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

Returns nothing.

isExcluded()

Returns true if this is an excluded product condition.

Return values:

Type	Description
boolean	true if this is an excluded product condition.

isOtherCase()

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

Return values:

Type	Description
boolean	true if the product condition is a catch-all product condition. i.e. 'Everything else'.

newChild()

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

Return values:

Type	Description
AdsApp.ProductGroupBuilderSpace	Access to the product group builder space or null if the product condition is excluded.

parent()

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

Return values:

Type	Description
AdsApp.ProductGroup	The parent product group of this product condition.

remove()

Removes the product condition.

Returns nothing.

removeAllChildren()

Will remove all child product groups of this product condition.

Returns nothing.

setMaxCpc(maxCpc)

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

Returns nothing.

Arguments:

Name	Type	Description
maxCpc	double	The new max cpc bid.