Google Shopping Css V1 Client - Class Attributes (0.3.0)

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 \ V1

Methods

__construct

Constructor.

Parameters
Name	Description
`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`	`string` Manufacturer Part Number (MPN) of the item.
`↳ gtin`	`string` Global Trade Item Number (GTIN) of the item.
`↳ product_types`	`array` Categories of the item (formatted as in products data specification).
`↳ 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.
`↳ headline_offer_installment`	`Google\Shopping\Css\V1\HeadlineOfferInstallment` Number and amount of installments to pay for an item.
`↳ headline_offer_subscription_cost`	`Google\Shopping\Css\V1\HeadlineOfferSubscriptionCost` Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.

getCppLink

URL directly linking to your the Product Detail Page of the CSS.

Returns
Type	Description
`string`

hasCppLink

clearCppLink

setCppLink

URL directly linking to your the Product Detail Page of the CSS.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCppMobileLink

URL for the mobile-optimized version of the Product Detail Page of the CSS.

Returns
Type	Description
`string`

hasCppMobileLink

clearCppMobileLink

setCppMobileLink

URL for the mobile-optimized version of the Product Detail Page of the CSS.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCppAdsRedirect

Allows advertisers to override the item URL when the product is shown within the context of Product Ads.

Returns
Type	Description
`string`

hasCppAdsRedirect

clearCppAdsRedirect

setCppAdsRedirect

Allows advertisers to override the item URL when the product is shown within the context of Product Ads.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getLowPrice

Low Price of the aggregate offer.

Returns
Type	Description
`Google\Shopping\Type\Price\|null`

hasLowPrice

clearLowPrice

setLowPrice

Low Price of the aggregate offer.

Parameter
Name	Description
`var`	`Google\Shopping\Type\Price`

Returns
Type	Description
`$this`

getHighPrice

High Price of the aggregate offer.

Returns
Type	Description
`Google\Shopping\Type\Price\|null`

hasHighPrice

clearHighPrice

setHighPrice

High Price of the aggregate offer.

Parameter
Name	Description
`var`	`Google\Shopping\Type\Price`

Returns
Type	Description
`$this`

getNumberOfOffers

The number of aggregate offers.

Returns
Type	Description
`int\|string`

hasNumberOfOffers

clearNumberOfOffers

setNumberOfOffers

The number of aggregate offers.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$this`

getHeadlineOfferCondition

Condition of the headline offer.

Returns
Type	Description
`string`

hasHeadlineOfferCondition

clearHeadlineOfferCondition

setHeadlineOfferCondition

Condition of the headline offer.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHeadlineOfferPrice

Headline Price of the aggregate offer.

Returns
Type	Description
`Google\Shopping\Type\Price\|null`

hasHeadlineOfferPrice

clearHeadlineOfferPrice

setHeadlineOfferPrice

Headline Price of the aggregate offer.

Parameter
Name	Description
`var`	`Google\Shopping\Type\Price`

Returns
Type	Description
`$this`

getHeadlineOfferLink

Link to the headline offer.

Returns
Type	Description
`string`

hasHeadlineOfferLink

clearHeadlineOfferLink

setHeadlineOfferLink

Link to the headline offer.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHeadlineOfferMobileLink

Mobile Link to the headline offer.

Returns
Type	Description
`string`

hasHeadlineOfferMobileLink

clearHeadlineOfferMobileLink

setHeadlineOfferMobileLink

Mobile Link to the headline offer.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHeadlineOfferShippingPrice

Headline Price of the aggregate offer.

Returns
Type	Description
`Google\Shopping\Type\Price\|null`

hasHeadlineOfferShippingPrice

clearHeadlineOfferShippingPrice

setHeadlineOfferShippingPrice

Headline Price of the aggregate offer.

Parameter
Name	Description
`var`	`Google\Shopping\Type\Price`

Returns
Type	Description
`$this`

getTitle

Title of the item.

Returns
Type	Description
`string`

hasTitle

clearTitle

