AdsApp.​ProductCustomLabel

    • The product custom label represents a product custom label in AdsApp.

    • You can retrieve information about the ad group and campaign the product custom label belongs to.

    • It is possible to check if the product custom label is excluded or a catch-all case.

    • You can get statistics for the product custom label for specified or custom date ranges.

    • The product custom label provides methods to manage child product groups, set bids, and remove the label.

     Represents a product custom label.

    Methods:

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

    children()

    Returns a selector of the child product groups of this product custom label.

    Return values:

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

    exclude()

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

    Returns nothing.

    getAdGroup()

    Returns the shopping ad group to which this product custom label belongs.

    Return values:

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

    getCampaign()

    Returns the shopping campaign to which this product custom label belongs.

    Return values:

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

    getEntityType()

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

    Return values:

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

    getId()

    Returns the ID of the product custom label.

    Return values:

    Type Description
    String The ID of the product custom label.

    getMaxCpc()

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

    Return values:

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

    getResourceName()

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

    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 
  
 = 
  
 productCustomLabel 
 . 
 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.

    getType()

    Returns the type of the product custom label. Possible values: * CUSTOM_LABEL_0 , CUSTOM_LABEL_1 , CUSTOM_LABEL_2 , CUSTOM_LABEL_3 , CUSTOM_LABEL_4

    Return values:

    Type Description
    String The type of the product custom label.

    getValue()

    Returns the value of the product custom label or null if this is the root product group.

    Return values:

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

    include()

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

    Returns nothing.

    isExcluded()

    Returns true if this is an excluded product custom label.

    Return values:

    Type Description
    boolean true if this is an excluded product custom label.

    isOtherCase()

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

    Return values:

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

    newChild()

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

    Return values:

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

    parent()

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

    Return values:

    Type Description
    AdsApp.ProductGroup The parent product group of this product custom label.

    remove()

    Removes the product custom label.

    Returns nothing.

    removeAllChildren()

    Will remove all child product groups of this product custom label.

    Returns nothing.

    setMaxCpc(maxCpc)

    Sets the max cpc bid of the product custom label to the specified value. The change will take effect only if the campaign's bidding strategy is MANUAL_CPC and the product custom label 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: