ProductCustomLabel

Contains the methods for managing a custom label product group. This object derives from ProductGroup.

Used by the delivery engine to determine whether a product from the advertiser's catalog is served. The engine may serve the product if the product's custom label matches exactly the label returned bygetType.

Example usage:

    var shoppingCampaign = AdsApp.shoppingCampaigns().withIds(["123456789"]).get().next();

    var productGroups = shoppingCampaign.productGroups().get();

    while (productGroups.hasNext()) {
        var group = productGroups.next();

        switch (group.getDimension()) {
            case "CUSTOM_LABEL": {
                // It's only necessary to cast the product group to a ProductCustomLabel product
                // group if you need to get the label's name by calling getType(). Otherwise,
                // you can simply use ProductGroup if you want to get the label's value by
                // calling getValue().

                var customLabel = productGroup.asCustomLabel();
                var labelName = customLabel.getType();
                var labelValue = customLabel.getValue();
                break;
            }
            // Other cases
        }
    }

Methods

Method Name	Return Type	Description
children	ProductGroupSelector	Gets a selector used to filter this product group's list of child product groups.
getAdGroup	AdGroup	Gets the ad group that this product group belongs to.
getCampaign	Campaign	Gets the campaign that this product group belongs to.
getDimension	string	Gets this product group's dimension.
getEntityType	string	Gets this entity's type.
getId	string	Gets the ID that uniquely identifies this product group.
getMaxCpc	double	Gets the maximum cost-per-click bid amount for this product group.
getStats	Stats	Gets the performance data for this product group.
getType	string	Gets the product's custom label type.
getValue	string	Gets the custom label's value.
isExcluded	Boolean	Gets a Boolean value that determines whether this product group is excluded.
isOtherCase	Boolean	Gets a Boolean value that determines whether this product group represents all other cases not represented by its sibling product group.
parent	ProductGroup	Gets this product group's parent product group.
setMaxCpc(double cpc)	void	Sets the maximum cost-per-click bid amount to use for this product group.

children

Gets a selector used to filter this product group's list of child product groups.

Returns

Type	Description
ProductGroupSelector	A selector used to filter the list of children in this product group.

getAdGroup

Gets the ad group that this product group belongs to.

Returns

Type	Description
AdGroup	The ad group that this product group belongs to.

getCampaign

Gets the campaign that this product group belongs to.

Returns

Type	Description
Campaign	The campaign that this product group belongs to.

getDimension

Gets this product group's dimension.

Returns

Type	Description
String	This product group's dimension, which is set to CUSTOM_LABEL.

getEntityType

Gets this entity's type.

Returns

Type	Description
string	This entity's type, which is ProductCustomLabel.

getId

Gets the ID that uniquely identifies this product group.

Returns

Type	Description
string	The ID that uniquely identifies this product group.

getMaxCpc

Gets this product group's maximum cost-per-click bid amount.

Returns

Type	Description
double	The bid amount. Returns null if not set or this is a negative product group (isExluded is true).

getStats

Gets the performance data for this product group.

To call this method, you must include one of the forDateRange methods in the product group selector's chain.

Returns:

Type	Description
Stats	The performance data for this product group.

getType

Gets the product's custom label type.

Returns

Type	Description
String	The product's custom label type. For example, CustomLabel0 through CustomLabel4.

getValue

Gets the custom label's value.

Returns:

Type	Description
string	The custom label's value.

isExcluded

Gets a Boolean value that determines whether this product group is a negative product group.

Returns:

Type	Description
Boolean	Is true if this product group is a negative group; otherwise, false. For example, instead of including all downhill skis, you exclude them.

isOtherCase

Gets a Boolean value that determines whether this product group represents everything else not represented by its sibling product group (aka., the other case).

Returns:

Type	Description
Boolean	Is true if this product group represents the "other" case; otherwise, false. For example, if you divide All products (the root node) by Sporting Goods, the service creates a sibling product group that represents the products not in Sporting Goods and sets this field to true. The parent ID of this product group and the Sporting Goods product group point to the root node.

parent

Gets this product group's parent.

Returns:

Type	Description
ProductGroup	This product group's parent.

setMaxCpc(double cpc)

Sets the maximum cost-per-click bid amount for this product group.

Arguments

Name	Type	Description
cpc	double	The bid amount. The bid amount is in the account's currency, which determines the minimum and maximum bid values you may specify. Do not set the bid if this product group is subdivided (has children) or is a negative product group (isExcluded is true).

Returns

Type	Description
void	Returns nothing.