Reference documentation and code samples for the Google Shopping Merchant Products V1beta Client class Attributes.
Attributes.
Generated from protobuf message google.shopping.merchant.products.v1beta.Attributes
Namespace
Google \ Shopping \ Merchant \ Products \ V1betaMethods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ identifier_exists
bool
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.
↳ is_bundle
bool
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.
↳ title
string
Title of the item.
↳ description
string
Description of the item.
↳ link
string
URL directly linking to your item's page on your online store.
↳ mobile_link
string
URL for the mobile-optimized version of your item's landing page.
↳ canonical_link
string
URL for the canonical version of your item's landing page.
↳ image_link
string
URL of an image of the item.
↳ additional_image_links
array
Additional URLs of images of the item.
↳ expiration_date
Google\Protobuf\Timestamp
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.
↳ disclosure_date
Google\Protobuf\Timestamp
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.
↳ adult
bool
Set to true if the item is targeted towards adults.
↳ age_group
↳ availability
↳ availability_date
Google\Protobuf\Timestamp
The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
↳ brand
↳ color
↳ condition
↳ gender
↳ google_product_category
string
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.
↳ gtin
array
Global Trade Item Numbers ( GTIN
) of the item. You can provide up to 10 GTINs. Deprecated: Use gtins
instead.
↳ gtins
↳ item_group_id
string
Shared identifier for all variants of the same product.
↳ material
↳ mpn
↳ pattern
↳ price
↳ maximum_retail_price
↳ installment
↳ subscription_cost
SubscriptionCost
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
↳ loyalty_points
↳ loyalty_programs
array< LoyaltyProgram
>
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.
↳ product_types
↳ sale_price
↳ sale_price_effective_date
↳ sell_on_google_quantity
int|string
The quantity of the product that is available for selling on Google. Supported only for online products.
↳ product_height
ProductDimension
The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
↳ product_length
ProductDimension
The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
↳ product_width
ProductDimension
The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
↳ product_weight
ProductWeight
The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
↳ shipping
↳ free_shipping_threshold
↳ shipping_weight
↳ shipping_length
↳ shipping_width
↳ shipping_height
↳ max_handling_time
int|string
Maximal product handling time (in business days).
↳ min_handling_time
int|string
Minimal product handling time (in business days).
↳ shipping_label
string
The shipping label of the product, used to group product in account-level shipping rules.
↳ transit_time_label
string
The transit time label of the product, used to group product in account-level transit time tables.
↳ size
string
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
.
↳ size_system
string
System in which the size is specified. Recommended for apparel items. For example, "US", "UK", "DE". For more information, see Size system .
↳ size_types
array
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 . For example, "petite", "plus size".
↳ taxes
↳ tax_category
↳ energy_efficiency_class
string
The energy efficiency class as defined in EU directive 2010/30/EU.
↳ min_energy_efficiency_class
string
The energy efficiency class as defined in EU directive 2010/30/EU.
↳ max_energy_efficiency_class
string
The energy efficiency class as defined in EU directive 2010/30/EU.
↳ unit_pricing_measure
↳ unit_pricing_base_measure
↳ multipack
int|string
The number of identical products in a business-defined multipack.
↳ ads_grouping
string
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute .
↳ ads_labels
array
Similar to ads_grouping, but only works on CPC.
↳ ads_redirect
string
Allows advertisers to override the item URL when the product is shown within the context of Product ads.
↳ cost_of_goods_sold
↳ product_details
↳ product_highlights
↳ display_ads_id
string
An identifier for an item for dynamic remarketing campaigns.
↳ display_ads_similar_ids
array
Advertiser-specified recommendations. For more information, see Display ads attribute specification .
↳ display_ads_title
string
Title of an item for dynamic remarketing campaigns.
↳ display_ads_link
string
URL directly to your item's landing page for dynamic remarketing campaigns.
↳ display_ads_value
float
Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute .
↳ promotion_ids
array
The unique ID of a promotion.
↳ pickup_method
↳ pickup_sla
↳ link_template
↳ mobile_link_template
↳ custom_label_0
↳ custom_label_1
↳ custom_label_2
↳ custom_label_3
↳ custom_label_4
↳ included_destinations
array
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.
↳ excluded_destinations
array
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.
↳ shopping_ads_excluded_countries
array
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.
↳ external_seller_id
string
Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
↳ pause
↳ lifestyle_image_links
array
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.
↳ cloud_export_additional_properties
↳ virtual_model_link
↳ certifications
array< Certification
>
Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
↳ structured_title
↳ structured_description
ProductStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
↳ auto_pricing_min_price
Google\Shopping\Type\Price
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.
↳ sustainability_incentives
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.
bool
hasIdentifierExists
clearIdentifierExists
setIdentifierExists
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.
var
bool
$this
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.
bool
hasIsBundle
clearIsBundle
setIsBundle
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.
var
bool
$this
getTitle
Title of the item.
string
hasTitle
clearTitle
setTitle
Title of the item.
var
string
$this
getDescription
Description of the item.
string
hasDescription
clearDescription
setDescription
Description of the item.
var
string
$this
getLink
URL directly linking to your item's page on your online store.
string
hasLink
clearLink
setLink
URL directly linking to your item's page on your online store.
var
string
$this
getMobileLink
URL for the mobile-optimized version of your item's landing page.
string
hasMobileLink
clearMobileLink
setMobileLink
URL for the mobile-optimized version of your item's landing page.
var
string
$this
getCanonicalLink
URL for the canonical version of your item's landing page.
string
hasCanonicalLink
clearCanonicalLink
setCanonicalLink
URL for the canonical version of your item's landing page.
var
string
$this
getImageLink
URL of an image of the item.
string
hasImageLink
clearImageLink
setImageLink
URL of an image of the item.
var
string
$this
getAdditionalImageLinks
Additional URLs of images of the item.
setAdditionalImageLinks
Additional URLs of images of the item.
var
string[]
$this
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.
hasExpirationDate
clearExpirationDate
setExpirationDate
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.
$this
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.
hasDisclosureDate
clearDisclosureDate
setDisclosureDate
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.
$this
getAdult
Set to true if the item is targeted towards adults.
bool
hasAdult
clearAdult
setAdult
Set to true if the item is targeted towards adults.
var
bool
$this
getAgeGroup
Target age group of the item.
string
hasAgeGroup
clearAgeGroup
setAgeGroup
Target age group of the item.
var
string
$this
getAvailability
Availability status of the item. For example, "in_stock" or "out_of_stock".
string
hasAvailability
clearAvailability
setAvailability
Availability status of the item. For example, "in_stock" or "out_of_stock".
var
string
$this
getAvailabilityDate
The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
hasAvailabilityDate
clearAvailabilityDate
setAvailabilityDate
The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
$this
getBrand
Brand of the item.
For example, "Google".
string
hasBrand
clearBrand
setBrand
Brand of the item.
For example, "Google".
var
string
$this
getColor
Color of the item.
For example, "red".
string
hasColor
clearColor
setColor
Color of the item.
For example, "red".
var
string
$this
getCondition
Condition or state of the item. For example, "new" or "used".
string
hasCondition
clearCondition
setCondition
Condition or state of the item. For example, "new" or "used".
var
string
$this
getGender
Target gender of the item. For example, "male" or "female".
string
hasGender
clearGender
setGender
Target gender of the item. For example, "male" or "female".
var
string
$this
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.
string
hasGoogleProductCategory
clearGoogleProductCategory
setGoogleProductCategory
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.
var
string
$this
getGtin
Global Trade Item Numbers ( GTIN ) of the item.
You can provide up to 10 GTINs.
Deprecated: Use gtins
instead.
setGtin
Global Trade Item Numbers ( GTIN ) of the item.
You can provide up to 10 GTINs.
Deprecated: Use gtins
instead.
var
string[]
$this
getGtins
Global Trade Item Numbers ( GTIN ) of the item.
You can provide up to 10 GTINs.
setGtins
Global Trade Item Numbers ( GTIN ) of the item.
You can provide up to 10 GTINs.
var
string[]
$this
getItemGroupId
Shared identifier for all variants of the same product.
string
hasItemGroupId
clearItemGroupId
setItemGroupId
Shared identifier for all variants of the same product.
var
string
$this
getMaterial
The material of which the item is made. For example, "Leather" or "Cotton".
string
hasMaterial
clearMaterial
setMaterial
The material of which the item is made. For example, "Leather" or "Cotton".
var
string
$this
getMpn
Manufacturer Part Number ( MPN ) of the item.
string
hasMpn
clearMpn
setMpn
Manufacturer Part Number ( MPN ) of the item.
var
string
$this
getPattern
The item's pattern .
For example, polka dots.
string
hasPattern
clearPattern
setPattern
The item's pattern .
For example, polka dots.
var
string
$this
getPrice
Price of the item.
hasPrice
clearPrice
setPrice
Price of the item.
$this
getMaximumRetailPrice
Maximum retail price (MRP) of the item. Applicable to India only.
hasMaximumRetailPrice
clearMaximumRetailPrice
setMaximumRetailPrice
Maximum retail price (MRP) of the item. Applicable to India only.
$this
getInstallment
Number and amount of installments to pay for an item.
hasInstallment
clearInstallment
setInstallment
Number and amount of installments to pay for an item.
$this
getSubscriptionCost
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
hasSubscriptionCost
clearSubscriptionCost
setSubscriptionCost
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
$this
getLoyaltyPoints
Loyalty points that users receive after purchasing the item. Japan only.
hasLoyaltyPoints
clearLoyaltyPoints
setLoyaltyPoints
Loyalty points that users receive after purchasing the item. Japan only.
$this
getLoyaltyPrograms
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.
setLoyaltyPrograms
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.
$this
getProductTypes
Categories of the item (formatted as in product data specification ).
setProductTypes
Categories of the item (formatted as in product data specification ).
var
string[]
$this
getSalePrice
Advertised sale price of the item.
hasSalePrice
clearSalePrice
setSalePrice
Advertised sale price of the item.
$this
getSalePriceEffectiveDate
Date range during which the item is on sale, see product data specification .
hasSalePriceEffectiveDate
clearSalePriceEffectiveDate
setSalePriceEffectiveDate
Date range during which the item is on sale, see product data specification .
$this
getSellOnGoogleQuantity
The quantity of the product that is available for selling on Google.
Supported only for online products.
int|string
hasSellOnGoogleQuantity
clearSellOnGoogleQuantity
setSellOnGoogleQuantity
The quantity of the product that is available for selling on Google.
Supported only for online products.
var
int|string
$this
getProductHeight
The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
hasProductHeight
clearProductHeight
setProductHeight
The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
$this
getProductLength
The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
hasProductLength
clearProductLength
setProductLength
The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
$this
getProductWidth
The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
hasProductWidth
clearProductWidth
setProductWidth
The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
$this
getProductWeight
The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
hasProductWeight
clearProductWeight
setProductWeight
The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
$this
getShipping
Shipping rules.
setShipping
Shipping rules.
$this
getFreeShippingThreshold
Conditions to be met for a product to have free shipping.
setFreeShippingThreshold
Conditions to be met for a product to have free shipping.
$this
getShippingWeight
Weight of the item for shipping.
hasShippingWeight
clearShippingWeight
setShippingWeight
Weight of the item for shipping.
$this
getShippingLength
Length of the item for shipping.
hasShippingLength
clearShippingLength
setShippingLength
Length of the item for shipping.
$this
getShippingWidth
Width of the item for shipping.
hasShippingWidth
clearShippingWidth
setShippingWidth
Width of the item for shipping.
$this
getShippingHeight
Height of the item for shipping.
hasShippingHeight
clearShippingHeight
setShippingHeight
Height of the item for shipping.
$this
getMaxHandlingTime
Maximal product handling time (in business days).
int|string
hasMaxHandlingTime
clearMaxHandlingTime
setMaxHandlingTime
Maximal product handling time (in business days).
var
int|string
$this
getMinHandlingTime
Minimal product handling time (in business days).
int|string
hasMinHandlingTime
clearMinHandlingTime
setMinHandlingTime
Minimal product handling time (in business days).
var
int|string
$this
getShippingLabel
The shipping label of the product, used to group product in account-level shipping rules.
string
hasShippingLabel
clearShippingLabel
setShippingLabel
The shipping label of the product, used to group product in account-level shipping rules.
var
string
$this
getTransitTimeLabel
The transit time label of the product, used to group product in account-level transit time tables.
string
hasTransitTimeLabel
clearTransitTimeLabel
setTransitTimeLabel
The transit time label of the product, used to group product in account-level transit time tables.
var
string
$this
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
.
string
hasSize
clearSize
setSize
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
.
var
string
$this
getSizeSystem
System in which the size is specified. Recommended for apparel items.
For example, "US", "UK", "DE". For more information, see Size system .
string
hasSizeSystem
clearSizeSystem
setSizeSystem
System in which the size is specified. Recommended for apparel items.
For example, "US", "UK", "DE". For more information, see Size system .
var
string
$this
getSizeTypes
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 .
For example, "petite", "plus size".
setSizeTypes
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 .
For example, "petite", "plus size".
var
string[]
$this
getTaxes
Tax information.
setTaxes
Tax information.
$this
getTaxCategory
The tax category of the product.
string
hasTaxCategory
clearTaxCategory
setTaxCategory
The tax category of the product.
var
string
$this
getEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
string
hasEnergyEfficiencyClass
clearEnergyEfficiencyClass
setEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
var
string
$this
getMinEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
string
hasMinEnergyEfficiencyClass
clearMinEnergyEfficiencyClass
setMinEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
var
string
$this
getMaxEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
string
hasMaxEnergyEfficiencyClass
clearMaxEnergyEfficiencyClass
setMaxEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
var
string
$this
getUnitPricingMeasure
The measure and dimension of an item.
hasUnitPricingMeasure
clearUnitPricingMeasure
setUnitPricingMeasure
The measure and dimension of an item.
$this
getUnitPricingBaseMeasure
The preference of the denominator of the unit price.
hasUnitPricingBaseMeasure
clearUnitPricingBaseMeasure
setUnitPricingBaseMeasure
The preference of the denominator of the unit price.
$this
getMultipack
The number of identical products in a business-defined multipack.
int|string
hasMultipack
clearMultipack
setMultipack
The number of identical products in a business-defined multipack.
var
int|string
$this
getAdsGrouping
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute .
string
hasAdsGrouping
clearAdsGrouping
setAdsGrouping
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute .
var
string
$this
getAdsLabels
Similar to ads_grouping, but only works on CPC.
setAdsLabels
Similar to ads_grouping, but only works on CPC.
var
string[]
$this
getAdsRedirect
Allows advertisers to override the item URL when the product is shown within the context of Product ads.
string
hasAdsRedirect
clearAdsRedirect
setAdsRedirect
Allows advertisers to override the item URL when the product is shown within the context of Product ads.
var
string
$this
getCostOfGoodsSold
Cost of goods sold. Used for gross profit reporting.
hasCostOfGoodsSold
clearCostOfGoodsSold
setCostOfGoodsSold
Cost of goods sold. Used for gross profit reporting.
$this
getProductDetails
Technical specification or additional product details.
setProductDetails
Technical specification or additional product details.
$this
getProductHighlights
Bullet points describing the most relevant product highlights .
setProductHighlights
Bullet points describing the most relevant product highlights .
var
string[]
$this
getDisplayAdsId
An identifier for an item for dynamic remarketing campaigns.
string
hasDisplayAdsId
clearDisplayAdsId
setDisplayAdsId
An identifier for an item for dynamic remarketing campaigns.
var
string
$this
getDisplayAdsSimilarIds
Advertiser-specified recommendations. For more information, see Display ads attribute specification .
setDisplayAdsSimilarIds
Advertiser-specified recommendations. For more information, see Display ads attribute specification .
var
string[]
$this
getDisplayAdsTitle
Title of an item for dynamic remarketing campaigns.
string
hasDisplayAdsTitle
clearDisplayAdsTitle
setDisplayAdsTitle
Title of an item for dynamic remarketing campaigns.
var
string
$this
getDisplayAdsLink
URL directly to your item's landing page for dynamic remarketing campaigns.
string
hasDisplayAdsLink
clearDisplayAdsLink
setDisplayAdsLink
URL directly to your item's landing page for dynamic remarketing campaigns.
var
string
$this
getDisplayAdsValue
Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute .
float
hasDisplayAdsValue
clearDisplayAdsValue
setDisplayAdsValue
Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute .
var
float
$this
getPromotionIds
The unique ID of a promotion.
setPromotionIds
The unique ID of a promotion.
var
string[]
$this
getPickupMethod
The pickup option for the item.
string
hasPickupMethod
clearPickupMethod
setPickupMethod
The pickup option for the item.
var
string
$this
getPickupSla
Item store pickup timeline. For more information, see Pickup SLA .
string
hasPickupSla
clearPickupSla
setPickupSla
Item store pickup timeline. For more information, see Pickup SLA .
var
string
$this
getLinkTemplate
Link template for business hosted local storefront.
string
hasLinkTemplate
clearLinkTemplate
setLinkTemplate
Link template for business hosted local storefront.
var
string
$this
getMobileLinkTemplate
Link template for business hosted local storefront optimized for mobile devices.
string
hasMobileLinkTemplate
clearMobileLinkTemplate
setMobileLinkTemplate
Link template for business hosted local storefront optimized for mobile devices.
var
string
$this
getCustomLabel0
Custom label 0 for custom grouping of items in a Shopping campaign.
string
hasCustomLabel0
clearCustomLabel0
setCustomLabel0
Custom label 0 for custom grouping of items in a Shopping campaign.
var
string
$this
getCustomLabel1
Custom label 1 for custom grouping of items in a Shopping campaign.
string
hasCustomLabel1
clearCustomLabel1
setCustomLabel1
Custom label 1 for custom grouping of items in a Shopping campaign.
var
string
$this
getCustomLabel2
Custom label 2 for custom grouping of items in a Shopping campaign.
string
hasCustomLabel2
clearCustomLabel2
setCustomLabel2
Custom label 2 for custom grouping of items in a Shopping campaign.
var
string
$this
getCustomLabel3
Custom label 3 for custom grouping of items in a Shopping campaign.
string
hasCustomLabel3
clearCustomLabel3
setCustomLabel3
Custom label 3 for custom grouping of items in a Shopping campaign.
var
string
$this
getCustomLabel4
Custom label 4 for custom grouping of items in a Shopping campaign.
string
hasCustomLabel4
clearCustomLabel4
setCustomLabel4
Custom label 4 for custom grouping of items in a Shopping campaign.
var
string
$this
getIncludedDestinations
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.
setIncludedDestinations
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.
var
string[]
$this
getExcludedDestinations
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.
setExcludedDestinations
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.
var
string[]
$this
getShoppingAdsExcludedCountries
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.
setShoppingAdsExcludedCountries
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.
var
string[]
$this
getExternalSellerId
Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
string
hasExternalSellerId
clearExternalSellerId
setExternalSellerId
Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
var
string
$this
getPause
Publication of this item will be temporarily paused .
string
hasPause
clearPause
setPause
Publication of this item will be temporarily paused .
var
string
$this
getLifestyleImageLinks
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.
setLifestyleImageLinks
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.
var
string[]
$this
getCloudExportAdditionalProperties
Extra fields to export to the Cloud Retail program.
setCloudExportAdditionalProperties
Extra fields to export to the Cloud Retail program.
$this
getVirtualModelLink
URL of the 3D image of the item. See the Help Center article for more information.
string
hasVirtualModelLink
clearVirtualModelLink
setVirtualModelLink
URL of the 3D image of the item. See the Help Center article for more information.
var
string
$this
getCertifications
Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
setCertifications
Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
$this
getStructuredTitle
Structured title, for algorithmically (AI)-generated titles.
hasStructuredTitle
clearStructuredTitle
setStructuredTitle
Structured title, for algorithmically (AI)-generated titles.
$this
getStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
hasStructuredDescription
clearStructuredDescription
setStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
$this
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.
hasAutoPricingMinPrice
clearAutoPricingMinPrice
setAutoPricingMinPrice
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.
$this
getSustainabilityIncentives
The list of sustainability incentive programs.
setSustainabilityIncentives
The list of sustainability incentive programs.
$this
