AdsApp.​ProductCustomLabelBuilder

AI-generated Key Takeaways

• The ProductCustomLabelBuilder is used to create ProductCustomLabel objects, which can be used to organize and manage product groups.

• You can specify the bid, type, and value of the product custom label using the withBid, withType, and withValue methods, respectively.

• The build method finalizes the creation of the ProductCustomLabel and returns a ProductCustomLabelOperation to apply the changes.

• Product custom label types are preferably set using INDEX0, INDEX1, etc., but legacy formats like CUSTOM_LABEL_0, CUSTOM_LABEL_1, etc., are also accepted.

• If the bid is not explicitly specified using withBid, the product custom label will inherit the bid from its parent product group.

Builder for ProductCustomLabel objects.

Methods:

Member	Type	Description
build()	AdsApp.ProductCustomLabelOperation	Builds the product custom label.
withBid(bid)	AdsApp.ProductCustomLabelBuilder	Specifies the bid of the product custom label.
withType(type)	AdsApp.ProductCustomLabelBuilder	Specifies the type of custom label and returns the product custom label builder.
withValue(value)	AdsApp.ProductCustomLabelBuilder	Specifies the value of the product custom label.

build()

Builds the product custom label. Returns a ProductCustomLabelOperation that corresponds to the creation of the ProductCustomLabel.

Return values:

Type	Description
AdsApp.ProductCustomLabelOperation	The ProductCustomLabelOperation.

withBid(bid)

Specifies the bid of the product custom label. If this is unspecified, will use the bid of the parent product group.

Arguments:

Name	Type	Description
bid	double	The bid.

Return values:

Type	Description
AdsApp.ProductCustomLabelBuilder	The ProductCustomLabelBuilder with the specified bid.

withType(type)

Specifies the type of custom label and returns the product custom label builder. The preferred values for label types follow the pattern: INDEX0, INDEX1, ..., but this method also accepts the legacy values formatted like: CUSTOM_LABEL_0, CUSTOM_LABEL_1, ...

Arguments:

Name	Type	Description
type	String	The type of custom label. Possible values: INDEX0, INDEX1, INDEX2, INDEX3, INDEX4, CUSTOM_LABEL_0, CUSTOM_LABEL_1, CUSTOM_LABEL_2, CUSTOM_LABEL_3, CUSTOM_LABEL_4.

Return values:

Type	Description
AdsApp.ProductCustomLabelBuilder	The product custom label builder.

withValue(value)

Specifies the value of the product custom label.

Arguments:

Name	Type	Description
value	String	The value.

Return values:

Type	Description
AdsApp.ProductCustomLabelBuilder	The ProductCustomLabelBuilder with the specified value.