AdsApp.​ProductChannelExclusivity

AI-generated Key Takeaways

• Represents a product channel exclusivity, allowing for control over where products are advertised.

• Provides methods to manage product groups within the exclusivity, such as adding, removing, and selecting children.

• Enables setting and retrieving bid values for the product channel exclusivity when using manual CPC bidding.

• Offers functionality to retrieve performance statistics for specific date ranges.

• Allows converting the exclusivity to positive or negative, impacting whether it includes or excludes products.

Represents a product channel exclusivity.

Methods:

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

children()

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

Return values:

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

exclude()

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

Returns nothing.

getAdGroup()

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

Return values:

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

getCampaign()

Returns the shopping campaign to which this product channel exclusivity belongs.

Return values:

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

getChannelExclusivity()

Returns the name of this product channel exclusivity. Possible values: SINGLE_CHANNEL, MULTI_CHANNEL.

Return values:

Type	Description
String	The name of this product channel exclusivity.

getEntityType()

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

Return values:

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

getId()

Returns the ID of the product channel exclusivity.

Return values:

Type	Description
String	The ID of the product channel exclusivity.

getMaxCpc()

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

Return values:

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

getResourceName()

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

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

Return values:

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

include()

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

Returns nothing.

isExcluded()

Returns true if this is an excluded product channel exclusivity.

Return values:

Type	Description
boolean	true if this is an excluded product channel exclusivity.

isOtherCase()

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

Return values:

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

newChild()

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

Return values:

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

parent()

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

Return values:

Type	Description
AdsApp.ProductGroup	The parent product group of this product channel exclusivity.

remove()

Removes the product channel exclusivity.

Returns nothing.

removeAllChildren()

Will remove all child product groups of this product channel exclusivity.

Returns nothing.

setMaxCpc(maxCpc)

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

Returns nothing.

Arguments:

Name	Type	Description
maxCpc	double	The new max cpc bid.