public static final class ProductAttributes.Builder extends GeneratedMessageV3.Builder<ProductAttributes.Builder> implements ProductAttributesOrBuilderProduct attributes.
Protobuf type google.shopping.merchant.products.v1.ProductAttributes
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > ProductAttributes.BuilderImplements
ProductAttributesOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
Methods
addAdditionalImageLinks(String value)
public ProductAttributes.Builder addAdditionalImageLinks(String value)Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe additionalImageLinks to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAdditionalImageLinksBytes(ByteString value)
public ProductAttributes.Builder addAdditionalImageLinksBytes(ByteString value)Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the additionalImageLinks to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAdsLabels(String value)
public ProductAttributes.Builder addAdsLabels(String value)Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adsLabels to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAdsLabelsBytes(ByteString value)
public ProductAttributes.Builder addAdsLabelsBytes(ByteString value)Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the adsLabels to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllAdditionalImageLinks(Iterable<String> values)
public ProductAttributes.Builder addAllAdditionalImageLinks(Iterable<String> values)Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The additionalImageLinks to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllAdsLabels(Iterable<String> values)
public ProductAttributes.Builder addAllAdsLabels(Iterable<String> values)Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The adsLabels to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllCertifications(Iterable<? extends ProductCertification> values)
public ProductAttributes.Builder addAllCertifications(Iterable<? extends ProductCertification> values)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.products.v1.ProductCertification> |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addAllCloudExportAdditionalProperties(Iterable<? extends CloudExportAdditionalProperties> values)
public ProductAttributes.Builder addAllCloudExportAdditionalProperties(Iterable<? extends CloudExportAdditionalProperties> values)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.products.v1.CloudExportAdditionalProperties> |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addAllDisplayAdsSimilarIds(Iterable<String> values)
public ProductAttributes.Builder addAllDisplayAdsSimilarIds(Iterable<String> values)Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The displayAdsSimilarIds to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllExcludedDestinations(Iterable<? extends Destination.DestinationEnum> values)
public ProductAttributes.Builder addAllExcludedDestinations(Iterable<? extends Destination.DestinationEnum> values)The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.type.Destination.DestinationEnum>The excludedDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllExcludedDestinationsValue(Iterable<Integer> values)
public ProductAttributes.Builder addAllExcludedDestinationsValue(Iterable<Integer> values)The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<Integer>The enum numeric values on the wire for excludedDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllFreeShippingThreshold(Iterable<? extends FreeShippingThreshold> values)
public ProductAttributes.Builder addAllFreeShippingThreshold(Iterable<? extends FreeShippingThreshold> values)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.products.v1.FreeShippingThreshold> |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addAllGtins(Iterable<String> values)
public ProductAttributes.Builder addAllGtins(Iterable<String> values)Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The gtins to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllIncludedDestinations(Iterable<? extends Destination.DestinationEnum> values)
public ProductAttributes.Builder addAllIncludedDestinations(Iterable<? extends Destination.DestinationEnum> values) The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.type.Destination.DestinationEnum>The includedDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllIncludedDestinationsValue(Iterable<Integer> values)
public ProductAttributes.Builder addAllIncludedDestinationsValue(Iterable<Integer> values) The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<Integer>The enum numeric values on the wire for includedDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllLifestyleImageLinks(Iterable<String> values)
public ProductAttributes.Builder addAllLifestyleImageLinks(Iterable<String> values)Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The lifestyleImageLinks to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllLoyaltyPrograms(Iterable<? extends LoyaltyProgram> values)
public ProductAttributes.Builder addAllLoyaltyPrograms(Iterable<? extends LoyaltyProgram> values)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.products.v1.LoyaltyProgram> |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addAllProductDetails(Iterable<? extends ProductDetail> values)
public ProductAttributes.Builder addAllProductDetails(Iterable<? extends ProductDetail> values)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.products.v1.ProductDetail> |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addAllProductHighlights(Iterable<String> values)
public ProductAttributes.Builder addAllProductHighlights(Iterable<String> values)Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The productHighlights to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllProductTypes(Iterable<String> values)
public ProductAttributes.Builder addAllProductTypes(Iterable<String> values)Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The productTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllPromotionIds(Iterable<String> values)
public ProductAttributes.Builder addAllPromotionIds(Iterable<String> values)The unique ID of a promotion.
repeated string promotion_ids = 70;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The promotionIds to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllShipping(Iterable<? extends Shipping> values)
public ProductAttributes.Builder addAllShipping(Iterable<? extends Shipping> values)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.products.v1.Shipping> |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addAllShoppingAdsExcludedCountries(Iterable<String> values)
public ProductAttributes.Builder addAllShoppingAdsExcludedCountries(Iterable<String> values)List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<String>The shoppingAdsExcludedCountries to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllSizeTypes(Iterable<? extends SizeType> values)
public ProductAttributes.Builder addAllSizeTypes(Iterable<? extends SizeType> values)The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.products.v1.SizeType>The sizeTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllSizeTypesValue(Iterable<Integer> values)
public ProductAttributes.Builder addAllSizeTypesValue(Iterable<Integer> values)The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<Integer>The enum numeric values on the wire for sizeTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addAllSustainabilityIncentives(Iterable<? extends ProductSustainabilityIncentive> values)
public ProductAttributes.Builder addAllSustainabilityIncentives(Iterable<? extends ProductSustainabilityIncentive> values)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameter | |
|---|---|
| Name | Description |
values |
Iterable<? extends com.google.shopping.merchant.products.v1.ProductSustainabilityIncentive> |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCertifications(ProductCertification value)
public ProductAttributes.Builder addCertifications(ProductCertification value)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductCertification |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCertifications(ProductCertification.Builder builderForValue)
public ProductAttributes.Builder addCertifications(ProductCertification.Builder builderForValue)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductCertification.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCertifications(int index, ProductCertification value)
public ProductAttributes.Builder addCertifications(int index, ProductCertification value)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ProductCertification |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCertifications(int index, ProductCertification.Builder builderForValue)
public ProductAttributes.Builder addCertifications(int index, ProductCertification.Builder builderForValue)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ProductCertification.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCertificationsBuilder()
public ProductCertification.Builder addCertificationsBuilder()Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Returns | |
|---|---|
| Type | Description |
ProductCertification.Builder |
|
addCertificationsBuilder(int index)
public ProductCertification.Builder addCertificationsBuilder(int index)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductCertification.Builder |
|
addCloudExportAdditionalProperties(CloudExportAdditionalProperties value)
public ProductAttributes.Builder addCloudExportAdditionalProperties(CloudExportAdditionalProperties value)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameter | |
|---|---|
| Name | Description |
value |
CloudExportAdditionalProperties |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCloudExportAdditionalProperties(CloudExportAdditionalProperties.Builder builderForValue)
public ProductAttributes.Builder addCloudExportAdditionalProperties(CloudExportAdditionalProperties.Builder builderForValue)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
CloudExportAdditionalProperties.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCloudExportAdditionalProperties(int index, CloudExportAdditionalProperties value)
public ProductAttributes.Builder addCloudExportAdditionalProperties(int index, CloudExportAdditionalProperties value)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CloudExportAdditionalProperties |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCloudExportAdditionalProperties(int index, CloudExportAdditionalProperties.Builder builderForValue)
public ProductAttributes.Builder addCloudExportAdditionalProperties(int index, CloudExportAdditionalProperties.Builder builderForValue)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CloudExportAdditionalProperties.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addCloudExportAdditionalPropertiesBuilder()
public CloudExportAdditionalProperties.Builder addCloudExportAdditionalPropertiesBuilder()Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Returns | |
|---|---|
| Type | Description |
CloudExportAdditionalProperties.Builder |
|
addCloudExportAdditionalPropertiesBuilder(int index)
public CloudExportAdditionalProperties.Builder addCloudExportAdditionalPropertiesBuilder(int index)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CloudExportAdditionalProperties.Builder |
|
addDisplayAdsSimilarIds(String value)
public ProductAttributes.Builder addDisplayAdsSimilarIds(String value)Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayAdsSimilarIds to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addDisplayAdsSimilarIdsBytes(ByteString value)
public ProductAttributes.Builder addDisplayAdsSimilarIdsBytes(ByteString value)Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the displayAdsSimilarIds to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addExcludedDestinations(Destination.DestinationEnum value)
public ProductAttributes.Builder addExcludedDestinations(Destination.DestinationEnum value)The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Destination.DestinationEnumThe excludedDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addExcludedDestinationsValue(int value)
public ProductAttributes.Builder addExcludedDestinationsValue(int value)The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for excludedDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addFreeShippingThreshold(FreeShippingThreshold value)
public ProductAttributes.Builder addFreeShippingThreshold(FreeShippingThreshold value)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameter | |
|---|---|
| Name | Description |
value |
FreeShippingThreshold |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addFreeShippingThreshold(FreeShippingThreshold.Builder builderForValue)
public ProductAttributes.Builder addFreeShippingThreshold(FreeShippingThreshold.Builder builderForValue)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
FreeShippingThreshold.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addFreeShippingThreshold(int index, FreeShippingThreshold value)
public ProductAttributes.Builder addFreeShippingThreshold(int index, FreeShippingThreshold value)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
FreeShippingThreshold |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addFreeShippingThreshold(int index, FreeShippingThreshold.Builder builderForValue)
public ProductAttributes.Builder addFreeShippingThreshold(int index, FreeShippingThreshold.Builder builderForValue)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
FreeShippingThreshold.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addFreeShippingThresholdBuilder()
public FreeShippingThreshold.Builder addFreeShippingThresholdBuilder()Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Returns | |
|---|---|
| Type | Description |
FreeShippingThreshold.Builder |
|
addFreeShippingThresholdBuilder(int index)
public FreeShippingThreshold.Builder addFreeShippingThresholdBuilder(int index)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FreeShippingThreshold.Builder |
|
addGtins(String value)
public ProductAttributes.Builder addGtins(String value)Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe gtins to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addGtinsBytes(ByteString value)
public ProductAttributes.Builder addGtinsBytes(ByteString value)Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the gtins to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addIncludedDestinations(Destination.DestinationEnum value)
public ProductAttributes.Builder addIncludedDestinations(Destination.DestinationEnum value) The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Destination.DestinationEnumThe includedDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addIncludedDestinationsValue(int value)
public ProductAttributes.Builder addIncludedDestinationsValue(int value) The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for includedDestinations to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addLifestyleImageLinks(String value)
public ProductAttributes.Builder addLifestyleImageLinks(String value)Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe lifestyleImageLinks to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addLifestyleImageLinksBytes(ByteString value)
public ProductAttributes.Builder addLifestyleImageLinksBytes(ByteString value)Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the lifestyleImageLinks to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addLoyaltyPrograms(LoyaltyProgram value)
public ProductAttributes.Builder addLoyaltyPrograms(LoyaltyProgram value)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameter | |
|---|---|
| Name | Description |
value |
LoyaltyProgram |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addLoyaltyPrograms(LoyaltyProgram.Builder builderForValue)
public ProductAttributes.Builder addLoyaltyPrograms(LoyaltyProgram.Builder builderForValue)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
LoyaltyProgram.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addLoyaltyPrograms(int index, LoyaltyProgram value)
public ProductAttributes.Builder addLoyaltyPrograms(int index, LoyaltyProgram value)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
LoyaltyProgram |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addLoyaltyPrograms(int index, LoyaltyProgram.Builder builderForValue)
public ProductAttributes.Builder addLoyaltyPrograms(int index, LoyaltyProgram.Builder builderForValue)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
LoyaltyProgram.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addLoyaltyProgramsBuilder()
public LoyaltyProgram.Builder addLoyaltyProgramsBuilder()A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Returns | |
|---|---|
| Type | Description |
LoyaltyProgram.Builder |
|
addLoyaltyProgramsBuilder(int index)
public LoyaltyProgram.Builder addLoyaltyProgramsBuilder(int index)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
LoyaltyProgram.Builder |
|
addProductDetails(ProductDetail value)
public ProductAttributes.Builder addProductDetails(ProductDetail value)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductDetail |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addProductDetails(ProductDetail.Builder builderForValue)
public ProductAttributes.Builder addProductDetails(ProductDetail.Builder builderForValue)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductDetail.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addProductDetails(int index, ProductDetail value)
public ProductAttributes.Builder addProductDetails(int index, ProductDetail value)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ProductDetail |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addProductDetails(int index, ProductDetail.Builder builderForValue)
public ProductAttributes.Builder addProductDetails(int index, ProductDetail.Builder builderForValue)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ProductDetail.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addProductDetailsBuilder()
public ProductDetail.Builder addProductDetailsBuilder()Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Returns | |
|---|---|
| Type | Description |
ProductDetail.Builder |
|
addProductDetailsBuilder(int index)
public ProductDetail.Builder addProductDetailsBuilder(int index)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductDetail.Builder |
|
addProductHighlights(String value)
public ProductAttributes.Builder addProductHighlights(String value)Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe productHighlights to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addProductHighlightsBytes(ByteString value)
public ProductAttributes.Builder addProductHighlightsBytes(ByteString value)Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the productHighlights to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addProductTypes(String value)
public ProductAttributes.Builder addProductTypes(String value)Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe productTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addProductTypesBytes(ByteString value)
public ProductAttributes.Builder addProductTypesBytes(ByteString value)Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the productTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addPromotionIds(String value)
public ProductAttributes.Builder addPromotionIds(String value)The unique ID of a promotion.
repeated string promotion_ids = 70;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe promotionIds to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addPromotionIdsBytes(ByteString value)
public ProductAttributes.Builder addPromotionIdsBytes(ByteString value)The unique ID of a promotion.
repeated string promotion_ids = 70;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the promotionIds to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public ProductAttributes.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addShipping(Shipping value)
public ProductAttributes.Builder addShipping(Shipping value)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameter | |
|---|---|
| Name | Description |
value |
Shipping |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addShipping(Shipping.Builder builderForValue)
public ProductAttributes.Builder addShipping(Shipping.Builder builderForValue)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Shipping.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addShipping(int index, Shipping value)
public ProductAttributes.Builder addShipping(int index, Shipping value)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Shipping |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addShipping(int index, Shipping.Builder builderForValue)
public ProductAttributes.Builder addShipping(int index, Shipping.Builder builderForValue)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Shipping.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addShippingBuilder()
public Shipping.Builder addShippingBuilder()Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Returns | |
|---|---|
| Type | Description |
Shipping.Builder |
|
addShippingBuilder(int index)
public Shipping.Builder addShippingBuilder(int index)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Shipping.Builder |
|
addShoppingAdsExcludedCountries(String value)
public ProductAttributes.Builder addShoppingAdsExcludedCountries(String value)List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe shoppingAdsExcludedCountries to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addShoppingAdsExcludedCountriesBytes(ByteString value)
public ProductAttributes.Builder addShoppingAdsExcludedCountriesBytes(ByteString value)List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes of the shoppingAdsExcludedCountries to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addSizeTypes(SizeType value)
public ProductAttributes.Builder addSizeTypes(SizeType value)The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Parameter | |
|---|---|
| Name | Description |
value |
SizeTypeThe sizeTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addSizeTypesValue(int value)
public ProductAttributes.Builder addSizeTypesValue(int value)The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for sizeTypes to add. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
addSustainabilityIncentives(ProductSustainabilityIncentive value)
public ProductAttributes.Builder addSustainabilityIncentives(ProductSustainabilityIncentive value)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductSustainabilityIncentive |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addSustainabilityIncentives(ProductSustainabilityIncentive.Builder builderForValue)
public ProductAttributes.Builder addSustainabilityIncentives(ProductSustainabilityIncentive.Builder builderForValue)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductSustainabilityIncentive.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addSustainabilityIncentives(int index, ProductSustainabilityIncentive value)
public ProductAttributes.Builder addSustainabilityIncentives(int index, ProductSustainabilityIncentive value)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ProductSustainabilityIncentive |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addSustainabilityIncentives(int index, ProductSustainabilityIncentive.Builder builderForValue)
public ProductAttributes.Builder addSustainabilityIncentives(int index, ProductSustainabilityIncentive.Builder builderForValue)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ProductSustainabilityIncentive.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
addSustainabilityIncentivesBuilder()
public ProductSustainabilityIncentive.Builder addSustainabilityIncentivesBuilder()The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Returns | |
|---|---|
| Type | Description |
ProductSustainabilityIncentive.Builder |
|
addSustainabilityIncentivesBuilder(int index)
public ProductSustainabilityIncentive.Builder addSustainabilityIncentivesBuilder(int index)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductSustainabilityIncentive.Builder |
|
build()
public ProductAttributes build()| Returns | |
|---|---|
| Type | Description |
ProductAttributes |
|
buildPartial()
public ProductAttributes buildPartial()| Returns | |
|---|---|
| Type | Description |
ProductAttributes |
|
clear()
public ProductAttributes.Builder clear()| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearAdditionalImageLinks()
public ProductAttributes.Builder clearAdditionalImageLinks()Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearAdsGrouping()
public ProductAttributes.Builder clearAdsGrouping()Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
optional string ads_grouping = 59;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearAdsLabels()
public ProductAttributes.Builder clearAdsLabels()Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearAdsRedirect()
public ProductAttributes.Builder clearAdsRedirect()Allows advertisers to override the item URL when the product is shown within the context of Product ads.
optional string ads_redirect = 61;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearAdult()
public ProductAttributes.Builder clearAdult()Set to true if the item is targeted towards adults.
optional bool adult = 17;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearAgeGroup()
public ProductAttributes.Builder clearAgeGroup()Target age group of the item.
optional .google.shopping.merchant.products.v1.AgeGroup age_group = 18;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearAutoPricingMinPrice()
public ProductAttributes.Builder clearAutoPricingMinPrice()A safeguard in the automated discounts and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
.google.shopping.type.Price auto_pricing_min_price = 124;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearAvailability()
public ProductAttributes.Builder clearAvailability()Availability status of the item.
optional .google.shopping.merchant.products.v1.Availability availability = 19;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearAvailabilityDate()
public ProductAttributes.Builder clearAvailabilityDate()The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
.google.protobuf.Timestamp availability_date = 20;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearBrand()
public ProductAttributes.Builder clearBrand()Brand of the item. For example, "Google".
optional string brand = 21;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearCanonicalLink()
public ProductAttributes.Builder clearCanonicalLink()URL for the canonical version of your item's landing page.
optional string canonical_link = 10;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearCertifications()
public ProductAttributes.Builder clearCertifications()Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearCloudExportAdditionalProperties()
public ProductAttributes.Builder clearCloudExportAdditionalProperties()Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearColor()
public ProductAttributes.Builder clearColor()Color of the item. For example, "red".
optional string color = 22;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearCondition()
public ProductAttributes.Builder clearCondition()Condition or state of the item.
optional .google.shopping.merchant.products.v1.Condition condition = 23;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearCostOfGoodsSold()
public ProductAttributes.Builder clearCostOfGoodsSold()Cost of goods sold. Used for gross profit reporting.
.google.shopping.type.Price cost_of_goods_sold = 62;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearCustomLabel0()
public ProductAttributes.Builder clearCustomLabel0()Custom label 0 for custom grouping of items in a Shopping campaign.
optional string custom_label_0 = 71;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearCustomLabel1()
public ProductAttributes.Builder clearCustomLabel1()Custom label 1 for custom grouping of items in a Shopping campaign.
optional string custom_label_1 = 72;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearCustomLabel2()
public ProductAttributes.Builder clearCustomLabel2()Custom label 2 for custom grouping of items in a Shopping campaign.
optional string custom_label_2 = 73;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearCustomLabel3()
public ProductAttributes.Builder clearCustomLabel3()Custom label 3 for custom grouping of items in a Shopping campaign.
optional string custom_label_3 = 74;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearCustomLabel4()
public ProductAttributes.Builder clearCustomLabel4()Custom label 4 for custom grouping of items in a Shopping campaign.
optional string custom_label_4 = 75;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearDescription()
public ProductAttributes.Builder clearDescription()Description of the item.
optional string description = 7;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearDisclosureDate()
public ProductAttributes.Builder clearDisclosureDate()The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.
.google.protobuf.Timestamp disclosure_date = 79;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearDisplayAdsId()
public ProductAttributes.Builder clearDisplayAdsId()An identifier for an item for dynamic remarketing campaigns.
optional string display_ads_id = 65;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearDisplayAdsLink()
public ProductAttributes.Builder clearDisplayAdsLink()URL directly to your item's landing page for dynamic remarketing campaigns.
optional string display_ads_link = 68;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearDisplayAdsSimilarIds()
public ProductAttributes.Builder clearDisplayAdsSimilarIds()Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearDisplayAdsTitle()
public ProductAttributes.Builder clearDisplayAdsTitle()Title of an item for dynamic remarketing campaigns.
optional string display_ads_title = 67;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearDisplayAdsValue()
public ProductAttributes.Builder clearDisplayAdsValue()Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute.
optional double display_ads_value = 69;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearEnergyEfficiencyClass()
public ProductAttributes.Builder clearEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass energy_efficiency_class = 53;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearExcludedDestinations()
public ProductAttributes.Builder clearExcludedDestinations()The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearExpirationDate()
public ProductAttributes.Builder clearExpirationDate() Date on which the item should expire, as specified upon insertion, in
ISO
8601 format. The actual
expiration date is exposed in productstatuses as
googleExpirationDate
and might be earlier if expirationDate is too far in the future.
.google.protobuf.Timestamp expiration_date = 16;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearExternalSellerId()
public ProductAttributes.Builder clearExternalSellerId()Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
optional string external_seller_id = 1;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public ProductAttributes.Builder clearField(Descriptors.FieldDescriptor field)| Parameter | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearFreeShippingThreshold()
public ProductAttributes.Builder clearFreeShippingThreshold()Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearGender()
public ProductAttributes.Builder clearGender()Target gender of the item.
optional .google.shopping.merchant.products.v1.Gender gender = 24;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearGoogleProductCategory()
public ProductAttributes.Builder clearGoogleProductCategory()Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
optional string google_product_category = 25;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearGtins()
public ProductAttributes.Builder clearGtins()Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearIdentifierExists()
public ProductAttributes.Builder clearIdentifierExists()Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.
optional bool identifier_exists = 4;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearImageLink()
public ProductAttributes.Builder clearImageLink()URL of an image of the item.
optional string image_link = 11;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearIncludedDestinations()
public ProductAttributes.Builder clearIncludedDestinations() The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearInstallment()
public ProductAttributes.Builder clearInstallment()Number and amount of installments to pay for an item.
.google.shopping.merchant.products.v1.ProductInstallment installment = 32;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearIsBundle()
public ProductAttributes.Builder clearIsBundle()Whether the item is a business-defined sub-API. A sub-API is a custom grouping of different products sold by a business for a single price.
optional bool is_bundle = 5;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearItemGroupId()
public ProductAttributes.Builder clearItemGroupId()Shared identifier for all variants of the same product.
optional string item_group_id = 27;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearLifestyleImageLinks()
public ProductAttributes.Builder clearLifestyleImageLinks()Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearLink()
public ProductAttributes.Builder clearLink()URL directly linking to your item's page on your online store.
optional string link = 8;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearLinkTemplate()
public ProductAttributes.Builder clearLinkTemplate()Link template for business hosted local storefront.
optional string link_template = 82;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearLoyaltyPoints()
public ProductAttributes.Builder clearLoyaltyPoints()Loyalty points that users receive after purchasing the item. Japan only.
.google.shopping.merchant.products.v1.LoyaltyPoints loyalty_points = 34;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearLoyaltyPrograms()
public ProductAttributes.Builder clearLoyaltyPrograms()A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearMaterial()
public ProductAttributes.Builder clearMaterial()The material of which the item is made. For example, "Leather" or "Cotton".
optional string material = 28;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearMaxEnergyEfficiencyClass()
public ProductAttributes.Builder clearMaxEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass max_energy_efficiency_class = 55;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearMaxHandlingTime()
public ProductAttributes.Builder clearMaxHandlingTime()Maximal product handling time (in business days).
optional int64 max_handling_time = 44;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearMaximumRetailPrice()
public ProductAttributes.Builder clearMaximumRetailPrice()Maximum retail price (MRP) of the item. Applicable to India only.
.google.shopping.type.Price maximum_retail_price = 139;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearMinEnergyEfficiencyClass()
public ProductAttributes.Builder clearMinEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass min_energy_efficiency_class = 54;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearMinHandlingTime()
public ProductAttributes.Builder clearMinHandlingTime()Minimal product handling time (in business days).
optional int64 min_handling_time = 45;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearMobileLink()
public ProductAttributes.Builder clearMobileLink()URL for the mobile-optimized version of your item's landing page.
optional string mobile_link = 9;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearMobileLinkTemplate()
public ProductAttributes.Builder clearMobileLinkTemplate()Link template for business hosted local storefront optimized for mobile devices.
optional string mobile_link_template = 83;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearMpn()
public ProductAttributes.Builder clearMpn()Manufacturer Part Number (MPN) of the item.
optional string mpn = 29;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearMultipack()
public ProductAttributes.Builder clearMultipack()The number of identical products in a business-defined multipack.
optional int64 multipack = 58;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public ProductAttributes.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Parameter | |
|---|---|
| Name | Description |
oneof |
OneofDescriptor |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearPattern()
public ProductAttributes.Builder clearPattern()The item's pattern. For example, polka dots.
optional string pattern = 30;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearPause()
public ProductAttributes.Builder clearPause()Publication of this item will be temporarily paused.
optional .google.shopping.merchant.products.v1.Pause pause = 13;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearPickupMethod()
public ProductAttributes.Builder clearPickupMethod()The pickup option for the item.
optional .google.shopping.merchant.products.v1.PickupMethod pickup_method = 80;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearPickupSla()
public ProductAttributes.Builder clearPickupSla()Item store pickup timeline. For more information, see Pickup SLA.
optional .google.shopping.merchant.products.v1.PickupSla pickup_sla = 81;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearPrice()
public ProductAttributes.Builder clearPrice()Price of the item.
.google.shopping.type.Price price = 31;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearProductDetails()
public ProductAttributes.Builder clearProductDetails()Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearProductHeight()
public ProductAttributes.Builder clearProductHeight()The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_height = 119;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearProductHighlights()
public ProductAttributes.Builder clearProductHighlights()Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearProductLength()
public ProductAttributes.Builder clearProductLength()The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_length = 120;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearProductTypes()
public ProductAttributes.Builder clearProductTypes()Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearProductWeight()
public ProductAttributes.Builder clearProductWeight()The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
.google.shopping.merchant.products.v1.ProductWeight product_weight = 122;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearProductWidth()
public ProductAttributes.Builder clearProductWidth()The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_width = 121;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearPromotionIds()
public ProductAttributes.Builder clearPromotionIds()The unique ID of a promotion.
repeated string promotion_ids = 70;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearSalePrice()
public ProductAttributes.Builder clearSalePrice()Advertised sale price of the item.
.google.shopping.type.Price sale_price = 36;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearSalePriceEffectiveDate()
public ProductAttributes.Builder clearSalePriceEffectiveDate()Date range during which the item is on sale, see product data specification.
.google.type.Interval sale_price_effective_date = 37;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearSellOnGoogleQuantity()
public ProductAttributes.Builder clearSellOnGoogleQuantity()The quantity of the product that is available for selling on Google. Supported only for online products.
optional int64 sell_on_google_quantity = 38;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearShipping()
public ProductAttributes.Builder clearShipping()Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearShippingHeight()
public ProductAttributes.Builder clearShippingHeight()Height of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_height = 43;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearShippingLabel()
public ProductAttributes.Builder clearShippingLabel()The shipping label of the product, used to group product in account-level shipping rules.
optional string shipping_label = 46;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearShippingLength()
public ProductAttributes.Builder clearShippingLength()Length of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_length = 41;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearShippingWeight()
public ProductAttributes.Builder clearShippingWeight()Weight of the item for shipping.
.google.shopping.merchant.products.v1.ShippingWeight shipping_weight = 40;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearShippingWidth()
public ProductAttributes.Builder clearShippingWidth()Width of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_width = 42;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearShoppingAdsExcludedCountries()
public ProductAttributes.Builder clearShoppingAdsExcludedCountries()List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearSize()
public ProductAttributes.Builder clearSize() Size of the item. Only one value is allowed. For variants with different
sizes, insert a separate product for each size with the same
itemGroupId value, see
Size.
optional string size = 48;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearSizeSystem()
public ProductAttributes.Builder clearSizeSystem()System in which the size is specified. Recommended for apparel items. For more information, see Size system.
optional .google.shopping.merchant.products.v1.SizeSystem size_system = 49;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearSizeTypes()
public ProductAttributes.Builder clearSizeTypes()The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearStructuredDescription()
public ProductAttributes.Builder clearStructuredDescription()Structured description, for algorithmically (AI)-generated descriptions.
optional .google.shopping.merchant.products.v1.StructuredDescription structured_description = 133;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearStructuredTitle()
public ProductAttributes.Builder clearStructuredTitle()Structured title, for algorithmically (AI)-generated titles.
optional .google.shopping.merchant.products.v1.StructuredTitle structured_title = 132;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearSubscriptionCost()
public ProductAttributes.Builder clearSubscriptionCost()Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
.google.shopping.merchant.products.v1.SubscriptionCost subscription_cost = 33;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearSustainabilityIncentives()
public ProductAttributes.Builder clearSustainabilityIncentives()The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearTitle()
public ProductAttributes.Builder clearTitle()Title of the item.
optional string title = 6;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearTransitTimeLabel()
public ProductAttributes.Builder clearTransitTimeLabel()The transit time label of the product, used to group product in account-level transit time tables.
optional string transit_time_label = 47;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clearUnitPricingBaseMeasure()
public ProductAttributes.Builder clearUnitPricingBaseMeasure()The preference of the denominator of the unit price.
.google.shopping.merchant.products.v1.UnitPricingBaseMeasure unit_pricing_base_measure = 57;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearUnitPricingMeasure()
public ProductAttributes.Builder clearUnitPricingMeasure()The measure and dimension of an item.
.google.shopping.merchant.products.v1.UnitPricingMeasure unit_pricing_measure = 56;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
clearVirtualModelLink()
public ProductAttributes.Builder clearVirtualModelLink()URL of the 3D image of the item. See the Help Center article for more information.
optional string virtual_model_link = 130;
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
clone()
public ProductAttributes.Builder clone()| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
getAdditionalImageLinks(int index)
public String getAdditionalImageLinks(int index)Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The additionalImageLinks at the given index. |
getAdditionalImageLinksBytes(int index)
public ByteString getAdditionalImageLinksBytes(int index)Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the additionalImageLinks at the given index. |
getAdditionalImageLinksCount()
public int getAdditionalImageLinksCount()Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Returns | |
|---|---|
| Type | Description |
int |
The count of additionalImageLinks. |
getAdditionalImageLinksList()
public ProtocolStringList getAdditionalImageLinksList()Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the additionalImageLinks. |
getAdsGrouping()
public String getAdsGrouping()Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
optional string ads_grouping = 59;
| Returns | |
|---|---|
| Type | Description |
String |
The adsGrouping. |
getAdsGroupingBytes()
public ByteString getAdsGroupingBytes()Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
optional string ads_grouping = 59;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for adsGrouping. |
getAdsLabels(int index)
public String getAdsLabels(int index)Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The adsLabels at the given index. |
getAdsLabelsBytes(int index)
public ByteString getAdsLabelsBytes(int index)Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the adsLabels at the given index. |
getAdsLabelsCount()
public int getAdsLabelsCount()Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Returns | |
|---|---|
| Type | Description |
int |
The count of adsLabels. |
getAdsLabelsList()
public ProtocolStringList getAdsLabelsList()Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the adsLabels. |
getAdsRedirect()
public String getAdsRedirect()Allows advertisers to override the item URL when the product is shown within the context of Product ads.
optional string ads_redirect = 61;
| Returns | |
|---|---|
| Type | Description |
String |
The adsRedirect. |
getAdsRedirectBytes()
public ByteString getAdsRedirectBytes()Allows advertisers to override the item URL when the product is shown within the context of Product ads.
optional string ads_redirect = 61;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for adsRedirect. |
getAdult()
public boolean getAdult()Set to true if the item is targeted towards adults.
optional bool adult = 17;
| Returns | |
|---|---|
| Type | Description |
boolean |
The adult. |
getAgeGroup()
public AgeGroup getAgeGroup()Target age group of the item.
optional .google.shopping.merchant.products.v1.AgeGroup age_group = 18;
| Returns | |
|---|---|
| Type | Description |
AgeGroup |
The ageGroup. |
getAgeGroupValue()
public int getAgeGroupValue()Target age group of the item.
optional .google.shopping.merchant.products.v1.AgeGroup age_group = 18;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for ageGroup. |
getAutoPricingMinPrice()
public Price getAutoPricingMinPrice()A safeguard in the automated discounts and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
.google.shopping.type.Price auto_pricing_min_price = 124;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price |
The autoPricingMinPrice. |
getAutoPricingMinPriceBuilder()
public Price.Builder getAutoPricingMinPriceBuilder()A safeguard in the automated discounts and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
.google.shopping.type.Price auto_pricing_min_price = 124;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price.Builder |
|
getAutoPricingMinPriceOrBuilder()
public PriceOrBuilder getAutoPricingMinPriceOrBuilder()A safeguard in the automated discounts and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
.google.shopping.type.Price auto_pricing_min_price = 124;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.PriceOrBuilder |
|
getAvailability()
public Availability getAvailability()Availability status of the item.
optional .google.shopping.merchant.products.v1.Availability availability = 19;
| Returns | |
|---|---|
| Type | Description |
Availability |
The availability. |
getAvailabilityDate()
public Timestamp getAvailabilityDate()The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
.google.protobuf.Timestamp availability_date = 20;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The availabilityDate. |
getAvailabilityDateBuilder()
public Timestamp.Builder getAvailabilityDateBuilder()The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
.google.protobuf.Timestamp availability_date = 20;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getAvailabilityDateOrBuilder()
public TimestampOrBuilder getAvailabilityDateOrBuilder()The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
.google.protobuf.Timestamp availability_date = 20;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getAvailabilityValue()
public int getAvailabilityValue()Availability status of the item.
optional .google.shopping.merchant.products.v1.Availability availability = 19;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for availability. |
getBrand()
public String getBrand()Brand of the item. For example, "Google".
optional string brand = 21;
| Returns | |
|---|---|
| Type | Description |
String |
The brand. |
getBrandBytes()
public ByteString getBrandBytes()Brand of the item. For example, "Google".
optional string brand = 21;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for brand. |
getCanonicalLink()
public String getCanonicalLink()URL for the canonical version of your item's landing page.
optional string canonical_link = 10;
| Returns | |
|---|---|
| Type | Description |
String |
The canonicalLink. |
getCanonicalLinkBytes()
public ByteString getCanonicalLinkBytes()URL for the canonical version of your item's landing page.
optional string canonical_link = 10;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for canonicalLink. |
getCertifications(int index)
public ProductCertification getCertifications(int index)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductCertification |
|
getCertificationsBuilder(int index)
public ProductCertification.Builder getCertificationsBuilder(int index)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductCertification.Builder |
|
getCertificationsBuilderList()
public List<ProductCertification.Builder> getCertificationsBuilderList()Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getCertificationsCount()
public int getCertificationsCount()Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Returns | |
|---|---|
| Type | Description |
int |
|
getCertificationsList()
public List<ProductCertification> getCertificationsList()Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Returns | |
|---|---|
| Type | Description |
List<ProductCertification> |
|
getCertificationsOrBuilder(int index)
public ProductCertificationOrBuilder getCertificationsOrBuilder(int index)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductCertificationOrBuilder |
|
getCertificationsOrBuilderList()
public List<? extends ProductCertificationOrBuilder> getCertificationsOrBuilderList()Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.shopping.merchant.products.v1.ProductCertificationOrBuilder> |
|
getCloudExportAdditionalProperties(int index)
public CloudExportAdditionalProperties getCloudExportAdditionalProperties(int index)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CloudExportAdditionalProperties |
|
getCloudExportAdditionalPropertiesBuilder(int index)
public CloudExportAdditionalProperties.Builder getCloudExportAdditionalPropertiesBuilder(int index)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CloudExportAdditionalProperties.Builder |
|
getCloudExportAdditionalPropertiesBuilderList()
public List<CloudExportAdditionalProperties.Builder> getCloudExportAdditionalPropertiesBuilderList()Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getCloudExportAdditionalPropertiesCount()
public int getCloudExportAdditionalPropertiesCount()Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Returns | |
|---|---|
| Type | Description |
int |
|
getCloudExportAdditionalPropertiesList()
public List<CloudExportAdditionalProperties> getCloudExportAdditionalPropertiesList()Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Returns | |
|---|---|
| Type | Description |
List<CloudExportAdditionalProperties> |
|
getCloudExportAdditionalPropertiesOrBuilder(int index)
public CloudExportAdditionalPropertiesOrBuilder getCloudExportAdditionalPropertiesOrBuilder(int index)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
CloudExportAdditionalPropertiesOrBuilder |
|
getCloudExportAdditionalPropertiesOrBuilderList()
public List<? extends CloudExportAdditionalPropertiesOrBuilder> getCloudExportAdditionalPropertiesOrBuilderList()Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.shopping.merchant.products.v1.CloudExportAdditionalPropertiesOrBuilder> |
|
getColor()
public String getColor()Color of the item. For example, "red".
optional string color = 22;
| Returns | |
|---|---|
| Type | Description |
String |
The color. |
getColorBytes()
public ByteString getColorBytes()Color of the item. For example, "red".
optional string color = 22;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for color. |
getCondition()
public Condition getCondition()Condition or state of the item.
optional .google.shopping.merchant.products.v1.Condition condition = 23;
| Returns | |
|---|---|
| Type | Description |
Condition |
The condition. |
getConditionValue()
public int getConditionValue()Condition or state of the item.
optional .google.shopping.merchant.products.v1.Condition condition = 23;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for condition. |
getCostOfGoodsSold()
public Price getCostOfGoodsSold()Cost of goods sold. Used for gross profit reporting.
.google.shopping.type.Price cost_of_goods_sold = 62;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price |
The costOfGoodsSold. |
getCostOfGoodsSoldBuilder()
public Price.Builder getCostOfGoodsSoldBuilder()Cost of goods sold. Used for gross profit reporting.
.google.shopping.type.Price cost_of_goods_sold = 62;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price.Builder |
|
getCostOfGoodsSoldOrBuilder()
public PriceOrBuilder getCostOfGoodsSoldOrBuilder()Cost of goods sold. Used for gross profit reporting.
.google.shopping.type.Price cost_of_goods_sold = 62;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.PriceOrBuilder |
|
getCustomLabel0()
public String getCustomLabel0()Custom label 0 for custom grouping of items in a Shopping campaign.
optional string custom_label_0 = 71;
| Returns | |
|---|---|
| Type | Description |
String |
The customLabel0. |
getCustomLabel0Bytes()
public ByteString getCustomLabel0Bytes()Custom label 0 for custom grouping of items in a Shopping campaign.
optional string custom_label_0 = 71;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customLabel0. |
getCustomLabel1()
public String getCustomLabel1()Custom label 1 for custom grouping of items in a Shopping campaign.
optional string custom_label_1 = 72;
| Returns | |
|---|---|
| Type | Description |
String |
The customLabel1. |
getCustomLabel1Bytes()
public ByteString getCustomLabel1Bytes()Custom label 1 for custom grouping of items in a Shopping campaign.
optional string custom_label_1 = 72;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customLabel1. |
getCustomLabel2()
public String getCustomLabel2()Custom label 2 for custom grouping of items in a Shopping campaign.
optional string custom_label_2 = 73;
| Returns | |
|---|---|
| Type | Description |
String |
The customLabel2. |
getCustomLabel2Bytes()
public ByteString getCustomLabel2Bytes()Custom label 2 for custom grouping of items in a Shopping campaign.
optional string custom_label_2 = 73;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customLabel2. |
getCustomLabel3()
public String getCustomLabel3()Custom label 3 for custom grouping of items in a Shopping campaign.
optional string custom_label_3 = 74;
| Returns | |
|---|---|
| Type | Description |
String |
The customLabel3. |
getCustomLabel3Bytes()
public ByteString getCustomLabel3Bytes()Custom label 3 for custom grouping of items in a Shopping campaign.
optional string custom_label_3 = 74;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customLabel3. |
getCustomLabel4()
public String getCustomLabel4()Custom label 4 for custom grouping of items in a Shopping campaign.
optional string custom_label_4 = 75;
| Returns | |
|---|---|
| Type | Description |
String |
The customLabel4. |
getCustomLabel4Bytes()
public ByteString getCustomLabel4Bytes()Custom label 4 for custom grouping of items in a Shopping campaign.
optional string custom_label_4 = 75;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for customLabel4. |
getDefaultInstanceForType()
public ProductAttributes getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
ProductAttributes |
|
getDescription()
public String getDescription()Description of the item.
optional string description = 7;
| Returns | |
|---|---|
| Type | Description |
String |
The description. |
getDescriptionBytes()
public ByteString getDescriptionBytes()Description of the item.
optional string description = 7;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for description. |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
getDisclosureDate()
public Timestamp getDisclosureDate()The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.
.google.protobuf.Timestamp disclosure_date = 79;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The disclosureDate. |
getDisclosureDateBuilder()
public Timestamp.Builder getDisclosureDateBuilder()The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.
.google.protobuf.Timestamp disclosure_date = 79;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getDisclosureDateOrBuilder()
public TimestampOrBuilder getDisclosureDateOrBuilder()The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.
.google.protobuf.Timestamp disclosure_date = 79;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getDisplayAdsId()
public String getDisplayAdsId()An identifier for an item for dynamic remarketing campaigns.
optional string display_ads_id = 65;
| Returns | |
|---|---|
| Type | Description |
String |
The displayAdsId. |
getDisplayAdsIdBytes()
public ByteString getDisplayAdsIdBytes()An identifier for an item for dynamic remarketing campaigns.
optional string display_ads_id = 65;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayAdsId. |
getDisplayAdsLink()
public String getDisplayAdsLink()URL directly to your item's landing page for dynamic remarketing campaigns.
optional string display_ads_link = 68;
| Returns | |
|---|---|
| Type | Description |
String |
The displayAdsLink. |
getDisplayAdsLinkBytes()
public ByteString getDisplayAdsLinkBytes()URL directly to your item's landing page for dynamic remarketing campaigns.
optional string display_ads_link = 68;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayAdsLink. |
getDisplayAdsSimilarIds(int index)
public String getDisplayAdsSimilarIds(int index)Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The displayAdsSimilarIds at the given index. |
getDisplayAdsSimilarIdsBytes(int index)
public ByteString getDisplayAdsSimilarIdsBytes(int index)Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the displayAdsSimilarIds at the given index. |
getDisplayAdsSimilarIdsCount()
public int getDisplayAdsSimilarIdsCount()Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Returns | |
|---|---|
| Type | Description |
int |
The count of displayAdsSimilarIds. |
getDisplayAdsSimilarIdsList()
public ProtocolStringList getDisplayAdsSimilarIdsList()Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the displayAdsSimilarIds. |
getDisplayAdsTitle()
public String getDisplayAdsTitle()Title of an item for dynamic remarketing campaigns.
optional string display_ads_title = 67;
| Returns | |
|---|---|
| Type | Description |
String |
The displayAdsTitle. |
getDisplayAdsTitleBytes()
public ByteString getDisplayAdsTitleBytes()Title of an item for dynamic remarketing campaigns.
optional string display_ads_title = 67;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for displayAdsTitle. |
getDisplayAdsValue()
public double getDisplayAdsValue()Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute.
optional double display_ads_value = 69;
| Returns | |
|---|---|
| Type | Description |
double |
The displayAdsValue. |
getEnergyEfficiencyClass()
public EnergyEfficiencyClass getEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass energy_efficiency_class = 53;
| Returns | |
|---|---|
| Type | Description |
EnergyEfficiencyClass |
The energyEfficiencyClass. |
getEnergyEfficiencyClassValue()
public int getEnergyEfficiencyClassValue()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass energy_efficiency_class = 53;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for energyEfficiencyClass. |
getExcludedDestinations(int index)
public Destination.DestinationEnum getExcludedDestinations(int index)The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Destination.DestinationEnum |
The excludedDestinations at the given index. |
getExcludedDestinationsCount()
public int getExcludedDestinationsCount()The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Returns | |
|---|---|
| Type | Description |
int |
The count of excludedDestinations. |
getExcludedDestinationsList()
public List<Destination.DestinationEnum> getExcludedDestinationsList()The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Returns | |
|---|---|
| Type | Description |
List<com.google.shopping.type.Destination.DestinationEnum> |
A list containing the excludedDestinations. |
getExcludedDestinationsValue(int index)
public int getExcludedDestinationsValue(int index)The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of excludedDestinations at the given index. |
getExcludedDestinationsValueList()
public List<Integer> getExcludedDestinationsValueList()The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for excludedDestinations. |
getExpirationDate()
public Timestamp getExpirationDate() Date on which the item should expire, as specified upon insertion, in
ISO
8601 format. The actual
expiration date is exposed in productstatuses as
googleExpirationDate
and might be earlier if expirationDate is too far in the future.
.google.protobuf.Timestamp expiration_date = 16;
| Returns | |
|---|---|
| Type | Description |
Timestamp |
The expirationDate. |
getExpirationDateBuilder()
public Timestamp.Builder getExpirationDateBuilder() Date on which the item should expire, as specified upon insertion, in
ISO
8601 format. The actual
expiration date is exposed in productstatuses as
googleExpirationDate
and might be earlier if expirationDate is too far in the future.
.google.protobuf.Timestamp expiration_date = 16;
| Returns | |
|---|---|
| Type | Description |
Builder |
|
getExpirationDateOrBuilder()
public TimestampOrBuilder getExpirationDateOrBuilder() Date on which the item should expire, as specified upon insertion, in
ISO
8601 format. The actual
expiration date is exposed in productstatuses as
googleExpirationDate
and might be earlier if expirationDate is too far in the future.
.google.protobuf.Timestamp expiration_date = 16;
| Returns | |
|---|---|
| Type | Description |
TimestampOrBuilder |
|
getExternalSellerId()
public String getExternalSellerId()Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
optional string external_seller_id = 1;
| Returns | |
|---|---|
| Type | Description |
String |
The externalSellerId. |
getExternalSellerIdBytes()
public ByteString getExternalSellerIdBytes()Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
optional string external_seller_id = 1;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for externalSellerId. |
getFreeShippingThreshold(int index)
public FreeShippingThreshold getFreeShippingThreshold(int index)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FreeShippingThreshold |
|
getFreeShippingThresholdBuilder(int index)
public FreeShippingThreshold.Builder getFreeShippingThresholdBuilder(int index)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FreeShippingThreshold.Builder |
|
getFreeShippingThresholdBuilderList()
public List<FreeShippingThreshold.Builder> getFreeShippingThresholdBuilderList()Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getFreeShippingThresholdCount()
public int getFreeShippingThresholdCount()Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Returns | |
|---|---|
| Type | Description |
int |
|
getFreeShippingThresholdList()
public List<FreeShippingThreshold> getFreeShippingThresholdList()Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Returns | |
|---|---|
| Type | Description |
List<FreeShippingThreshold> |
|
getFreeShippingThresholdOrBuilder(int index)
public FreeShippingThresholdOrBuilder getFreeShippingThresholdOrBuilder(int index)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
FreeShippingThresholdOrBuilder |
|
getFreeShippingThresholdOrBuilderList()
public List<? extends FreeShippingThresholdOrBuilder> getFreeShippingThresholdOrBuilderList()Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.shopping.merchant.products.v1.FreeShippingThresholdOrBuilder> |
|
getGender()
public Gender getGender()Target gender of the item.
optional .google.shopping.merchant.products.v1.Gender gender = 24;
| Returns | |
|---|---|
| Type | Description |
Gender |
The gender. |
getGenderValue()
public int getGenderValue()Target gender of the item.
optional .google.shopping.merchant.products.v1.Gender gender = 24;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for gender. |
getGoogleProductCategory()
public String getGoogleProductCategory()Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
optional string google_product_category = 25;
| Returns | |
|---|---|
| Type | Description |
String |
The googleProductCategory. |
getGoogleProductCategoryBytes()
public ByteString getGoogleProductCategoryBytes()Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
optional string google_product_category = 25;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for googleProductCategory. |
getGtins(int index)
public String getGtins(int index)Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The gtins at the given index. |
getGtinsBytes(int index)
public ByteString getGtinsBytes(int index)Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the gtins at the given index. |
getGtinsCount()
public int getGtinsCount()Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Returns | |
|---|---|
| Type | Description |
int |
The count of gtins. |
getGtinsList()
public ProtocolStringList getGtinsList()Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the gtins. |
getIdentifierExists()
public boolean getIdentifierExists()Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.
optional bool identifier_exists = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
The identifierExists. |
getImageLink()
public String getImageLink()URL of an image of the item.
optional string image_link = 11;
| Returns | |
|---|---|
| Type | Description |
String |
The imageLink. |
getImageLinkBytes()
public ByteString getImageLinkBytes()URL of an image of the item.
optional string image_link = 11;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for imageLink. |
getIncludedDestinations(int index)
public Destination.DestinationEnum getIncludedDestinations(int index) The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Destination.DestinationEnum |
The includedDestinations at the given index. |
getIncludedDestinationsCount()
public int getIncludedDestinationsCount() The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Returns | |
|---|---|
| Type | Description |
int |
The count of includedDestinations. |
getIncludedDestinationsList()
public List<Destination.DestinationEnum> getIncludedDestinationsList() The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Returns | |
|---|---|
| Type | Description |
List<com.google.shopping.type.Destination.DestinationEnum> |
A list containing the includedDestinations. |
getIncludedDestinationsValue(int index)
public int getIncludedDestinationsValue(int index) The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of includedDestinations at the given index. |
getIncludedDestinationsValueList()
public List<Integer> getIncludedDestinationsValueList() The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for includedDestinations. |
getInstallment()
public ProductInstallment getInstallment()Number and amount of installments to pay for an item.
.google.shopping.merchant.products.v1.ProductInstallment installment = 32;
| Returns | |
|---|---|
| Type | Description |
ProductInstallment |
The installment. |
getInstallmentBuilder()
public ProductInstallment.Builder getInstallmentBuilder()Number and amount of installments to pay for an item.
.google.shopping.merchant.products.v1.ProductInstallment installment = 32;
| Returns | |
|---|---|
| Type | Description |
ProductInstallment.Builder |
|
getInstallmentOrBuilder()
public ProductInstallmentOrBuilder getInstallmentOrBuilder()Number and amount of installments to pay for an item.
.google.shopping.merchant.products.v1.ProductInstallment installment = 32;
| Returns | |
|---|---|
| Type | Description |
ProductInstallmentOrBuilder |
|
getIsBundle()
public boolean getIsBundle()Whether the item is a business-defined sub-API. A sub-API is a custom grouping of different products sold by a business for a single price.
optional bool is_bundle = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
The isBundle. |
getItemGroupId()
public String getItemGroupId()Shared identifier for all variants of the same product.
optional string item_group_id = 27;
| Returns | |
|---|---|
| Type | Description |
String |
The itemGroupId. |
getItemGroupIdBytes()
public ByteString getItemGroupIdBytes()Shared identifier for all variants of the same product.
optional string item_group_id = 27;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for itemGroupId. |
getLifestyleImageLinks(int index)
public String getLifestyleImageLinks(int index)Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The lifestyleImageLinks at the given index. |
getLifestyleImageLinksBytes(int index)
public ByteString getLifestyleImageLinksBytes(int index)Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the lifestyleImageLinks at the given index. |
getLifestyleImageLinksCount()
public int getLifestyleImageLinksCount()Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Returns | |
|---|---|
| Type | Description |
int |
The count of lifestyleImageLinks. |
getLifestyleImageLinksList()
public ProtocolStringList getLifestyleImageLinksList()Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the lifestyleImageLinks. |
getLink()
public String getLink()URL directly linking to your item's page on your online store.
optional string link = 8;
| Returns | |
|---|---|
| Type | Description |
String |
The link. |
getLinkBytes()
public ByteString getLinkBytes()URL directly linking to your item's page on your online store.
optional string link = 8;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for link. |
getLinkTemplate()
public String getLinkTemplate()Link template for business hosted local storefront.
optional string link_template = 82;
| Returns | |
|---|---|
| Type | Description |
String |
The linkTemplate. |
getLinkTemplateBytes()
public ByteString getLinkTemplateBytes()Link template for business hosted local storefront.
optional string link_template = 82;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for linkTemplate. |
getLoyaltyPoints()
public LoyaltyPoints getLoyaltyPoints()Loyalty points that users receive after purchasing the item. Japan only.
.google.shopping.merchant.products.v1.LoyaltyPoints loyalty_points = 34;
| Returns | |
|---|---|
| Type | Description |
LoyaltyPoints |
The loyaltyPoints. |
getLoyaltyPointsBuilder()
public LoyaltyPoints.Builder getLoyaltyPointsBuilder()Loyalty points that users receive after purchasing the item. Japan only.
.google.shopping.merchant.products.v1.LoyaltyPoints loyalty_points = 34;
| Returns | |
|---|---|
| Type | Description |
LoyaltyPoints.Builder |
|
getLoyaltyPointsOrBuilder()
public LoyaltyPointsOrBuilder getLoyaltyPointsOrBuilder()Loyalty points that users receive after purchasing the item. Japan only.
.google.shopping.merchant.products.v1.LoyaltyPoints loyalty_points = 34;
| Returns | |
|---|---|
| Type | Description |
LoyaltyPointsOrBuilder |
|
getLoyaltyPrograms(int index)
public LoyaltyProgram getLoyaltyPrograms(int index)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
LoyaltyProgram |
|
getLoyaltyProgramsBuilder(int index)
public LoyaltyProgram.Builder getLoyaltyProgramsBuilder(int index)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
LoyaltyProgram.Builder |
|
getLoyaltyProgramsBuilderList()
public List<LoyaltyProgram.Builder> getLoyaltyProgramsBuilderList()A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getLoyaltyProgramsCount()
public int getLoyaltyProgramsCount()A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Returns | |
|---|---|
| Type | Description |
int |
|
getLoyaltyProgramsList()
public List<LoyaltyProgram> getLoyaltyProgramsList()A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Returns | |
|---|---|
| Type | Description |
List<LoyaltyProgram> |
|
getLoyaltyProgramsOrBuilder(int index)
public LoyaltyProgramOrBuilder getLoyaltyProgramsOrBuilder(int index)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
LoyaltyProgramOrBuilder |
|
getLoyaltyProgramsOrBuilderList()
public List<? extends LoyaltyProgramOrBuilder> getLoyaltyProgramsOrBuilderList()A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.shopping.merchant.products.v1.LoyaltyProgramOrBuilder> |
|
getMaterial()
public String getMaterial()The material of which the item is made. For example, "Leather" or "Cotton".
optional string material = 28;
| Returns | |
|---|---|
| Type | Description |
String |
The material. |
getMaterialBytes()
public ByteString getMaterialBytes()The material of which the item is made. For example, "Leather" or "Cotton".
optional string material = 28;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for material. |
getMaxEnergyEfficiencyClass()
public EnergyEfficiencyClass getMaxEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass max_energy_efficiency_class = 55;
| Returns | |
|---|---|
| Type | Description |
EnergyEfficiencyClass |
The maxEnergyEfficiencyClass. |
getMaxEnergyEfficiencyClassValue()
public int getMaxEnergyEfficiencyClassValue()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass max_energy_efficiency_class = 55;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for maxEnergyEfficiencyClass. |
getMaxHandlingTime()
public long getMaxHandlingTime()Maximal product handling time (in business days).
optional int64 max_handling_time = 44;
| Returns | |
|---|---|
| Type | Description |
long |
The maxHandlingTime. |
getMaximumRetailPrice()
public Price getMaximumRetailPrice()Maximum retail price (MRP) of the item. Applicable to India only.
.google.shopping.type.Price maximum_retail_price = 139;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price |
The maximumRetailPrice. |
getMaximumRetailPriceBuilder()
public Price.Builder getMaximumRetailPriceBuilder()Maximum retail price (MRP) of the item. Applicable to India only.
.google.shopping.type.Price maximum_retail_price = 139;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price.Builder |
|
getMaximumRetailPriceOrBuilder()
public PriceOrBuilder getMaximumRetailPriceOrBuilder()Maximum retail price (MRP) of the item. Applicable to India only.
.google.shopping.type.Price maximum_retail_price = 139;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.PriceOrBuilder |
|
getMinEnergyEfficiencyClass()
public EnergyEfficiencyClass getMinEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass min_energy_efficiency_class = 54;
| Returns | |
|---|---|
| Type | Description |
EnergyEfficiencyClass |
The minEnergyEfficiencyClass. |
getMinEnergyEfficiencyClassValue()
public int getMinEnergyEfficiencyClassValue()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass min_energy_efficiency_class = 54;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for minEnergyEfficiencyClass. |
getMinHandlingTime()
public long getMinHandlingTime()Minimal product handling time (in business days).
optional int64 min_handling_time = 45;
| Returns | |
|---|---|
| Type | Description |
long |
The minHandlingTime. |
getMobileLink()
public String getMobileLink()URL for the mobile-optimized version of your item's landing page.
optional string mobile_link = 9;
| Returns | |
|---|---|
| Type | Description |
String |
The mobileLink. |
getMobileLinkBytes()
public ByteString getMobileLinkBytes()URL for the mobile-optimized version of your item's landing page.
optional string mobile_link = 9;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mobileLink. |
getMobileLinkTemplate()
public String getMobileLinkTemplate()Link template for business hosted local storefront optimized for mobile devices.
optional string mobile_link_template = 83;
| Returns | |
|---|---|
| Type | Description |
String |
The mobileLinkTemplate. |
getMobileLinkTemplateBytes()
public ByteString getMobileLinkTemplateBytes()Link template for business hosted local storefront optimized for mobile devices.
optional string mobile_link_template = 83;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mobileLinkTemplate. |
getMpn()
public String getMpn()Manufacturer Part Number (MPN) of the item.
optional string mpn = 29;
| Returns | |
|---|---|
| Type | Description |
String |
The mpn. |
getMpnBytes()
public ByteString getMpnBytes()Manufacturer Part Number (MPN) of the item.
optional string mpn = 29;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for mpn. |
getMultipack()
public long getMultipack()The number of identical products in a business-defined multipack.
optional int64 multipack = 58;
| Returns | |
|---|---|
| Type | Description |
long |
The multipack. |
getPattern()
public String getPattern()The item's pattern. For example, polka dots.
optional string pattern = 30;
| Returns | |
|---|---|
| Type | Description |
String |
The pattern. |
getPatternBytes()
public ByteString getPatternBytes()The item's pattern. For example, polka dots.
optional string pattern = 30;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for pattern. |
getPause()
public Pause getPause()Publication of this item will be temporarily paused.
optional .google.shopping.merchant.products.v1.Pause pause = 13;
| Returns | |
|---|---|
| Type | Description |
Pause |
The pause. |
getPauseValue()
public int getPauseValue()Publication of this item will be temporarily paused.
optional .google.shopping.merchant.products.v1.Pause pause = 13;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for pause. |
getPickupMethod()
public PickupMethod getPickupMethod()The pickup option for the item.
optional .google.shopping.merchant.products.v1.PickupMethod pickup_method = 80;
| Returns | |
|---|---|
| Type | Description |
PickupMethod |
The pickupMethod. |
getPickupMethodValue()
public int getPickupMethodValue()The pickup option for the item.
optional .google.shopping.merchant.products.v1.PickupMethod pickup_method = 80;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for pickupMethod. |
getPickupSla()
public PickupSla getPickupSla()Item store pickup timeline. For more information, see Pickup SLA.
optional .google.shopping.merchant.products.v1.PickupSla pickup_sla = 81;
| Returns | |
|---|---|
| Type | Description |
PickupSla |
The pickupSla. |
getPickupSlaValue()
public int getPickupSlaValue()Item store pickup timeline. For more information, see Pickup SLA.
optional .google.shopping.merchant.products.v1.PickupSla pickup_sla = 81;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for pickupSla. |
getPrice()
public Price getPrice()Price of the item.
.google.shopping.type.Price price = 31;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price |
The price. |
getPriceBuilder()
public Price.Builder getPriceBuilder()Price of the item.
.google.shopping.type.Price price = 31;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price.Builder |
|
getPriceOrBuilder()
public PriceOrBuilder getPriceOrBuilder()Price of the item.
.google.shopping.type.Price price = 31;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.PriceOrBuilder |
|
getProductDetails(int index)
public ProductDetail getProductDetails(int index)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductDetail |
|
getProductDetailsBuilder(int index)
public ProductDetail.Builder getProductDetailsBuilder(int index)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductDetail.Builder |
|
getProductDetailsBuilderList()
public List<ProductDetail.Builder> getProductDetailsBuilderList()Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getProductDetailsCount()
public int getProductDetailsCount()Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Returns | |
|---|---|
| Type | Description |
int |
|
getProductDetailsList()
public List<ProductDetail> getProductDetailsList()Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Returns | |
|---|---|
| Type | Description |
List<ProductDetail> |
|
getProductDetailsOrBuilder(int index)
public ProductDetailOrBuilder getProductDetailsOrBuilder(int index)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductDetailOrBuilder |
|
getProductDetailsOrBuilderList()
public List<? extends ProductDetailOrBuilder> getProductDetailsOrBuilderList()Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.shopping.merchant.products.v1.ProductDetailOrBuilder> |
|
getProductHeight()
public ProductDimension getProductHeight()The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_height = 119;
| Returns | |
|---|---|
| Type | Description |
ProductDimension |
The productHeight. |
getProductHeightBuilder()
public ProductDimension.Builder getProductHeightBuilder()The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_height = 119;
| Returns | |
|---|---|
| Type | Description |
ProductDimension.Builder |
|
getProductHeightOrBuilder()
public ProductDimensionOrBuilder getProductHeightOrBuilder()The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_height = 119;
| Returns | |
|---|---|
| Type | Description |
ProductDimensionOrBuilder |
|
getProductHighlights(int index)
public String getProductHighlights(int index)Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The productHighlights at the given index. |
getProductHighlightsBytes(int index)
public ByteString getProductHighlightsBytes(int index)Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the productHighlights at the given index. |
getProductHighlightsCount()
public int getProductHighlightsCount()Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Returns | |
|---|---|
| Type | Description |
int |
The count of productHighlights. |
getProductHighlightsList()
public ProtocolStringList getProductHighlightsList()Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the productHighlights. |
getProductLength()
public ProductDimension getProductLength()The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_length = 120;
| Returns | |
|---|---|
| Type | Description |
ProductDimension |
The productLength. |
getProductLengthBuilder()
public ProductDimension.Builder getProductLengthBuilder()The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_length = 120;
| Returns | |
|---|---|
| Type | Description |
ProductDimension.Builder |
|
getProductLengthOrBuilder()
public ProductDimensionOrBuilder getProductLengthOrBuilder()The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_length = 120;
| Returns | |
|---|---|
| Type | Description |
ProductDimensionOrBuilder |
|
getProductTypes(int index)
public String getProductTypes(int index)Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The productTypes at the given index. |
getProductTypesBytes(int index)
public ByteString getProductTypesBytes(int index)Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the productTypes at the given index. |
getProductTypesCount()
public int getProductTypesCount()Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Returns | |
|---|---|
| Type | Description |
int |
The count of productTypes. |
getProductTypesList()
public ProtocolStringList getProductTypesList()Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the productTypes. |
getProductWeight()
public ProductWeight getProductWeight()The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
.google.shopping.merchant.products.v1.ProductWeight product_weight = 122;
| Returns | |
|---|---|
| Type | Description |
ProductWeight |
The productWeight. |
getProductWeightBuilder()
public ProductWeight.Builder getProductWeightBuilder()The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
.google.shopping.merchant.products.v1.ProductWeight product_weight = 122;
| Returns | |
|---|---|
| Type | Description |
ProductWeight.Builder |
|
getProductWeightOrBuilder()
public ProductWeightOrBuilder getProductWeightOrBuilder()The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
.google.shopping.merchant.products.v1.ProductWeight product_weight = 122;
| Returns | |
|---|---|
| Type | Description |
ProductWeightOrBuilder |
|
getProductWidth()
public ProductDimension getProductWidth()The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_width = 121;
| Returns | |
|---|---|
| Type | Description |
ProductDimension |
The productWidth. |
getProductWidthBuilder()
public ProductDimension.Builder getProductWidthBuilder()The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_width = 121;
| Returns | |
|---|---|
| Type | Description |
ProductDimension.Builder |
|
getProductWidthOrBuilder()
public ProductDimensionOrBuilder getProductWidthOrBuilder()The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_width = 121;
| Returns | |
|---|---|
| Type | Description |
ProductDimensionOrBuilder |
|
getPromotionIds(int index)
public String getPromotionIds(int index)The unique ID of a promotion.
repeated string promotion_ids = 70;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The promotionIds at the given index. |
getPromotionIdsBytes(int index)
public ByteString getPromotionIdsBytes(int index)The unique ID of a promotion.
repeated string promotion_ids = 70;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the promotionIds at the given index. |
getPromotionIdsCount()
public int getPromotionIdsCount()The unique ID of a promotion.
repeated string promotion_ids = 70;
| Returns | |
|---|---|
| Type | Description |
int |
The count of promotionIds. |
getPromotionIdsList()
public ProtocolStringList getPromotionIdsList()The unique ID of a promotion.
repeated string promotion_ids = 70;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the promotionIds. |
getSalePrice()
public Price getSalePrice()Advertised sale price of the item.
.google.shopping.type.Price sale_price = 36;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price |
The salePrice. |
getSalePriceBuilder()
public Price.Builder getSalePriceBuilder()Advertised sale price of the item.
.google.shopping.type.Price sale_price = 36;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.Price.Builder |
|
getSalePriceEffectiveDate()
public Interval getSalePriceEffectiveDate()Date range during which the item is on sale, see product data specification.
.google.type.Interval sale_price_effective_date = 37;
| Returns | |
|---|---|
| Type | Description |
com.google.type.Interval |
The salePriceEffectiveDate. |
getSalePriceEffectiveDateBuilder()
public Interval.Builder getSalePriceEffectiveDateBuilder()Date range during which the item is on sale, see product data specification.
.google.type.Interval sale_price_effective_date = 37;
| Returns | |
|---|---|
| Type | Description |
com.google.type.Interval.Builder |
|
getSalePriceEffectiveDateOrBuilder()
public IntervalOrBuilder getSalePriceEffectiveDateOrBuilder()Date range during which the item is on sale, see product data specification.
.google.type.Interval sale_price_effective_date = 37;
| Returns | |
|---|---|
| Type | Description |
com.google.type.IntervalOrBuilder |
|
getSalePriceOrBuilder()
public PriceOrBuilder getSalePriceOrBuilder()Advertised sale price of the item.
.google.shopping.type.Price sale_price = 36;
| Returns | |
|---|---|
| Type | Description |
com.google.shopping.type.PriceOrBuilder |
|
getSellOnGoogleQuantity()
public long getSellOnGoogleQuantity()The quantity of the product that is available for selling on Google. Supported only for online products.
optional int64 sell_on_google_quantity = 38;
| Returns | |
|---|---|
| Type | Description |
long |
The sellOnGoogleQuantity. |
getShipping(int index)
public Shipping getShipping(int index)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Shipping |
|
getShippingBuilder(int index)
public Shipping.Builder getShippingBuilder(int index)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Shipping.Builder |
|
getShippingBuilderList()
public List<Shipping.Builder> getShippingBuilderList()Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getShippingCount()
public int getShippingCount()Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Returns | |
|---|---|
| Type | Description |
int |
|
getShippingHeight()
public ShippingDimension getShippingHeight()Height of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_height = 43;
| Returns | |
|---|---|
| Type | Description |
ShippingDimension |
The shippingHeight. |
getShippingHeightBuilder()
public ShippingDimension.Builder getShippingHeightBuilder()Height of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_height = 43;
| Returns | |
|---|---|
| Type | Description |
ShippingDimension.Builder |
|
getShippingHeightOrBuilder()
public ShippingDimensionOrBuilder getShippingHeightOrBuilder()Height of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_height = 43;
| Returns | |
|---|---|
| Type | Description |
ShippingDimensionOrBuilder |
|
getShippingLabel()
public String getShippingLabel()The shipping label of the product, used to group product in account-level shipping rules.
optional string shipping_label = 46;
| Returns | |
|---|---|
| Type | Description |
String |
The shippingLabel. |
getShippingLabelBytes()
public ByteString getShippingLabelBytes()The shipping label of the product, used to group product in account-level shipping rules.
optional string shipping_label = 46;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for shippingLabel. |
getShippingLength()
public ShippingDimension getShippingLength()Length of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_length = 41;
| Returns | |
|---|---|
| Type | Description |
ShippingDimension |
The shippingLength. |
getShippingLengthBuilder()
public ShippingDimension.Builder getShippingLengthBuilder()Length of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_length = 41;
| Returns | |
|---|---|
| Type | Description |
ShippingDimension.Builder |
|
getShippingLengthOrBuilder()
public ShippingDimensionOrBuilder getShippingLengthOrBuilder()Length of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_length = 41;
| Returns | |
|---|---|
| Type | Description |
ShippingDimensionOrBuilder |
|
getShippingList()
public List<Shipping> getShippingList()Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Returns | |
|---|---|
| Type | Description |
List<Shipping> |
|
getShippingOrBuilder(int index)
public ShippingOrBuilder getShippingOrBuilder(int index)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ShippingOrBuilder |
|
getShippingOrBuilderList()
public List<? extends ShippingOrBuilder> getShippingOrBuilderList()Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.shopping.merchant.products.v1.ShippingOrBuilder> |
|
getShippingWeight()
public ShippingWeight getShippingWeight()Weight of the item for shipping.
.google.shopping.merchant.products.v1.ShippingWeight shipping_weight = 40;
| Returns | |
|---|---|
| Type | Description |
ShippingWeight |
The shippingWeight. |
getShippingWeightBuilder()
public ShippingWeight.Builder getShippingWeightBuilder()Weight of the item for shipping.
.google.shopping.merchant.products.v1.ShippingWeight shipping_weight = 40;
| Returns | |
|---|---|
| Type | Description |
ShippingWeight.Builder |
|
getShippingWeightOrBuilder()
public ShippingWeightOrBuilder getShippingWeightOrBuilder()Weight of the item for shipping.
.google.shopping.merchant.products.v1.ShippingWeight shipping_weight = 40;
| Returns | |
|---|---|
| Type | Description |
ShippingWeightOrBuilder |
|
getShippingWidth()
public ShippingDimension getShippingWidth()Width of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_width = 42;
| Returns | |
|---|---|
| Type | Description |
ShippingDimension |
The shippingWidth. |
getShippingWidthBuilder()
public ShippingDimension.Builder getShippingWidthBuilder()Width of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_width = 42;
| Returns | |
|---|---|
| Type | Description |
ShippingDimension.Builder |
|
getShippingWidthOrBuilder()
public ShippingDimensionOrBuilder getShippingWidthOrBuilder()Width of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_width = 42;
| Returns | |
|---|---|
| Type | Description |
ShippingDimensionOrBuilder |
|
getShoppingAdsExcludedCountries(int index)
public String getShoppingAdsExcludedCountries(int index)List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The shoppingAdsExcludedCountries at the given index. |
getShoppingAdsExcludedCountriesBytes(int index)
public ByteString getShoppingAdsExcludedCountriesBytes(int index)List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the shoppingAdsExcludedCountries at the given index. |
getShoppingAdsExcludedCountriesCount()
public int getShoppingAdsExcludedCountriesCount()List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Returns | |
|---|---|
| Type | Description |
int |
The count of shoppingAdsExcludedCountries. |
getShoppingAdsExcludedCountriesList()
public ProtocolStringList getShoppingAdsExcludedCountriesList()List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Returns | |
|---|---|
| Type | Description |
ProtocolStringList |
A list containing the shoppingAdsExcludedCountries. |
getSize()
public String getSize() Size of the item. Only one value is allowed. For variants with different
sizes, insert a separate product for each size with the same
itemGroupId value, see
Size.
optional string size = 48;
| Returns | |
|---|---|
| Type | Description |
String |
The size. |
getSizeBytes()
public ByteString getSizeBytes() Size of the item. Only one value is allowed. For variants with different
sizes, insert a separate product for each size with the same
itemGroupId value, see
Size.
optional string size = 48;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for size. |
getSizeSystem()
public SizeSystem getSizeSystem()System in which the size is specified. Recommended for apparel items. For more information, see Size system.
optional .google.shopping.merchant.products.v1.SizeSystem size_system = 49;
| Returns | |
|---|---|
| Type | Description |
SizeSystem |
The sizeSystem. |
getSizeSystemValue()
public int getSizeSystemValue()System in which the size is specified. Recommended for apparel items. For more information, see Size system.
optional .google.shopping.merchant.products.v1.SizeSystem size_system = 49;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for sizeSystem. |
getSizeTypes(int index)
public SizeType getSizeTypes(int index)The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
SizeType |
The sizeTypes at the given index. |
getSizeTypesCount()
public int getSizeTypesCount()The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Returns | |
|---|---|
| Type | Description |
int |
The count of sizeTypes. |
getSizeTypesList()
public List<SizeType> getSizeTypesList()The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Returns | |
|---|---|
| Type | Description |
List<SizeType> |
A list containing the sizeTypes. |
getSizeTypesValue(int index)
public int getSizeTypesValue(int index)The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire of sizeTypes at the given index. |
getSizeTypesValueList()
public List<Integer> getSizeTypesValueList()The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Returns | |
|---|---|
| Type | Description |
List<Integer> |
A list containing the enum numeric values on the wire for sizeTypes. |
getStructuredDescription()
public StructuredDescription getStructuredDescription()Structured description, for algorithmically (AI)-generated descriptions.
optional .google.shopping.merchant.products.v1.StructuredDescription structured_description = 133;
| Returns | |
|---|---|
| Type | Description |
StructuredDescription |
The structuredDescription. |
getStructuredDescriptionBuilder()
public StructuredDescription.Builder getStructuredDescriptionBuilder()Structured description, for algorithmically (AI)-generated descriptions.
optional .google.shopping.merchant.products.v1.StructuredDescription structured_description = 133;
| Returns | |
|---|---|
| Type | Description |
StructuredDescription.Builder |
|
getStructuredDescriptionOrBuilder()
public StructuredDescriptionOrBuilder getStructuredDescriptionOrBuilder()Structured description, for algorithmically (AI)-generated descriptions.
optional .google.shopping.merchant.products.v1.StructuredDescription structured_description = 133;
| Returns | |
|---|---|
| Type | Description |
StructuredDescriptionOrBuilder |
|
getStructuredTitle()
public StructuredTitle getStructuredTitle()Structured title, for algorithmically (AI)-generated titles.
optional .google.shopping.merchant.products.v1.StructuredTitle structured_title = 132;
| Returns | |
|---|---|
| Type | Description |
StructuredTitle |
The structuredTitle. |
getStructuredTitleBuilder()
public StructuredTitle.Builder getStructuredTitleBuilder()Structured title, for algorithmically (AI)-generated titles.
optional .google.shopping.merchant.products.v1.StructuredTitle structured_title = 132;
| Returns | |
|---|---|
| Type | Description |
StructuredTitle.Builder |
|
getStructuredTitleOrBuilder()
public StructuredTitleOrBuilder getStructuredTitleOrBuilder()Structured title, for algorithmically (AI)-generated titles.
optional .google.shopping.merchant.products.v1.StructuredTitle structured_title = 132;
| Returns | |
|---|---|
| Type | Description |
StructuredTitleOrBuilder |
|
getSubscriptionCost()
public SubscriptionCost getSubscriptionCost()Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
.google.shopping.merchant.products.v1.SubscriptionCost subscription_cost = 33;
| Returns | |
|---|---|
| Type | Description |
SubscriptionCost |
The subscriptionCost. |
getSubscriptionCostBuilder()
public SubscriptionCost.Builder getSubscriptionCostBuilder()Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
.google.shopping.merchant.products.v1.SubscriptionCost subscription_cost = 33;
| Returns | |
|---|---|
| Type | Description |
SubscriptionCost.Builder |
|
getSubscriptionCostOrBuilder()
public SubscriptionCostOrBuilder getSubscriptionCostOrBuilder()Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
.google.shopping.merchant.products.v1.SubscriptionCost subscription_cost = 33;
| Returns | |
|---|---|
| Type | Description |
SubscriptionCostOrBuilder |
|
getSustainabilityIncentives(int index)
public ProductSustainabilityIncentive getSustainabilityIncentives(int index)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductSustainabilityIncentive |
|
getSustainabilityIncentivesBuilder(int index)
public ProductSustainabilityIncentive.Builder getSustainabilityIncentivesBuilder(int index)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductSustainabilityIncentive.Builder |
|
getSustainabilityIncentivesBuilderList()
public List<ProductSustainabilityIncentive.Builder> getSustainabilityIncentivesBuilderList()The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Returns | |
|---|---|
| Type | Description |
List<Builder> |
|
getSustainabilityIncentivesCount()
public int getSustainabilityIncentivesCount()The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Returns | |
|---|---|
| Type | Description |
int |
|
getSustainabilityIncentivesList()
public List<ProductSustainabilityIncentive> getSustainabilityIncentivesList()The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Returns | |
|---|---|
| Type | Description |
List<ProductSustainabilityIncentive> |
|
getSustainabilityIncentivesOrBuilder(int index)
public ProductSustainabilityIncentiveOrBuilder getSustainabilityIncentivesOrBuilder(int index)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductSustainabilityIncentiveOrBuilder |
|
getSustainabilityIncentivesOrBuilderList()
public List<? extends ProductSustainabilityIncentiveOrBuilder> getSustainabilityIncentivesOrBuilderList()The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.shopping.merchant.products.v1.ProductSustainabilityIncentiveOrBuilder> |
|
getTitle()
public String getTitle()Title of the item.
optional string title = 6;
| Returns | |
|---|---|
| Type | Description |
String |
The title. |
getTitleBytes()
public ByteString getTitleBytes()Title of the item.
optional string title = 6;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for title. |
getTransitTimeLabel()
public String getTransitTimeLabel()The transit time label of the product, used to group product in account-level transit time tables.
optional string transit_time_label = 47;
| Returns | |
|---|---|
| Type | Description |
String |
The transitTimeLabel. |
getTransitTimeLabelBytes()
public ByteString getTransitTimeLabelBytes()The transit time label of the product, used to group product in account-level transit time tables.
optional string transit_time_label = 47;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for transitTimeLabel. |
getUnitPricingBaseMeasure()
public UnitPricingBaseMeasure getUnitPricingBaseMeasure()The preference of the denominator of the unit price.
.google.shopping.merchant.products.v1.UnitPricingBaseMeasure unit_pricing_base_measure = 57;
| Returns | |
|---|---|
| Type | Description |
UnitPricingBaseMeasure |
The unitPricingBaseMeasure. |
getUnitPricingBaseMeasureBuilder()
public UnitPricingBaseMeasure.Builder getUnitPricingBaseMeasureBuilder()The preference of the denominator of the unit price.
.google.shopping.merchant.products.v1.UnitPricingBaseMeasure unit_pricing_base_measure = 57;
| Returns | |
|---|---|
| Type | Description |
UnitPricingBaseMeasure.Builder |
|
getUnitPricingBaseMeasureOrBuilder()
public UnitPricingBaseMeasureOrBuilder getUnitPricingBaseMeasureOrBuilder()The preference of the denominator of the unit price.
.google.shopping.merchant.products.v1.UnitPricingBaseMeasure unit_pricing_base_measure = 57;
| Returns | |
|---|---|
| Type | Description |
UnitPricingBaseMeasureOrBuilder |
|
getUnitPricingMeasure()
public UnitPricingMeasure getUnitPricingMeasure()The measure and dimension of an item.
.google.shopping.merchant.products.v1.UnitPricingMeasure unit_pricing_measure = 56;
| Returns | |
|---|---|
| Type | Description |
UnitPricingMeasure |
The unitPricingMeasure. |
getUnitPricingMeasureBuilder()
public UnitPricingMeasure.Builder getUnitPricingMeasureBuilder()The measure and dimension of an item.
.google.shopping.merchant.products.v1.UnitPricingMeasure unit_pricing_measure = 56;
| Returns | |
|---|---|
| Type | Description |
UnitPricingMeasure.Builder |
|
getUnitPricingMeasureOrBuilder()
public UnitPricingMeasureOrBuilder getUnitPricingMeasureOrBuilder()The measure and dimension of an item.
.google.shopping.merchant.products.v1.UnitPricingMeasure unit_pricing_measure = 56;
| Returns | |
|---|---|
| Type | Description |
UnitPricingMeasureOrBuilder |
|
getVirtualModelLink()
public String getVirtualModelLink()URL of the 3D image of the item. See the Help Center article for more information.
optional string virtual_model_link = 130;
| Returns | |
|---|---|
| Type | Description |
String |
The virtualModelLink. |
getVirtualModelLinkBytes()
public ByteString getVirtualModelLinkBytes()URL of the 3D image of the item. See the Help Center article for more information.
optional string virtual_model_link = 130;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for virtualModelLink. |
hasAdsGrouping()
public boolean hasAdsGrouping()Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
optional string ads_grouping = 59;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adsGrouping field is set. |
hasAdsRedirect()
public boolean hasAdsRedirect()Allows advertisers to override the item URL when the product is shown within the context of Product ads.
optional string ads_redirect = 61;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adsRedirect field is set. |
hasAdult()
public boolean hasAdult()Set to true if the item is targeted towards adults.
optional bool adult = 17;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the adult field is set. |
hasAgeGroup()
public boolean hasAgeGroup()Target age group of the item.
optional .google.shopping.merchant.products.v1.AgeGroup age_group = 18;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the ageGroup field is set. |
hasAutoPricingMinPrice()
public boolean hasAutoPricingMinPrice()A safeguard in the automated discounts and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
.google.shopping.type.Price auto_pricing_min_price = 124;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the autoPricingMinPrice field is set. |
hasAvailability()
public boolean hasAvailability()Availability status of the item.
optional .google.shopping.merchant.products.v1.Availability availability = 19;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the availability field is set. |
hasAvailabilityDate()
public boolean hasAvailabilityDate()The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
.google.protobuf.Timestamp availability_date = 20;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the availabilityDate field is set. |
hasBrand()
public boolean hasBrand()Brand of the item. For example, "Google".
optional string brand = 21;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the brand field is set. |
hasCanonicalLink()
public boolean hasCanonicalLink()URL for the canonical version of your item's landing page.
optional string canonical_link = 10;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the canonicalLink field is set. |
hasColor()
public boolean hasColor()Color of the item. For example, "red".
optional string color = 22;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the color field is set. |
hasCondition()
public boolean hasCondition()Condition or state of the item.
optional .google.shopping.merchant.products.v1.Condition condition = 23;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the condition field is set. |
hasCostOfGoodsSold()
public boolean hasCostOfGoodsSold()Cost of goods sold. Used for gross profit reporting.
.google.shopping.type.Price cost_of_goods_sold = 62;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the costOfGoodsSold field is set. |
hasCustomLabel0()
public boolean hasCustomLabel0()Custom label 0 for custom grouping of items in a Shopping campaign.
optional string custom_label_0 = 71;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customLabel0 field is set. |
hasCustomLabel1()
public boolean hasCustomLabel1()Custom label 1 for custom grouping of items in a Shopping campaign.
optional string custom_label_1 = 72;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customLabel1 field is set. |
hasCustomLabel2()
public boolean hasCustomLabel2()Custom label 2 for custom grouping of items in a Shopping campaign.
optional string custom_label_2 = 73;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customLabel2 field is set. |
hasCustomLabel3()
public boolean hasCustomLabel3()Custom label 3 for custom grouping of items in a Shopping campaign.
optional string custom_label_3 = 74;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customLabel3 field is set. |
hasCustomLabel4()
public boolean hasCustomLabel4()Custom label 4 for custom grouping of items in a Shopping campaign.
optional string custom_label_4 = 75;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the customLabel4 field is set. |
hasDescription()
public boolean hasDescription()Description of the item.
optional string description = 7;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the description field is set. |
hasDisclosureDate()
public boolean hasDisclosureDate()The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.
.google.protobuf.Timestamp disclosure_date = 79;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the disclosureDate field is set. |
hasDisplayAdsId()
public boolean hasDisplayAdsId()An identifier for an item for dynamic remarketing campaigns.
optional string display_ads_id = 65;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the displayAdsId field is set. |
hasDisplayAdsLink()
public boolean hasDisplayAdsLink()URL directly to your item's landing page for dynamic remarketing campaigns.
optional string display_ads_link = 68;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the displayAdsLink field is set. |
hasDisplayAdsTitle()
public boolean hasDisplayAdsTitle()Title of an item for dynamic remarketing campaigns.
optional string display_ads_title = 67;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the displayAdsTitle field is set. |
hasDisplayAdsValue()
public boolean hasDisplayAdsValue()Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute.
optional double display_ads_value = 69;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the displayAdsValue field is set. |
hasEnergyEfficiencyClass()
public boolean hasEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass energy_efficiency_class = 53;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the energyEfficiencyClass field is set. |
hasExpirationDate()
public boolean hasExpirationDate() Date on which the item should expire, as specified upon insertion, in
ISO
8601 format. The actual
expiration date is exposed in productstatuses as
googleExpirationDate
and might be earlier if expirationDate is too far in the future.
.google.protobuf.Timestamp expiration_date = 16;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the expirationDate field is set. |
hasExternalSellerId()
public boolean hasExternalSellerId()Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
optional string external_seller_id = 1;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the externalSellerId field is set. |
hasGender()
public boolean hasGender()Target gender of the item.
optional .google.shopping.merchant.products.v1.Gender gender = 24;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the gender field is set. |
hasGoogleProductCategory()
public boolean hasGoogleProductCategory()Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
optional string google_product_category = 25;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the googleProductCategory field is set. |
hasIdentifierExists()
public boolean hasIdentifierExists()Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.
optional bool identifier_exists = 4;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the identifierExists field is set. |
hasImageLink()
public boolean hasImageLink()URL of an image of the item.
optional string image_link = 11;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the imageLink field is set. |
hasInstallment()
public boolean hasInstallment()Number and amount of installments to pay for an item.
.google.shopping.merchant.products.v1.ProductInstallment installment = 32;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the installment field is set. |
hasIsBundle()
public boolean hasIsBundle()Whether the item is a business-defined sub-API. A sub-API is a custom grouping of different products sold by a business for a single price.
optional bool is_bundle = 5;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the isBundle field is set. |
hasItemGroupId()
public boolean hasItemGroupId()Shared identifier for all variants of the same product.
optional string item_group_id = 27;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the itemGroupId field is set. |
hasLink()
public boolean hasLink()URL directly linking to your item's page on your online store.
optional string link = 8;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the link field is set. |
hasLinkTemplate()
public boolean hasLinkTemplate()Link template for business hosted local storefront.
optional string link_template = 82;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the linkTemplate field is set. |
hasLoyaltyPoints()
public boolean hasLoyaltyPoints()Loyalty points that users receive after purchasing the item. Japan only.
.google.shopping.merchant.products.v1.LoyaltyPoints loyalty_points = 34;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the loyaltyPoints field is set. |
hasMaterial()
public boolean hasMaterial()The material of which the item is made. For example, "Leather" or "Cotton".
optional string material = 28;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the material field is set. |
hasMaxEnergyEfficiencyClass()
public boolean hasMaxEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass max_energy_efficiency_class = 55;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxEnergyEfficiencyClass field is set. |
hasMaxHandlingTime()
public boolean hasMaxHandlingTime()Maximal product handling time (in business days).
optional int64 max_handling_time = 44;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maxHandlingTime field is set. |
hasMaximumRetailPrice()
public boolean hasMaximumRetailPrice()Maximum retail price (MRP) of the item. Applicable to India only.
.google.shopping.type.Price maximum_retail_price = 139;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the maximumRetailPrice field is set. |
hasMinEnergyEfficiencyClass()
public boolean hasMinEnergyEfficiencyClass()The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass min_energy_efficiency_class = 54;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the minEnergyEfficiencyClass field is set. |
hasMinHandlingTime()
public boolean hasMinHandlingTime()Minimal product handling time (in business days).
optional int64 min_handling_time = 45;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the minHandlingTime field is set. |
hasMobileLink()
public boolean hasMobileLink()URL for the mobile-optimized version of your item's landing page.
optional string mobile_link = 9;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mobileLink field is set. |
hasMobileLinkTemplate()
public boolean hasMobileLinkTemplate()Link template for business hosted local storefront optimized for mobile devices.
optional string mobile_link_template = 83;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mobileLinkTemplate field is set. |
hasMpn()
public boolean hasMpn()Manufacturer Part Number (MPN) of the item.
optional string mpn = 29;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the mpn field is set. |
hasMultipack()
public boolean hasMultipack()The number of identical products in a business-defined multipack.
optional int64 multipack = 58;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the multipack field is set. |
hasPattern()
public boolean hasPattern()The item's pattern. For example, polka dots.
optional string pattern = 30;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pattern field is set. |
hasPause()
public boolean hasPause()Publication of this item will be temporarily paused.
optional .google.shopping.merchant.products.v1.Pause pause = 13;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pause field is set. |
hasPickupMethod()
public boolean hasPickupMethod()The pickup option for the item.
optional .google.shopping.merchant.products.v1.PickupMethod pickup_method = 80;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pickupMethod field is set. |
hasPickupSla()
public boolean hasPickupSla()Item store pickup timeline. For more information, see Pickup SLA.
optional .google.shopping.merchant.products.v1.PickupSla pickup_sla = 81;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the pickupSla field is set. |
hasPrice()
public boolean hasPrice()Price of the item.
.google.shopping.type.Price price = 31;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the price field is set. |
hasProductHeight()
public boolean hasProductHeight()The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_height = 119;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the productHeight field is set. |
hasProductLength()
public boolean hasProductLength()The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_length = 120;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the productLength field is set. |
hasProductWeight()
public boolean hasProductWeight()The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
.google.shopping.merchant.products.v1.ProductWeight product_weight = 122;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the productWeight field is set. |
hasProductWidth()
public boolean hasProductWidth()The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_width = 121;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the productWidth field is set. |
hasSalePrice()
public boolean hasSalePrice()Advertised sale price of the item.
.google.shopping.type.Price sale_price = 36;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the salePrice field is set. |
hasSalePriceEffectiveDate()
public boolean hasSalePriceEffectiveDate()Date range during which the item is on sale, see product data specification.
.google.type.Interval sale_price_effective_date = 37;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the salePriceEffectiveDate field is set. |
hasSellOnGoogleQuantity()
public boolean hasSellOnGoogleQuantity()The quantity of the product that is available for selling on Google. Supported only for online products.
optional int64 sell_on_google_quantity = 38;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sellOnGoogleQuantity field is set. |
hasShippingHeight()
public boolean hasShippingHeight()Height of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_height = 43;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the shippingHeight field is set. |
hasShippingLabel()
public boolean hasShippingLabel()The shipping label of the product, used to group product in account-level shipping rules.
optional string shipping_label = 46;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the shippingLabel field is set. |
hasShippingLength()
public boolean hasShippingLength()Length of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_length = 41;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the shippingLength field is set. |
hasShippingWeight()
public boolean hasShippingWeight()Weight of the item for shipping.
.google.shopping.merchant.products.v1.ShippingWeight shipping_weight = 40;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the shippingWeight field is set. |
hasShippingWidth()
public boolean hasShippingWidth()Width of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_width = 42;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the shippingWidth field is set. |
hasSize()
public boolean hasSize() Size of the item. Only one value is allowed. For variants with different
sizes, insert a separate product for each size with the same
itemGroupId value, see
Size.
optional string size = 48;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the size field is set. |
hasSizeSystem()
public boolean hasSizeSystem()System in which the size is specified. Recommended for apparel items. For more information, see Size system.
optional .google.shopping.merchant.products.v1.SizeSystem size_system = 49;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the sizeSystem field is set. |
hasStructuredDescription()
public boolean hasStructuredDescription()Structured description, for algorithmically (AI)-generated descriptions.
optional .google.shopping.merchant.products.v1.StructuredDescription structured_description = 133;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the structuredDescription field is set. |
hasStructuredTitle()
public boolean hasStructuredTitle()Structured title, for algorithmically (AI)-generated titles.
optional .google.shopping.merchant.products.v1.StructuredTitle structured_title = 132;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the structuredTitle field is set. |
hasSubscriptionCost()
public boolean hasSubscriptionCost()Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
.google.shopping.merchant.products.v1.SubscriptionCost subscription_cost = 33;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the subscriptionCost field is set. |
hasTitle()
public boolean hasTitle()Title of the item.
optional string title = 6;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the title field is set. |
hasTransitTimeLabel()
public boolean hasTransitTimeLabel()The transit time label of the product, used to group product in account-level transit time tables.
optional string transit_time_label = 47;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the transitTimeLabel field is set. |
hasUnitPricingBaseMeasure()
public boolean hasUnitPricingBaseMeasure()The preference of the denominator of the unit price.
.google.shopping.merchant.products.v1.UnitPricingBaseMeasure unit_pricing_base_measure = 57;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the unitPricingBaseMeasure field is set. |
hasUnitPricingMeasure()
public boolean hasUnitPricingMeasure()The measure and dimension of an item.
.google.shopping.merchant.products.v1.UnitPricingMeasure unit_pricing_measure = 56;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the unitPricingMeasure field is set. |
hasVirtualModelLink()
public boolean hasVirtualModelLink()URL of the 3D image of the item. See the Help Center article for more information.
optional string virtual_model_link = 130;
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the virtualModelLink field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
mergeAutoPricingMinPrice(Price value)
public ProductAttributes.Builder mergeAutoPricingMinPrice(Price value)A safeguard in the automated discounts and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
.google.shopping.type.Price auto_pricing_min_price = 124;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeAvailabilityDate(Timestamp value)
public ProductAttributes.Builder mergeAvailabilityDate(Timestamp value)The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
.google.protobuf.Timestamp availability_date = 20;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeCostOfGoodsSold(Price value)
public ProductAttributes.Builder mergeCostOfGoodsSold(Price value)Cost of goods sold. Used for gross profit reporting.
.google.shopping.type.Price cost_of_goods_sold = 62;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeDisclosureDate(Timestamp value)
public ProductAttributes.Builder mergeDisclosureDate(Timestamp value)The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.
.google.protobuf.Timestamp disclosure_date = 79;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeExpirationDate(Timestamp value)
public ProductAttributes.Builder mergeExpirationDate(Timestamp value) Date on which the item should expire, as specified upon insertion, in
ISO
8601 format. The actual
expiration date is exposed in productstatuses as
googleExpirationDate
and might be earlier if expirationDate is too far in the future.
.google.protobuf.Timestamp expiration_date = 16;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public ProductAttributes.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
mergeFrom(Message other)
public ProductAttributes.Builder mergeFrom(Message other)| Parameter | |
|---|---|
| Name | Description |
other |
Message |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeFrom(ProductAttributes other)
public ProductAttributes.Builder mergeFrom(ProductAttributes other)| Parameter | |
|---|---|
| Name | Description |
other |
ProductAttributes |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeInstallment(ProductInstallment value)
public ProductAttributes.Builder mergeInstallment(ProductInstallment value)Number and amount of installments to pay for an item.
.google.shopping.merchant.products.v1.ProductInstallment installment = 32;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductInstallment |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeLoyaltyPoints(LoyaltyPoints value)
public ProductAttributes.Builder mergeLoyaltyPoints(LoyaltyPoints value)Loyalty points that users receive after purchasing the item. Japan only.
.google.shopping.merchant.products.v1.LoyaltyPoints loyalty_points = 34;
| Parameter | |
|---|---|
| Name | Description |
value |
LoyaltyPoints |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeMaximumRetailPrice(Price value)
public ProductAttributes.Builder mergeMaximumRetailPrice(Price value)Maximum retail price (MRP) of the item. Applicable to India only.
.google.shopping.type.Price maximum_retail_price = 139;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergePrice(Price value)
public ProductAttributes.Builder mergePrice(Price value)Price of the item.
.google.shopping.type.Price price = 31;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeProductHeight(ProductDimension value)
public ProductAttributes.Builder mergeProductHeight(ProductDimension value)The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_height = 119;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeProductLength(ProductDimension value)
public ProductAttributes.Builder mergeProductLength(ProductDimension value)The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_length = 120;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeProductWeight(ProductWeight value)
public ProductAttributes.Builder mergeProductWeight(ProductWeight value)The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
.google.shopping.merchant.products.v1.ProductWeight product_weight = 122;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductWeight |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeProductWidth(ProductDimension value)
public ProductAttributes.Builder mergeProductWidth(ProductDimension value)The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_width = 121;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeSalePrice(Price value)
public ProductAttributes.Builder mergeSalePrice(Price value)Advertised sale price of the item.
.google.shopping.type.Price sale_price = 36;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeSalePriceEffectiveDate(Interval value)
public ProductAttributes.Builder mergeSalePriceEffectiveDate(Interval value)Date range during which the item is on sale, see product data specification.
.google.type.Interval sale_price_effective_date = 37;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Interval |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeShippingHeight(ShippingDimension value)
public ProductAttributes.Builder mergeShippingHeight(ShippingDimension value)Height of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_height = 43;
| Parameter | |
|---|---|
| Name | Description |
value |
ShippingDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeShippingLength(ShippingDimension value)
public ProductAttributes.Builder mergeShippingLength(ShippingDimension value)Length of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_length = 41;
| Parameter | |
|---|---|
| Name | Description |
value |
ShippingDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeShippingWeight(ShippingWeight value)
public ProductAttributes.Builder mergeShippingWeight(ShippingWeight value)Weight of the item for shipping.
.google.shopping.merchant.products.v1.ShippingWeight shipping_weight = 40;
| Parameter | |
|---|---|
| Name | Description |
value |
ShippingWeight |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeShippingWidth(ShippingDimension value)
public ProductAttributes.Builder mergeShippingWidth(ShippingDimension value)Width of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_width = 42;
| Parameter | |
|---|---|
| Name | Description |
value |
ShippingDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeStructuredDescription(StructuredDescription value)
public ProductAttributes.Builder mergeStructuredDescription(StructuredDescription value)Structured description, for algorithmically (AI)-generated descriptions.
optional .google.shopping.merchant.products.v1.StructuredDescription structured_description = 133;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredDescription |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeStructuredTitle(StructuredTitle value)
public ProductAttributes.Builder mergeStructuredTitle(StructuredTitle value)Structured title, for algorithmically (AI)-generated titles.
optional .google.shopping.merchant.products.v1.StructuredTitle structured_title = 132;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredTitle |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeSubscriptionCost(SubscriptionCost value)
public ProductAttributes.Builder mergeSubscriptionCost(SubscriptionCost value)Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
.google.shopping.merchant.products.v1.SubscriptionCost subscription_cost = 33;
| Parameter | |
|---|---|
| Name | Description |
value |
SubscriptionCost |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeUnitPricingBaseMeasure(UnitPricingBaseMeasure value)
public ProductAttributes.Builder mergeUnitPricingBaseMeasure(UnitPricingBaseMeasure value)The preference of the denominator of the unit price.
.google.shopping.merchant.products.v1.UnitPricingBaseMeasure unit_pricing_base_measure = 57;
| Parameter | |
|---|---|
| Name | Description |
value |
UnitPricingBaseMeasure |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeUnitPricingMeasure(UnitPricingMeasure value)
public ProductAttributes.Builder mergeUnitPricingMeasure(UnitPricingMeasure value)The measure and dimension of an item.
.google.shopping.merchant.products.v1.UnitPricingMeasure unit_pricing_measure = 56;
| Parameter | |
|---|---|
| Name | Description |
value |
UnitPricingMeasure |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
mergeUnknownFields(UnknownFieldSet unknownFields)
public final ProductAttributes.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
removeCertifications(int index)
public ProductAttributes.Builder removeCertifications(int index)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
removeCloudExportAdditionalProperties(int index)
public ProductAttributes.Builder removeCloudExportAdditionalProperties(int index)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
removeFreeShippingThreshold(int index)
public ProductAttributes.Builder removeFreeShippingThreshold(int index)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
removeLoyaltyPrograms(int index)
public ProductAttributes.Builder removeLoyaltyPrograms(int index)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
removeProductDetails(int index)
public ProductAttributes.Builder removeProductDetails(int index)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
removeShipping(int index)
public ProductAttributes.Builder removeShipping(int index)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
removeSustainabilityIncentives(int index)
public ProductAttributes.Builder removeSustainabilityIncentives(int index)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setAdditionalImageLinks(int index, String value)
public ProductAttributes.Builder setAdditionalImageLinks(int index, String value)Additional URLs of images of the item.
repeated string additional_image_links = 12;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe additionalImageLinks to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAdsGrouping(String value)
public ProductAttributes.Builder setAdsGrouping(String value)Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
optional string ads_grouping = 59;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adsGrouping to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAdsGroupingBytes(ByteString value)
public ProductAttributes.Builder setAdsGroupingBytes(ByteString value)Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
optional string ads_grouping = 59;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adsGrouping to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAdsLabels(int index, String value)
public ProductAttributes.Builder setAdsLabels(int index, String value)Similar to ads_grouping, but only works on CPC.
repeated string ads_labels = 60;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe adsLabels to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAdsRedirect(String value)
public ProductAttributes.Builder setAdsRedirect(String value)Allows advertisers to override the item URL when the product is shown within the context of Product ads.
optional string ads_redirect = 61;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe adsRedirect to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAdsRedirectBytes(ByteString value)
public ProductAttributes.Builder setAdsRedirectBytes(ByteString value)Allows advertisers to override the item URL when the product is shown within the context of Product ads.
optional string ads_redirect = 61;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for adsRedirect to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAdult(boolean value)
public ProductAttributes.Builder setAdult(boolean value)Set to true if the item is targeted towards adults.
optional bool adult = 17;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe adult to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAgeGroup(AgeGroup value)
public ProductAttributes.Builder setAgeGroup(AgeGroup value)Target age group of the item.
optional .google.shopping.merchant.products.v1.AgeGroup age_group = 18;
| Parameter | |
|---|---|
| Name | Description |
value |
AgeGroupThe ageGroup to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAgeGroupValue(int value)
public ProductAttributes.Builder setAgeGroupValue(int value)Target age group of the item.
optional .google.shopping.merchant.products.v1.AgeGroup age_group = 18;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for ageGroup to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAutoPricingMinPrice(Price value)
public ProductAttributes.Builder setAutoPricingMinPrice(Price value)A safeguard in the automated discounts and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
.google.shopping.type.Price auto_pricing_min_price = 124;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setAutoPricingMinPrice(Price.Builder builderForValue)
public ProductAttributes.Builder setAutoPricingMinPrice(Price.Builder builderForValue)A safeguard in the automated discounts and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on business offers do not fall below this value, thereby preserving the offer's value and profitability.
.google.shopping.type.Price auto_pricing_min_price = 124;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.shopping.type.Price.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setAvailability(Availability value)
public ProductAttributes.Builder setAvailability(Availability value)Availability status of the item.
optional .google.shopping.merchant.products.v1.Availability availability = 19;
| Parameter | |
|---|---|
| Name | Description |
value |
AvailabilityThe availability to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setAvailabilityDate(Timestamp value)
public ProductAttributes.Builder setAvailabilityDate(Timestamp value)The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
.google.protobuf.Timestamp availability_date = 20;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setAvailabilityDate(Timestamp.Builder builderForValue)
public ProductAttributes.Builder setAvailabilityDate(Timestamp.Builder builderForValue)The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
.google.protobuf.Timestamp availability_date = 20;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setAvailabilityValue(int value)
public ProductAttributes.Builder setAvailabilityValue(int value)Availability status of the item.
optional .google.shopping.merchant.products.v1.Availability availability = 19;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for availability to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setBrand(String value)
public ProductAttributes.Builder setBrand(String value)Brand of the item. For example, "Google".
optional string brand = 21;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe brand to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setBrandBytes(ByteString value)
public ProductAttributes.Builder setBrandBytes(ByteString value)Brand of the item. For example, "Google".
optional string brand = 21;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for brand to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCanonicalLink(String value)
public ProductAttributes.Builder setCanonicalLink(String value)URL for the canonical version of your item's landing page.
optional string canonical_link = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe canonicalLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCanonicalLinkBytes(ByteString value)
public ProductAttributes.Builder setCanonicalLinkBytes(ByteString value)URL for the canonical version of your item's landing page.
optional string canonical_link = 10;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for canonicalLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCertifications(int index, ProductCertification value)
public ProductAttributes.Builder setCertifications(int index, ProductCertification value)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ProductCertification |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setCertifications(int index, ProductCertification.Builder builderForValue)
public ProductAttributes.Builder setCertifications(int index, ProductCertification.Builder builderForValue)Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
repeated .google.shopping.merchant.products.v1.ProductCertification certifications = 123;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ProductCertification.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setCloudExportAdditionalProperties(int index, CloudExportAdditionalProperties value)
public ProductAttributes.Builder setCloudExportAdditionalProperties(int index, CloudExportAdditionalProperties value)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
CloudExportAdditionalProperties |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setCloudExportAdditionalProperties(int index, CloudExportAdditionalProperties.Builder builderForValue)
public ProductAttributes.Builder setCloudExportAdditionalProperties(int index, CloudExportAdditionalProperties.Builder builderForValue)Extra fields to export to the Cloud Retail program.
repeated .google.shopping.merchant.products.v1.CloudExportAdditionalProperties cloud_export_additional_properties = 84;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
CloudExportAdditionalProperties.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setColor(String value)
public ProductAttributes.Builder setColor(String value)Color of the item. For example, "red".
optional string color = 22;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe color to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setColorBytes(ByteString value)
public ProductAttributes.Builder setColorBytes(ByteString value)Color of the item. For example, "red".
optional string color = 22;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for color to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCondition(Condition value)
public ProductAttributes.Builder setCondition(Condition value)Condition or state of the item.
optional .google.shopping.merchant.products.v1.Condition condition = 23;
| Parameter | |
|---|---|
| Name | Description |
value |
ConditionThe condition to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setConditionValue(int value)
public ProductAttributes.Builder setConditionValue(int value)Condition or state of the item.
optional .google.shopping.merchant.products.v1.Condition condition = 23;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for condition to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCostOfGoodsSold(Price value)
public ProductAttributes.Builder setCostOfGoodsSold(Price value)Cost of goods sold. Used for gross profit reporting.
.google.shopping.type.Price cost_of_goods_sold = 62;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setCostOfGoodsSold(Price.Builder builderForValue)
public ProductAttributes.Builder setCostOfGoodsSold(Price.Builder builderForValue)Cost of goods sold. Used for gross profit reporting.
.google.shopping.type.Price cost_of_goods_sold = 62;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.shopping.type.Price.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setCustomLabel0(String value)
public ProductAttributes.Builder setCustomLabel0(String value)Custom label 0 for custom grouping of items in a Shopping campaign.
optional string custom_label_0 = 71;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customLabel0 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel0Bytes(ByteString value)
public ProductAttributes.Builder setCustomLabel0Bytes(ByteString value)Custom label 0 for custom grouping of items in a Shopping campaign.
optional string custom_label_0 = 71;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customLabel0 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel1(String value)
public ProductAttributes.Builder setCustomLabel1(String value)Custom label 1 for custom grouping of items in a Shopping campaign.
optional string custom_label_1 = 72;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customLabel1 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel1Bytes(ByteString value)
public ProductAttributes.Builder setCustomLabel1Bytes(ByteString value)Custom label 1 for custom grouping of items in a Shopping campaign.
optional string custom_label_1 = 72;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customLabel1 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel2(String value)
public ProductAttributes.Builder setCustomLabel2(String value)Custom label 2 for custom grouping of items in a Shopping campaign.
optional string custom_label_2 = 73;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customLabel2 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel2Bytes(ByteString value)
public ProductAttributes.Builder setCustomLabel2Bytes(ByteString value)Custom label 2 for custom grouping of items in a Shopping campaign.
optional string custom_label_2 = 73;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customLabel2 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel3(String value)
public ProductAttributes.Builder setCustomLabel3(String value)Custom label 3 for custom grouping of items in a Shopping campaign.
optional string custom_label_3 = 74;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customLabel3 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel3Bytes(ByteString value)
public ProductAttributes.Builder setCustomLabel3Bytes(ByteString value)Custom label 3 for custom grouping of items in a Shopping campaign.
optional string custom_label_3 = 74;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customLabel3 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel4(String value)
public ProductAttributes.Builder setCustomLabel4(String value)Custom label 4 for custom grouping of items in a Shopping campaign.
optional string custom_label_4 = 75;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe customLabel4 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setCustomLabel4Bytes(ByteString value)
public ProductAttributes.Builder setCustomLabel4Bytes(ByteString value)Custom label 4 for custom grouping of items in a Shopping campaign.
optional string custom_label_4 = 75;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for customLabel4 to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDescription(String value)
public ProductAttributes.Builder setDescription(String value)Description of the item.
optional string description = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe description to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDescriptionBytes(ByteString value)
public ProductAttributes.Builder setDescriptionBytes(ByteString value)Description of the item.
optional string description = 7;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for description to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDisclosureDate(Timestamp value)
public ProductAttributes.Builder setDisclosureDate(Timestamp value)The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.
.google.protobuf.Timestamp disclosure_date = 79;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setDisclosureDate(Timestamp.Builder builderForValue)
public ProductAttributes.Builder setDisclosureDate(Timestamp.Builder builderForValue)The date time when an offer becomes visible in search results across Google’s YouTube surfaces, in ISO 8601 format. See Disclosure date for more information.
.google.protobuf.Timestamp disclosure_date = 79;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setDisplayAdsId(String value)
public ProductAttributes.Builder setDisplayAdsId(String value)An identifier for an item for dynamic remarketing campaigns.
optional string display_ads_id = 65;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayAdsId to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDisplayAdsIdBytes(ByteString value)
public ProductAttributes.Builder setDisplayAdsIdBytes(ByteString value)An identifier for an item for dynamic remarketing campaigns.
optional string display_ads_id = 65;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayAdsId to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDisplayAdsLink(String value)
public ProductAttributes.Builder setDisplayAdsLink(String value)URL directly to your item's landing page for dynamic remarketing campaigns.
optional string display_ads_link = 68;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayAdsLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDisplayAdsLinkBytes(ByteString value)
public ProductAttributes.Builder setDisplayAdsLinkBytes(ByteString value)URL directly to your item's landing page for dynamic remarketing campaigns.
optional string display_ads_link = 68;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayAdsLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDisplayAdsSimilarIds(int index, String value)
public ProductAttributes.Builder setDisplayAdsSimilarIds(int index, String value)Advertiser-specified recommendations. For more information, see Display ads attribute specification.
repeated string display_ads_similar_ids = 66;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe displayAdsSimilarIds to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDisplayAdsTitle(String value)
public ProductAttributes.Builder setDisplayAdsTitle(String value)Title of an item for dynamic remarketing campaigns.
optional string display_ads_title = 67;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe displayAdsTitle to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDisplayAdsTitleBytes(ByteString value)
public ProductAttributes.Builder setDisplayAdsTitleBytes(ByteString value)Title of an item for dynamic remarketing campaigns.
optional string display_ads_title = 67;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for displayAdsTitle to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setDisplayAdsValue(double value)
public ProductAttributes.Builder setDisplayAdsValue(double value)Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute.
optional double display_ads_value = 69;
| Parameter | |
|---|---|
| Name | Description |
value |
doubleThe displayAdsValue to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setEnergyEfficiencyClass(EnergyEfficiencyClass value)
public ProductAttributes.Builder setEnergyEfficiencyClass(EnergyEfficiencyClass value)The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass energy_efficiency_class = 53;
| Parameter | |
|---|---|
| Name | Description |
value |
EnergyEfficiencyClassThe energyEfficiencyClass to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setEnergyEfficiencyClassValue(int value)
public ProductAttributes.Builder setEnergyEfficiencyClassValue(int value)The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass energy_efficiency_class = 53;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for energyEfficiencyClass to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setExcludedDestinations(int index, Destination.DestinationEnum value)
public ProductAttributes.Builder setExcludedDestinations(int index, Destination.DestinationEnum value)The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
com.google.shopping.type.Destination.DestinationEnumThe excludedDestinations to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setExcludedDestinationsValue(int index, int value)
public ProductAttributes.Builder setExcludedDestinationsValue(int index, int value)The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
For more information, see Excluded destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum excluded_destinations = 77;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for excludedDestinations to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setExpirationDate(Timestamp value)
public ProductAttributes.Builder setExpirationDate(Timestamp value) Date on which the item should expire, as specified upon insertion, in
ISO
8601 format. The actual
expiration date is exposed in productstatuses as
googleExpirationDate
and might be earlier if expirationDate is too far in the future.
.google.protobuf.Timestamp expiration_date = 16;
| Parameter | |
|---|---|
| Name | Description |
value |
Timestamp |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setExpirationDate(Timestamp.Builder builderForValue)
public ProductAttributes.Builder setExpirationDate(Timestamp.Builder builderForValue) Date on which the item should expire, as specified upon insertion, in
ISO
8601 format. The actual
expiration date is exposed in productstatuses as
googleExpirationDate
and might be earlier if expirationDate is too far in the future.
.google.protobuf.Timestamp expiration_date = 16;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setExternalSellerId(String value)
public ProductAttributes.Builder setExternalSellerId(String value)Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
optional string external_seller_id = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe externalSellerId to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setExternalSellerIdBytes(ByteString value)
public ProductAttributes.Builder setExternalSellerIdBytes(ByteString value)Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
optional string external_seller_id = 1;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for externalSellerId to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public ProductAttributes.Builder setField(Descriptors.FieldDescriptor field, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setFreeShippingThreshold(int index, FreeShippingThreshold value)
public ProductAttributes.Builder setFreeShippingThreshold(int index, FreeShippingThreshold value)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
FreeShippingThreshold |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setFreeShippingThreshold(int index, FreeShippingThreshold.Builder builderForValue)
public ProductAttributes.Builder setFreeShippingThreshold(int index, FreeShippingThreshold.Builder builderForValue)Conditions to be met for a product to have free shipping.
repeated .google.shopping.merchant.products.v1.FreeShippingThreshold free_shipping_threshold = 135;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
FreeShippingThreshold.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setGender(Gender value)
public ProductAttributes.Builder setGender(Gender value)Target gender of the item.
optional .google.shopping.merchant.products.v1.Gender gender = 24;
| Parameter | |
|---|---|
| Name | Description |
value |
GenderThe gender to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setGenderValue(int value)
public ProductAttributes.Builder setGenderValue(int value)Target gender of the item.
optional .google.shopping.merchant.products.v1.Gender gender = 24;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for gender to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setGoogleProductCategory(String value)
public ProductAttributes.Builder setGoogleProductCategory(String value)Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
optional string google_product_category = 25;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe googleProductCategory to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setGoogleProductCategoryBytes(ByteString value)
public ProductAttributes.Builder setGoogleProductCategoryBytes(ByteString value)Google's category of the item (see Google product taxonomy). When querying products, this field will contain the user provided value. There is currently no way to get back the auto assigned google product categories through the API.
optional string google_product_category = 25;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for googleProductCategory to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setGtins(int index, String value)
public ProductAttributes.Builder setGtins(int index, String value)Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
repeated string gtins = 140;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe gtins to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setIdentifierExists(boolean value)
public ProductAttributes.Builder setIdentifierExists(boolean value)Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand. Defaults to true, if not provided.
optional bool identifier_exists = 4;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe identifierExists to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setImageLink(String value)
public ProductAttributes.Builder setImageLink(String value)URL of an image of the item.
optional string image_link = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe imageLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setImageLinkBytes(ByteString value)
public ProductAttributes.Builder setImageLinkBytes(ByteString value)URL of an image of the item.
optional string image_link = 11;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for imageLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setIncludedDestinations(int index, Destination.DestinationEnum value)
public ProductAttributes.Builder setIncludedDestinations(int index, Destination.DestinationEnum value) The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
com.google.shopping.type.Destination.DestinationEnumThe includedDestinations to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setIncludedDestinationsValue(int index, int value)
public ProductAttributes.Builder setIncludedDestinationsValue(int index, int value) The list of destinations to include for this target (corresponds to
checked check boxes in Merchant Center). Default destinations are always
included unless provided in excludedDestinations.
For more information, see Included destination.
Note: We recommend setting destinations on datasources level for most use cases. Use this field within products to only setup exceptions.
repeated .google.shopping.type.Destination.DestinationEnum included_destinations = 76;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for includedDestinations to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setInstallment(ProductInstallment value)
public ProductAttributes.Builder setInstallment(ProductInstallment value)Number and amount of installments to pay for an item.
.google.shopping.merchant.products.v1.ProductInstallment installment = 32;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductInstallment |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setInstallment(ProductInstallment.Builder builderForValue)
public ProductAttributes.Builder setInstallment(ProductInstallment.Builder builderForValue)Number and amount of installments to pay for an item.
.google.shopping.merchant.products.v1.ProductInstallment installment = 32;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductInstallment.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setIsBundle(boolean value)
public ProductAttributes.Builder setIsBundle(boolean value)Whether the item is a business-defined sub-API. A sub-API is a custom grouping of different products sold by a business for a single price.
optional bool is_bundle = 5;
| Parameter | |
|---|---|
| Name | Description |
value |
booleanThe isBundle to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setItemGroupId(String value)
public ProductAttributes.Builder setItemGroupId(String value)Shared identifier for all variants of the same product.
optional string item_group_id = 27;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe itemGroupId to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setItemGroupIdBytes(ByteString value)
public ProductAttributes.Builder setItemGroupIdBytes(ByteString value)Shared identifier for all variants of the same product.
optional string item_group_id = 27;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for itemGroupId to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setLifestyleImageLinks(int index, String value)
public ProductAttributes.Builder setLifestyleImageLinks(int index, String value)Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context. See the Help Center article for more information.
repeated string lifestyle_image_links = 14;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe lifestyleImageLinks to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setLink(String value)
public ProductAttributes.Builder setLink(String value)URL directly linking to your item's page on your online store.
optional string link = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe link to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setLinkBytes(ByteString value)
public ProductAttributes.Builder setLinkBytes(ByteString value)URL directly linking to your item's page on your online store.
optional string link = 8;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for link to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setLinkTemplate(String value)
public ProductAttributes.Builder setLinkTemplate(String value)Link template for business hosted local storefront.
optional string link_template = 82;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe linkTemplate to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setLinkTemplateBytes(ByteString value)
public ProductAttributes.Builder setLinkTemplateBytes(ByteString value)Link template for business hosted local storefront.
optional string link_template = 82;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for linkTemplate to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setLoyaltyPoints(LoyaltyPoints value)
public ProductAttributes.Builder setLoyaltyPoints(LoyaltyPoints value)Loyalty points that users receive after purchasing the item. Japan only.
.google.shopping.merchant.products.v1.LoyaltyPoints loyalty_points = 34;
| Parameter | |
|---|---|
| Name | Description |
value |
LoyaltyPoints |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setLoyaltyPoints(LoyaltyPoints.Builder builderForValue)
public ProductAttributes.Builder setLoyaltyPoints(LoyaltyPoints.Builder builderForValue)Loyalty points that users receive after purchasing the item. Japan only.
.google.shopping.merchant.products.v1.LoyaltyPoints loyalty_points = 34;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
LoyaltyPoints.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setLoyaltyPrograms(int index, LoyaltyProgram value)
public ProductAttributes.Builder setLoyaltyPrograms(int index, LoyaltyProgram value)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
LoyaltyProgram |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setLoyaltyPrograms(int index, LoyaltyProgram.Builder builderForValue)
public ProductAttributes.Builder setLoyaltyPrograms(int index, LoyaltyProgram.Builder builderForValue)A list of loyalty program information that is used to surface loyalty benefits (for example, better pricing, points, etc) to the user of this item.
repeated .google.shopping.merchant.products.v1.LoyaltyProgram loyalty_programs = 136;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
LoyaltyProgram.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setMaterial(String value)
public ProductAttributes.Builder setMaterial(String value)The material of which the item is made. For example, "Leather" or "Cotton".
optional string material = 28;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe material to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMaterialBytes(ByteString value)
public ProductAttributes.Builder setMaterialBytes(ByteString value)The material of which the item is made. For example, "Leather" or "Cotton".
optional string material = 28;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for material to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMaxEnergyEfficiencyClass(EnergyEfficiencyClass value)
public ProductAttributes.Builder setMaxEnergyEfficiencyClass(EnergyEfficiencyClass value)The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass max_energy_efficiency_class = 55;
| Parameter | |
|---|---|
| Name | Description |
value |
EnergyEfficiencyClassThe maxEnergyEfficiencyClass to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMaxEnergyEfficiencyClassValue(int value)
public ProductAttributes.Builder setMaxEnergyEfficiencyClassValue(int value)The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass max_energy_efficiency_class = 55;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for maxEnergyEfficiencyClass to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMaxHandlingTime(long value)
public ProductAttributes.Builder setMaxHandlingTime(long value)Maximal product handling time (in business days).
optional int64 max_handling_time = 44;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe maxHandlingTime to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMaximumRetailPrice(Price value)
public ProductAttributes.Builder setMaximumRetailPrice(Price value)Maximum retail price (MRP) of the item. Applicable to India only.
.google.shopping.type.Price maximum_retail_price = 139;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setMaximumRetailPrice(Price.Builder builderForValue)
public ProductAttributes.Builder setMaximumRetailPrice(Price.Builder builderForValue)Maximum retail price (MRP) of the item. Applicable to India only.
.google.shopping.type.Price maximum_retail_price = 139;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.shopping.type.Price.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setMinEnergyEfficiencyClass(EnergyEfficiencyClass value)
public ProductAttributes.Builder setMinEnergyEfficiencyClass(EnergyEfficiencyClass value)The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass min_energy_efficiency_class = 54;
| Parameter | |
|---|---|
| Name | Description |
value |
EnergyEfficiencyClassThe minEnergyEfficiencyClass to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMinEnergyEfficiencyClassValue(int value)
public ProductAttributes.Builder setMinEnergyEfficiencyClassValue(int value)The energy efficiency class as defined in EU directive 2010/30/EU.
optional .google.shopping.merchant.products.v1.EnergyEfficiencyClass min_energy_efficiency_class = 54;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for minEnergyEfficiencyClass to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMinHandlingTime(long value)
public ProductAttributes.Builder setMinHandlingTime(long value)Minimal product handling time (in business days).
optional int64 min_handling_time = 45;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe minHandlingTime to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMobileLink(String value)
public ProductAttributes.Builder setMobileLink(String value)URL for the mobile-optimized version of your item's landing page.
optional string mobile_link = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe mobileLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMobileLinkBytes(ByteString value)
public ProductAttributes.Builder setMobileLinkBytes(ByteString value)URL for the mobile-optimized version of your item's landing page.
optional string mobile_link = 9;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for mobileLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMobileLinkTemplate(String value)
public ProductAttributes.Builder setMobileLinkTemplate(String value)Link template for business hosted local storefront optimized for mobile devices.
optional string mobile_link_template = 83;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe mobileLinkTemplate to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMobileLinkTemplateBytes(ByteString value)
public ProductAttributes.Builder setMobileLinkTemplateBytes(ByteString value)Link template for business hosted local storefront optimized for mobile devices.
optional string mobile_link_template = 83;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for mobileLinkTemplate to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMpn(String value)
public ProductAttributes.Builder setMpn(String value)Manufacturer Part Number (MPN) of the item.
optional string mpn = 29;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe mpn to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMpnBytes(ByteString value)
public ProductAttributes.Builder setMpnBytes(ByteString value)Manufacturer Part Number (MPN) of the item.
optional string mpn = 29;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for mpn to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setMultipack(long value)
public ProductAttributes.Builder setMultipack(long value)The number of identical products in a business-defined multipack.
optional int64 multipack = 58;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe multipack to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPattern(String value)
public ProductAttributes.Builder setPattern(String value)The item's pattern. For example, polka dots.
optional string pattern = 30;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe pattern to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPatternBytes(ByteString value)
public ProductAttributes.Builder setPatternBytes(ByteString value)The item's pattern. For example, polka dots.
optional string pattern = 30;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for pattern to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPause(Pause value)
public ProductAttributes.Builder setPause(Pause value)Publication of this item will be temporarily paused.
optional .google.shopping.merchant.products.v1.Pause pause = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
PauseThe pause to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPauseValue(int value)
public ProductAttributes.Builder setPauseValue(int value)Publication of this item will be temporarily paused.
optional .google.shopping.merchant.products.v1.Pause pause = 13;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for pause to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPickupMethod(PickupMethod value)
public ProductAttributes.Builder setPickupMethod(PickupMethod value)The pickup option for the item.
optional .google.shopping.merchant.products.v1.PickupMethod pickup_method = 80;
| Parameter | |
|---|---|
| Name | Description |
value |
PickupMethodThe pickupMethod to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPickupMethodValue(int value)
public ProductAttributes.Builder setPickupMethodValue(int value)The pickup option for the item.
optional .google.shopping.merchant.products.v1.PickupMethod pickup_method = 80;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for pickupMethod to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPickupSla(PickupSla value)
public ProductAttributes.Builder setPickupSla(PickupSla value)Item store pickup timeline. For more information, see Pickup SLA.
optional .google.shopping.merchant.products.v1.PickupSla pickup_sla = 81;
| Parameter | |
|---|---|
| Name | Description |
value |
PickupSlaThe pickupSla to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPickupSlaValue(int value)
public ProductAttributes.Builder setPickupSlaValue(int value)Item store pickup timeline. For more information, see Pickup SLA.
optional .google.shopping.merchant.products.v1.PickupSla pickup_sla = 81;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for pickupSla to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setPrice(Price value)
public ProductAttributes.Builder setPrice(Price value)Price of the item.
.google.shopping.type.Price price = 31;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setPrice(Price.Builder builderForValue)
public ProductAttributes.Builder setPrice(Price.Builder builderForValue)Price of the item.
.google.shopping.type.Price price = 31;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.shopping.type.Price.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductDetails(int index, ProductDetail value)
public ProductAttributes.Builder setProductDetails(int index, ProductDetail value)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ProductDetail |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductDetails(int index, ProductDetail.Builder builderForValue)
public ProductAttributes.Builder setProductDetails(int index, ProductDetail.Builder builderForValue)Technical specification or additional product details.
repeated .google.shopping.merchant.products.v1.ProductDetail product_details = 63;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ProductDetail.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductHeight(ProductDimension value)
public ProductAttributes.Builder setProductHeight(ProductDimension value)The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_height = 119;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductHeight(ProductDimension.Builder builderForValue)
public ProductAttributes.Builder setProductHeight(ProductDimension.Builder builderForValue)The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_height = 119;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductHighlights(int index, String value)
public ProductAttributes.Builder setProductHighlights(int index, String value)Bullet points describing the most relevant product highlights.
repeated string product_highlights = 64;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe productHighlights to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setProductLength(ProductDimension value)
public ProductAttributes.Builder setProductLength(ProductDimension value)The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_length = 120;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductLength(ProductDimension.Builder builderForValue)
public ProductAttributes.Builder setProductLength(ProductDimension.Builder builderForValue)The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_length = 120;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductTypes(int index, String value)
public ProductAttributes.Builder setProductTypes(int index, String value)Categories of the item (formatted as in product data specification).
repeated string product_types = 35;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe productTypes to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setProductWeight(ProductWeight value)
public ProductAttributes.Builder setProductWeight(ProductWeight value)The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
.google.shopping.merchant.products.v1.ProductWeight product_weight = 122;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductWeight |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductWeight(ProductWeight.Builder builderForValue)
public ProductAttributes.Builder setProductWeight(ProductWeight.Builder builderForValue)The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
.google.shopping.merchant.products.v1.ProductWeight product_weight = 122;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductWeight.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductWidth(ProductDimension value)
public ProductAttributes.Builder setProductWidth(ProductDimension value)The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_width = 121;
| Parameter | |
|---|---|
| Name | Description |
value |
ProductDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setProductWidth(ProductDimension.Builder builderForValue)
public ProductAttributes.Builder setProductWidth(ProductDimension.Builder builderForValue)The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
.google.shopping.merchant.products.v1.ProductDimension product_width = 121;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ProductDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setPromotionIds(int index, String value)
public ProductAttributes.Builder setPromotionIds(int index, String value)The unique ID of a promotion.
repeated string promotion_ids = 70;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe promotionIds to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public ProductAttributes.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Parameters | |
|---|---|
| Name | Description |
field |
FieldDescriptor |
index |
int |
value |
Object |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSalePrice(Price value)
public ProductAttributes.Builder setSalePrice(Price value)Advertised sale price of the item.
.google.shopping.type.Price sale_price = 36;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.shopping.type.Price |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSalePrice(Price.Builder builderForValue)
public ProductAttributes.Builder setSalePrice(Price.Builder builderForValue)Advertised sale price of the item.
.google.shopping.type.Price sale_price = 36;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.shopping.type.Price.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSalePriceEffectiveDate(Interval value)
public ProductAttributes.Builder setSalePriceEffectiveDate(Interval value)Date range during which the item is on sale, see product data specification.
.google.type.Interval sale_price_effective_date = 37;
| Parameter | |
|---|---|
| Name | Description |
value |
com.google.type.Interval |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSalePriceEffectiveDate(Interval.Builder builderForValue)
public ProductAttributes.Builder setSalePriceEffectiveDate(Interval.Builder builderForValue)Date range during which the item is on sale, see product data specification.
.google.type.Interval sale_price_effective_date = 37;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
com.google.type.Interval.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSellOnGoogleQuantity(long value)
public ProductAttributes.Builder setSellOnGoogleQuantity(long value)The quantity of the product that is available for selling on Google. Supported only for online products.
optional int64 sell_on_google_quantity = 38;
| Parameter | |
|---|---|
| Name | Description |
value |
longThe sellOnGoogleQuantity to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setShipping(int index, Shipping value)
public ProductAttributes.Builder setShipping(int index, Shipping value)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
Shipping |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShipping(int index, Shipping.Builder builderForValue)
public ProductAttributes.Builder setShipping(int index, Shipping.Builder builderForValue)Shipping rules.
repeated .google.shopping.merchant.products.v1.Shipping shipping = 39;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
Shipping.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShippingHeight(ShippingDimension value)
public ProductAttributes.Builder setShippingHeight(ShippingDimension value)Height of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_height = 43;
| Parameter | |
|---|---|
| Name | Description |
value |
ShippingDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShippingHeight(ShippingDimension.Builder builderForValue)
public ProductAttributes.Builder setShippingHeight(ShippingDimension.Builder builderForValue)Height of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_height = 43;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ShippingDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShippingLabel(String value)
public ProductAttributes.Builder setShippingLabel(String value)The shipping label of the product, used to group product in account-level shipping rules.
optional string shipping_label = 46;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe shippingLabel to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setShippingLabelBytes(ByteString value)
public ProductAttributes.Builder setShippingLabelBytes(ByteString value)The shipping label of the product, used to group product in account-level shipping rules.
optional string shipping_label = 46;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for shippingLabel to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setShippingLength(ShippingDimension value)
public ProductAttributes.Builder setShippingLength(ShippingDimension value)Length of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_length = 41;
| Parameter | |
|---|---|
| Name | Description |
value |
ShippingDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShippingLength(ShippingDimension.Builder builderForValue)
public ProductAttributes.Builder setShippingLength(ShippingDimension.Builder builderForValue)Length of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_length = 41;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ShippingDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShippingWeight(ShippingWeight value)
public ProductAttributes.Builder setShippingWeight(ShippingWeight value)Weight of the item for shipping.
.google.shopping.merchant.products.v1.ShippingWeight shipping_weight = 40;
| Parameter | |
|---|---|
| Name | Description |
value |
ShippingWeight |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShippingWeight(ShippingWeight.Builder builderForValue)
public ProductAttributes.Builder setShippingWeight(ShippingWeight.Builder builderForValue)Weight of the item for shipping.
.google.shopping.merchant.products.v1.ShippingWeight shipping_weight = 40;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ShippingWeight.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShippingWidth(ShippingDimension value)
public ProductAttributes.Builder setShippingWidth(ShippingDimension value)Width of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_width = 42;
| Parameter | |
|---|---|
| Name | Description |
value |
ShippingDimension |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShippingWidth(ShippingDimension.Builder builderForValue)
public ProductAttributes.Builder setShippingWidth(ShippingDimension.Builder builderForValue)Width of the item for shipping.
.google.shopping.merchant.products.v1.ShippingDimension shipping_width = 42;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
ShippingDimension.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setShoppingAdsExcludedCountries(int index, String value)
public ProductAttributes.Builder setShoppingAdsExcludedCountries(int index, String value)List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination. Countries from this list are removed from countries configured in data source settings.
repeated string shopping_ads_excluded_countries = 78;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
StringThe shoppingAdsExcludedCountries to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setSize(String value)
public ProductAttributes.Builder setSize(String value) Size of the item. Only one value is allowed. For variants with different
sizes, insert a separate product for each size with the same
itemGroupId value, see
Size.
optional string size = 48;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe size to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setSizeBytes(ByteString value)
public ProductAttributes.Builder setSizeBytes(ByteString value) Size of the item. Only one value is allowed. For variants with different
sizes, insert a separate product for each size with the same
itemGroupId value, see
Size.
optional string size = 48;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for size to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setSizeSystem(SizeSystem value)
public ProductAttributes.Builder setSizeSystem(SizeSystem value)System in which the size is specified. Recommended for apparel items. For more information, see Size system.
optional .google.shopping.merchant.products.v1.SizeSystem size_system = 49;
| Parameter | |
|---|---|
| Name | Description |
value |
SizeSystemThe sizeSystem to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setSizeSystemValue(int value)
public ProductAttributes.Builder setSizeSystemValue(int value)System in which the size is specified. Recommended for apparel items. For more information, see Size system.
optional .google.shopping.merchant.products.v1.SizeSystem size_system = 49;
| Parameter | |
|---|---|
| Name | Description |
value |
intThe enum numeric value on the wire for sizeSystem to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setSizeTypes(int index, SizeType value)
public ProductAttributes.Builder setSizeTypes(int index, SizeType value)The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
SizeTypeThe sizeTypes to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setSizeTypesValue(int index, int value)
public ProductAttributes.Builder setSizeTypesValue(int index, int value)The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type.
repeated .google.shopping.merchant.products.v1.SizeType size_types = 50;
| Parameters | |
|---|---|
| Name | Description |
index |
intThe index to set the value at. |
value |
intThe enum numeric value on the wire for sizeTypes to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setStructuredDescription(StructuredDescription value)
public ProductAttributes.Builder setStructuredDescription(StructuredDescription value)Structured description, for algorithmically (AI)-generated descriptions.
optional .google.shopping.merchant.products.v1.StructuredDescription structured_description = 133;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredDescription |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setStructuredDescription(StructuredDescription.Builder builderForValue)
public ProductAttributes.Builder setStructuredDescription(StructuredDescription.Builder builderForValue)Structured description, for algorithmically (AI)-generated descriptions.
optional .google.shopping.merchant.products.v1.StructuredDescription structured_description = 133;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StructuredDescription.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setStructuredTitle(StructuredTitle value)
public ProductAttributes.Builder setStructuredTitle(StructuredTitle value)Structured title, for algorithmically (AI)-generated titles.
optional .google.shopping.merchant.products.v1.StructuredTitle structured_title = 132;
| Parameter | |
|---|---|
| Name | Description |
value |
StructuredTitle |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setStructuredTitle(StructuredTitle.Builder builderForValue)
public ProductAttributes.Builder setStructuredTitle(StructuredTitle.Builder builderForValue)Structured title, for algorithmically (AI)-generated titles.
optional .google.shopping.merchant.products.v1.StructuredTitle structured_title = 132;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
StructuredTitle.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSubscriptionCost(SubscriptionCost value)
public ProductAttributes.Builder setSubscriptionCost(SubscriptionCost value)Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
.google.shopping.merchant.products.v1.SubscriptionCost subscription_cost = 33;
| Parameter | |
|---|---|
| Name | Description |
value |
SubscriptionCost |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSubscriptionCost(SubscriptionCost.Builder builderForValue)
public ProductAttributes.Builder setSubscriptionCost(SubscriptionCost.Builder builderForValue)Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
.google.shopping.merchant.products.v1.SubscriptionCost subscription_cost = 33;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
SubscriptionCost.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSustainabilityIncentives(int index, ProductSustainabilityIncentive value)
public ProductAttributes.Builder setSustainabilityIncentives(int index, ProductSustainabilityIncentive value)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
value |
ProductSustainabilityIncentive |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setSustainabilityIncentives(int index, ProductSustainabilityIncentive.Builder builderForValue)
public ProductAttributes.Builder setSustainabilityIncentives(int index, ProductSustainabilityIncentive.Builder builderForValue)The list of sustainability incentive programs.
repeated .google.shopping.merchant.products.v1.ProductSustainabilityIncentive sustainability_incentives = 138;
| Parameters | |
|---|---|
| Name | Description |
index |
int |
builderForValue |
ProductSustainabilityIncentive.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setTitle(String value)
public ProductAttributes.Builder setTitle(String value)Title of the item.
optional string title = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe title to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setTitleBytes(ByteString value)
public ProductAttributes.Builder setTitleBytes(ByteString value)Title of the item.
optional string title = 6;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for title to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setTransitTimeLabel(String value)
public ProductAttributes.Builder setTransitTimeLabel(String value)The transit time label of the product, used to group product in account-level transit time tables.
optional string transit_time_label = 47;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe transitTimeLabel to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setTransitTimeLabelBytes(ByteString value)
public ProductAttributes.Builder setTransitTimeLabelBytes(ByteString value)The transit time label of the product, used to group product in account-level transit time tables.
optional string transit_time_label = 47;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for transitTimeLabel to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setUnitPricingBaseMeasure(UnitPricingBaseMeasure value)
public ProductAttributes.Builder setUnitPricingBaseMeasure(UnitPricingBaseMeasure value)The preference of the denominator of the unit price.
.google.shopping.merchant.products.v1.UnitPricingBaseMeasure unit_pricing_base_measure = 57;
| Parameter | |
|---|---|
| Name | Description |
value |
UnitPricingBaseMeasure |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setUnitPricingBaseMeasure(UnitPricingBaseMeasure.Builder builderForValue)
public ProductAttributes.Builder setUnitPricingBaseMeasure(UnitPricingBaseMeasure.Builder builderForValue)The preference of the denominator of the unit price.
.google.shopping.merchant.products.v1.UnitPricingBaseMeasure unit_pricing_base_measure = 57;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UnitPricingBaseMeasure.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setUnitPricingMeasure(UnitPricingMeasure value)
public ProductAttributes.Builder setUnitPricingMeasure(UnitPricingMeasure value)The measure and dimension of an item.
.google.shopping.merchant.products.v1.UnitPricingMeasure unit_pricing_measure = 56;
| Parameter | |
|---|---|
| Name | Description |
value |
UnitPricingMeasure |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setUnitPricingMeasure(UnitPricingMeasure.Builder builderForValue)
public ProductAttributes.Builder setUnitPricingMeasure(UnitPricingMeasure.Builder builderForValue)The measure and dimension of an item.
.google.shopping.merchant.products.v1.UnitPricingMeasure unit_pricing_measure = 56;
| Parameter | |
|---|---|
| Name | Description |
builderForValue |
UnitPricingMeasure.Builder |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setUnknownFields(UnknownFieldSet unknownFields)
public final ProductAttributes.Builder setUnknownFields(UnknownFieldSet unknownFields)| Parameter | |
|---|---|
| Name | Description |
unknownFields |
UnknownFieldSet |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
|
setVirtualModelLink(String value)
public ProductAttributes.Builder setVirtualModelLink(String value)URL of the 3D image of the item. See the Help Center article for more information.
optional string virtual_model_link = 130;
| Parameter | |
|---|---|
| Name | Description |
value |
StringThe virtualModelLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |
setVirtualModelLinkBytes(ByteString value)
public ProductAttributes.Builder setVirtualModelLinkBytes(ByteString value)URL of the 3D image of the item. See the Help Center article for more information.
optional string virtual_model_link = 130;
| Parameter | |
|---|---|
| Name | Description |
value |
ByteStringThe bytes for virtualModelLink to set. |
| Returns | |
|---|---|
| Type | Description |
ProductAttributes.Builder |
This builder for chaining. |