Reference documentation and code samples for the Google Shopping Css V1 Client class Attributes.
Attributes for CSS Product.
Generated from protobuf message google.shopping.css.v1.Attributes
Namespace
Google \ Shopping \ Css \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ cpp_link
string
URL directly linking to your the Product Detail Page of the CSS.
↳ cpp_mobile_link
string
URL for the mobile-optimized version of the Product Detail Page of the CSS.
↳ cpp_ads_redirect
string
Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
↳ low_price
Google\Shopping\Type\Price
Low Price of the aggregate offer.
↳ high_price
Google\Shopping\Type\Price
High Price of the aggregate offer.
↳ number_of_offers
int|string
The number of aggregate offers.
↳ headline_offer_condition
string
Condition of the headline offer.
↳ headline_offer_price
Google\Shopping\Type\Price
Headline Price of the aggregate offer.
↳ headline_offer_link
string
Link to the headline offer.
↳ headline_offer_mobile_link
string
Mobile Link to the headline offer.
↳ headline_offer_shipping_price
Google\Shopping\Type\Price
Headline Price of the aggregate offer.
↳ title
string
Title of the item.
↳ image_link
string
URL of an image of the item.
↳ additional_image_links
array
Additional URL of images of the item.
↳ description
string
Description of the item.
↳ brand
string
Product Related Attributes.[14-36] Brand of the item.
↳ mpn
↳ gtin
↳ product_types
↳ 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.
↳ adult
bool
Set to true if the item is targeted towards adults.
↳ multipack
int|string
The number of identical products in a merchant-defined multipack.
↳ is_bundle
bool
Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
↳ age_group
string
Target age group of the item.
↳ color
string
Color of the item.
↳ gender
string
Target gender of the item.
↳ material
string
The material of which the item is made.
↳ pattern
string
The item's pattern (e.g. polka dots).
↳ 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 [https://support.google.com/merchants/answer/6324492](size definition)).
↳ size_system
string
System in which the size is specified. Recommended for apparel items.
↳ 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 [https://support.google.com/merchants/answer/6324497](size type)).
↳ item_group_id
string
Shared identifier for all variants of the same product.
↳ product_details
array< Google\Shopping\Css\V1\ProductDetail
>
Technical specification or additional product details.
↳ product_weight
Google\Shopping\Css\V1\ProductWeight
The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
↳ product_length
Google\Shopping\Css\V1\ProductDimension
The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
↳ product_width
Google\Shopping\Css\V1\ProductDimension
The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
↳ product_height
Google\Shopping\Css\V1\ProductDimension
The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
↳ product_highlights
array
Bullet points describing the most relevant highlights of a product.
↳ certifications
array< Google\Shopping\Css\V1\Certification
>
A list of certificates claimed by the CSS for the given product.
↳ 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. Note: It may take 2+ days from the expiration date for the item to actually get deleted.
↳ 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
.
↳ excluded_destinations
array
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
↳ pause
string
Publication of this item will be temporarily paused.
↳ custom_label_0
string
Custom label 0 for custom grouping of items in a Shopping campaign.
↳ custom_label_1
string
Custom label 1 for custom grouping of items in a Shopping campaign.
↳ custom_label_2
string
Custom label 2 for custom grouping of items in a Shopping campaign.
↳ custom_label_3
string
Custom label 3 for custom grouping of items in a Shopping campaign.
↳ custom_label_4
string
Custom label 4 for custom grouping of items in a Shopping campaign.
getCppLink
URL directly linking to your the Product Detail Page of the CSS.
string
hasCppLink
clearCppLink
setCppLink
URL directly linking to your the Product Detail Page of the CSS.
var
string
$this
getCppMobileLink
URL for the mobile-optimized version of the Product Detail Page of the CSS.
string
hasCppMobileLink
clearCppMobileLink
setCppMobileLink
URL for the mobile-optimized version of the Product Detail Page of the CSS.
var
string
$this
getCppAdsRedirect
Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
string
hasCppAdsRedirect
clearCppAdsRedirect
setCppAdsRedirect
Allows advertisers to override the item URL when the product is shown within the context of Product Ads.
var
string
$this
getLowPrice
Low Price of the aggregate offer.
Google\Shopping\Type\Price
|null
hasLowPrice
clearLowPrice
setLowPrice
Low Price of the aggregate offer.
var
Google\Shopping\Type\Price
$this
getHighPrice
High Price of the aggregate offer.
Google\Shopping\Type\Price
|null
hasHighPrice
clearHighPrice
setHighPrice
High Price of the aggregate offer.
var
Google\Shopping\Type\Price
$this
getNumberOfOffers
The number of aggregate offers.
int|string
hasNumberOfOffers
clearNumberOfOffers
setNumberOfOffers
The number of aggregate offers.
var
int|string
$this
getHeadlineOfferCondition
Condition of the headline offer.
string
hasHeadlineOfferCondition
clearHeadlineOfferCondition
setHeadlineOfferCondition
Condition of the headline offer.
var
string
$this
getHeadlineOfferPrice
Headline Price of the aggregate offer.
Google\Shopping\Type\Price
|null
hasHeadlineOfferPrice
clearHeadlineOfferPrice
setHeadlineOfferPrice
Headline Price of the aggregate offer.
var
Google\Shopping\Type\Price
$this
getHeadlineOfferLink
Link to the headline offer.
string
hasHeadlineOfferLink
clearHeadlineOfferLink
setHeadlineOfferLink
Link to the headline offer.
var
string
$this
getHeadlineOfferMobileLink
Mobile Link to the headline offer.
string
hasHeadlineOfferMobileLink
clearHeadlineOfferMobileLink
setHeadlineOfferMobileLink
Mobile Link to the headline offer.
var
string
$this
getHeadlineOfferShippingPrice
Headline Price of the aggregate offer.
Google\Shopping\Type\Price
|null
hasHeadlineOfferShippingPrice
clearHeadlineOfferShippingPrice
setHeadlineOfferShippingPrice
Headline Price of the aggregate offer.
var
Google\Shopping\Type\Price
$this
getTitle
Title of the item.
string
hasTitle
clearTitle
setTitle
Title of the item.
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 URL of images of the item.
setAdditionalImageLinks
Additional URL of images of the item.
var
string[]
$this
getDescription
Description of the item.
string
hasDescription
clearDescription
setDescription
Description of the item.
var
string
$this
getBrand
Product Related Attributes.[14-36] Brand of the item.
string
hasBrand
clearBrand
setBrand
Product Related Attributes.[14-36] Brand of the item.
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
getGtin
Global Trade Item Number ( GTIN ) of the item.
string
hasGtin
clearGtin
setGtin
Global Trade Item Number ( GTIN ) of the item.
var
string
$this
getProductTypes
Categories of the item (formatted as in products data specification ).
setProductTypes
Categories of the item (formatted as in products data specification ).
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
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
getMultipack
The number of identical products in a merchant-defined multipack.
int|string
hasMultipack
clearMultipack
setMultipack
The number of identical products in a merchant-defined multipack.
var
int|string
$this
getIsBundle
Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
bool
hasIsBundle
clearIsBundle
setIsBundle
Whether the item is a merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant for a single price.
var
bool
$this
getAgeGroup
Target age group of the item.
string
hasAgeGroup
clearAgeGroup
setAgeGroup
Target age group of the item.
var
string
$this
getColor
Color of the item.
string
hasColor
clearColor
setColor
Color of the item.
var
string
$this
getGender
Target gender of the item.
string
hasGender
clearGender
setGender
Target gender of the item.
var
string
$this
getMaterial
The material of which the item is made.
string
hasMaterial
clearMaterial
setMaterial
The material of which the item is made.
var
string
$this
getPattern
The item's pattern (e.g. polka dots).
string
hasPattern
clearPattern
setPattern
The item's pattern (e.g. polka dots).
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
[https://support.google.com/merchants/answer/6324492](size definition)).
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
[https://support.google.com/merchants/answer/6324492](size definition)).
var
string
$this
getSizeSystem
System in which the size is specified. Recommended for apparel items.
string
hasSizeSystem
clearSizeSystem
setSizeSystem
System in which the size is specified. Recommended for apparel items.
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 [https://support.google.com/merchants/answer/6324497](size type)).
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 [https://support.google.com/merchants/answer/6324497](size type)).
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
getProductDetails
Technical specification or additional product details.
setProductDetails
Technical specification or additional product details.
$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
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
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
getProductHighlights
Bullet points describing the most relevant highlights of a product.
setProductHighlights
Bullet points describing the most relevant highlights of a product.
var
string[]
$this
getCertifications
A list of certificates claimed by the CSS for the given product.
setCertifications
A list of certificates claimed by the CSS for the given product.
$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.
Note: It may take 2+ days from the expiration date for the item to actually get deleted.
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.
Note: It may take 2+ days from the expiration date for the item to actually get deleted.
$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
.
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
.
var
string[]
$this
getExcludedDestinations
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
setExcludedDestinations
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
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
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