setTitle

Title of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getImageLink

URL of an image of the item.

Returns
Type	Description
`string`

hasImageLink

clearImageLink

setImageLink

URL of an image of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAdditionalImageLinks

Additional URL of images of the item.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setAdditionalImageLinks

Additional URL of images of the item.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getDescription

Description of the item.

Returns
Type	Description
`string`

hasDescription

clearDescription

setDescription

Description of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getBrand

Product Related Attributes.[14-36] Brand of the item.

Returns
Type	Description
`string`

hasBrand

clearBrand

setBrand

Product Related Attributes.[14-36] Brand of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMpn

Manufacturer Part Number (MPN) of the item.

Returns
Type	Description
`string`

hasMpn

clearMpn

setMpn

Manufacturer Part Number (MPN) of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGtin

Global Trade Item Number (GTIN) of the item.

Returns
Type	Description
`string`

hasGtin

clearGtin

setGtin

Global Trade Item Number (GTIN) of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProductTypes

Categories of the item (formatted as in products data specification).

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setProductTypes

Categories of the item (formatted as in products data specification).

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$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.

Returns
Type	Description
`string`

hasGoogleProductCategory

clearGoogleProductCategory

setGoogleProductCategory

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getAdult

Set to true if the item is targeted towards adults.

Returns
Type	Description
`bool`

hasAdult

clearAdult

setAdult

Set to true if the item is targeted towards adults.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getMultipack

The number of identical products in a merchant-defined multipack.

Returns
Type	Description
`int\|string`

hasMultipack

clearMultipack

setMultipack

The number of identical products in a merchant-defined multipack.

Parameter
Name	Description
`var`	`int\|string`

Returns
Type	Description
`$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.

Returns
Type	Description
`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.

Parameter
Name	Description
`var`	`bool`

Returns
Type	Description
`$this`

getAgeGroup

Target age group of the item.

Returns
Type	Description
`string`

hasAgeGroup

clearAgeGroup

setAgeGroup

Target age group of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getColor

Color of the item.

Returns
Type	Description
`string`

hasColor

clearColor

setColor

Color of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getGender

Target gender of the item.

Returns
Type	Description
`string`

hasGender

clearGender

setGender

Target gender of the item.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getMaterial

The material of which the item is made.

Returns
Type	Description
`string`

hasMaterial

clearMaterial

setMaterial

The material of which the item is made.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getPattern

The item's pattern (e.g. polka dots).

Returns
Type	Description
`string`

hasPattern

clearPattern

setPattern

The item's pattern (e.g. polka dots).

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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)).

Returns
Type	Description
`string`

hasSize

clearSize

setSize

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getSizeSystem

System in which the size is specified. Recommended for apparel items.

Returns
Type	Description
`string`

hasSizeSystem

clearSizeSystem

setSizeSystem

System in which the size is specified. Recommended for apparel items.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$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)).

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setSizeTypes

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getItemGroupId

Shared identifier for all variants of the same product.

Returns
Type	Description
`string`

hasItemGroupId

clearItemGroupId

setItemGroupId

Shared identifier for all variants of the same product.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getProductDetails

Technical specification or additional product details.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setProductDetails

Technical specification or additional product details.

Parameter
Name	Description
`var`	`array<Google\Shopping\Css\V1\ProductDetail>`

Returns
Type	Description
`$this`

getProductWeight

The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).

Returns
Type	Description
`Google\Shopping\Css\V1\ProductWeight\|null`

hasProductWeight

clearProductWeight

setProductWeight

The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).

Parameter
Name	Description
`var`	`Google\Shopping\Css\V1\ProductWeight`

Returns
Type	Description
`$this`

getProductLength

The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Returns
Type	Description
`Google\Shopping\Css\V1\ProductDimension\|null`

hasProductLength

clearProductLength

setProductLength

The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Parameter
Name	Description
`var`	`Google\Shopping\Css\V1\ProductDimension`

Returns
Type	Description
`$this`

getProductWidth

The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Returns
Type	Description
`Google\Shopping\Css\V1\ProductDimension\|null`

hasProductWidth

clearProductWidth

setProductWidth

The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Parameter
Name	Description
`var`	`Google\Shopping\Css\V1\ProductDimension`

Returns
Type	Description
`$this`

getProductHeight

The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Returns
Type	Description
`Google\Shopping\Css\V1\ProductDimension\|null`

hasProductHeight

clearProductHeight

setProductHeight

The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).

Parameter
Name	Description
`var`	`Google\Shopping\Css\V1\ProductDimension`

Returns
Type	Description
`$this`

getProductHighlights

Bullet points describing the most relevant highlights of a product.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setProductHighlights

Bullet points describing the most relevant highlights of a product.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getCertifications

A list of certificates claimed by the CSS for the given product.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setCertifications

A list of certificates claimed by the CSS for the given product.

Parameter
Name	Description
`var`	`array<Google\Shopping\Css\V1\Certification>`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Timestamp\|null`

hasExpirationDate

clearExpirationDate

setExpirationDate

Note: It may take 2+ days from the expiration date for the item to actually get deleted.

Parameter
Name	Description
`var`	`Google\Protobuf\Timestamp`

Returns
Type	Description
`$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.

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

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.

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getExcludedDestinations

The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

Returns
Type	Description
`Google\Protobuf\Internal\RepeatedField`

setExcludedDestinations

The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).

Parameter
Name	Description
`var`	`string[]`

Returns
Type	Description
`$this`

getPause

Publication of this item will be temporarily paused.

Returns
Type	Description
`string`

hasPause

clearPause

setPause

Publication of this item will be temporarily paused.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel0

Custom label 0 for custom grouping of items in a Shopping campaign.

Returns
Type	Description
`string`

hasCustomLabel0

clearCustomLabel0

setCustomLabel0

Custom label 0 for custom grouping of items in a Shopping campaign.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel1

Custom label 1 for custom grouping of items in a Shopping campaign.

Returns
Type	Description
`string`

hasCustomLabel1

clearCustomLabel1

setCustomLabel1

Custom label 1 for custom grouping of items in a Shopping campaign.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel2

Custom label 2 for custom grouping of items in a Shopping campaign.

Returns
Type	Description
`string`

hasCustomLabel2

clearCustomLabel2

setCustomLabel2

Custom label 2 for custom grouping of items in a Shopping campaign.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel3

Custom label 3 for custom grouping of items in a Shopping campaign.

Returns
Type	Description
`string`

hasCustomLabel3

clearCustomLabel3

setCustomLabel3

Custom label 3 for custom grouping of items in a Shopping campaign.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getCustomLabel4

Custom label 4 for custom grouping of items in a Shopping campaign.

Returns
Type	Description
`string`

hasCustomLabel4

clearCustomLabel4

setCustomLabel4

Custom label 4 for custom grouping of items in a Shopping campaign.

Parameter
Name	Description
`var`	`string`

Returns
Type	Description
`$this`

getHeadlineOfferInstallment

Number and amount of installments to pay for an item.

Returns
Type	Description
`Google\Shopping\Css\V1\HeadlineOfferInstallment\|null`

hasHeadlineOfferInstallment

clearHeadlineOfferInstallment

setHeadlineOfferInstallment

Number and amount of installments to pay for an item.

Parameter
Name	Description
`var`	`Google\Shopping\Css\V1\HeadlineOfferInstallment`

Returns
Type	Description
`$this`

getHeadlineOfferSubscriptionCost

Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.

Returns
Type	Description
`Google\Shopping\Css\V1\HeadlineOfferSubscriptionCost\|null`

hasHeadlineOfferSubscriptionCost

clearHeadlineOfferSubscriptionCost

setHeadlineOfferSubscriptionCost

Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.

Parameter
Name	Description
`var`	`Google\Shopping\Css\V1\HeadlineOfferSubscriptionCost`

Returns
Type	Description
`$this`