AdsApp.​ProductChannel

    • The content represents a product channel and provides methods to interact with it.

    • You can access child product groups and the parent product group of a product channel.

    • Methods exist to include, exclude, and remove a product channel and its children.

    • You can retrieve information like the product channel's associated ad group and campaign, ID, name, entity type, value, max CPC, and resource name.

    • The content also provides ways to get performance statistics for a product channel over various date ranges.

     Represents a product channel.

    Methods:

    Member Type Description
    children()
    		AdsApp.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()
    		AdsApp.ShoppingAdGroup Returns the shopping ad group to which this product channel belongs.
    getCampaign()
    		AdsApp.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()
    		String Returns the ID of the product channel.
    getMaxCpc()
    		double Returns the max cpc bid of the product channel, in the currency of the account.
    getResourceName()
    		String Returns the resource name of the product channel.
    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 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()
    		AdsApp.ProductGroupBuilderSpace Returns access to the product group builder space or null if the product channel is excluded.
    parent()
    		AdsApp.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(maxCpc)
    		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:

    Type Description
    AdsApp.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:

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

    getCampaign()

    Returns the shopping campaign to which this product channel belongs.

    Return values:

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

    getChannel()

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

    Return values:

    Type Description
    String The name of this product channel.

    getEntityType()

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

    Return values:

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

    getId()

    Returns the ID of the product channel.

    Return values:

    Type Description
    String 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:

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

    getResourceName()

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

    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:

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

    Return values:

    Type Description
    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:

    Type Description
    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:

    Type Description
    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:

    Type Description
    AdsApp.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:

    Type Description
    AdsApp.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:

    Name Type Description
    maxCpc
    		 double The new max cpc bid.
    Create a Mobile Website
    View Site in Mobile | Classic
    Share by: