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.
| Parameters | |
|---|---|
| Name | Description |
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 merchant-defined bundle. A bundle is a custom grouping of different products sold by a merchant 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 |
↳ 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 |
string
Target age group of the item. |
↳ availability |
string
Availability status of the item. |
↳ availability_date |
Google\Protobuf\Timestamp
The day a pre-ordered product becomes available for delivery, in ISO 8601 format. |
↳ brand |
string
Brand of the item. |
↳ color |
string
Color of the item. |
↳ condition |
string
Condition or state of the item. |
↳ gender |
string
Target gender of the item. |
↳ 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 |
string
Global Trade Item Number (GTIN) of the item. |
↳ item_group_id |
string
Shared identifier for all variants of the same product. |
↳ material |
string
The material of which the item is made. |
↳ mpn |
string
Manufacturer Part Number (MPN) of the item. |
↳ pattern |
string
The item's pattern (for example, polka dots). |
↳ price |
Google\Shopping\Type\Price
Price of the item. |
↳ installment |
Installment
Number and amount of installments to pay for an item. |
↳ 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 |
LoyaltyPoints
Loyalty points that users receive after purchasing the item. Japan only. |
↳ 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 |
array
Categories of the item (formatted as in product data specification). |
↳ sale_price |
Google\Shopping\Type\Price
Advertised sale price of the item. |
↳ sale_price_effective_date |
Google\Type\Interval
Date range during which the item is on sale (see product data specification). |
↳ 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 |
array<Shipping>
Shipping rules. |
↳ free_shipping_threshold |
array<FreeShippingThreshold>
Conditions to be met for a product to have free shipping. |
↳ shipping_weight |
ShippingWeight
Weight of the item for shipping. |
↳ shipping_length |
ShippingDimension
Length of the item for shipping. |
↳ shipping_width |
ShippingDimension
Width of the item for shipping. |
↳ shipping_height |
ShippingDimension
Height of the item for shipping. |
↳ 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 |
↳ 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)). |
↳ taxes |
array<Tax>
Tax information. |
↳ tax_category |
string
The tax category of the product, used to configure detailed tax nexus in account-level tax settings. |
↳ 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 |
UnitPricingMeasure
The measure and dimension of an item. |
↳ unit_pricing_base_measure |
UnitPricingBaseMeasure
The preference of the denominator of the unit price. |
↳ multipack |
int|string
The number of identical products in a merchant-defined multipack. |
↳ ads_grouping |
string
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. |
↳ 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 |
Google\Shopping\Type\Price
Cost of goods sold. Used for gross profit reporting. |
↳ product_details |
array<ProductDetail>
Technical specification or additional product details. |
↳ product_highlights |
array
Bullet points describing the most relevant highlights of a product. |
↳ display_ads_id |
string
An identifier for an item for dynamic remarketing campaigns. |
↳ display_ads_similar_ids |
array
Advertiser-specified recommendations. |
↳ 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. |
↳ promotion_ids |
array
The unique ID of a promotion. |
↳ pickup_method |
string
The pick up option for the item. |
↳ pickup_sla |
string
Item store pickup timeline. |
↳ link_template |
string
Link template for merchant hosted local storefront. |
↳ mobile_link_template |
string
Link template for merchant hosted local storefront optimized for mobile devices. |
↳ 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. |
↳ 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 |
↳ excluded_destinations |
array
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center). |
↳ 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 |
string
Publication of this item will be temporarily paused. |
↳ 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 |
array<CloudExportAdditionalProperties>
Extra fields to export to the Cloud Retail program. |
↳ virtual_model_link |
string
URL of the 3D image of the item. See the Help Center article for more information. |
↳ 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 |
ProductStructuredTitle
Structured title, for algorithmically (AI)-generated titles. |
↳ structured_description |
ProductStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions. |
↳ auto_pricing_min_price |
Google\Shopping\Type\Price
A safeguard in the "Automated Discounts" (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on merchants' offers do not fall below this value, thereby preserving the offer's value and profitability. |
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.
| Returns | |
|---|---|
| Type | Description |
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.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| 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 |
|
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 |
|
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 |
|
getLink
URL directly linking to your item's page on your online store.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasLink
clearLink
setLink
URL directly linking to your item's page on your online store.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMobileLink
URL for the mobile-optimized version of your item's landing page.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMobileLink
clearMobileLink
setMobileLink
URL for the mobile-optimized version of your item's landing page.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCanonicalLink
URL for the canonical version of your item's landing page.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCanonicalLink
clearCanonicalLink
setCanonicalLink
URL for the canonical version of your item's landing page.
| 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 URLs of images of the item.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAdditionalImageLinks
Additional URLs of images of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| 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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| 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 |
|
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 |
|
getAvailability
Availability status of the item.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAvailability
clearAvailability
setAvailability
Availability status of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvailabilityDate
The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null |
|
hasAvailabilityDate
clearAvailabilityDate
setAvailabilityDate
The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBrand
Brand of the item.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasBrand
clearBrand
setBrand
Brand 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 |
|
getCondition
Condition or state of the item.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasCondition
clearCondition
setCondition
Condition or state 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 |
|
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
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.
| 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 |
|
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 |
|
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 |
|
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 |
|
getPattern
The item's pattern (for example, polka dots).
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPattern
clearPattern
setPattern
The item's pattern (for example, polka dots).
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPrice
Price of the item.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasPrice
clearPrice
setPrice
Price of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getInstallment
Number and amount of installments to pay for an item.
| Returns | |
|---|---|
| Type | Description |
Installment|null |
|
hasInstallment
clearInstallment
setInstallment
Number and amount of installments to pay for an item.
| Parameter | |
|---|---|
| Name | Description |
var |
Installment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubscriptionCost
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
| Returns | |
|---|---|
| Type | Description |
SubscriptionCost|null |
|
hasSubscriptionCost
clearSubscriptionCost
setSubscriptionCost
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
| Parameter | |
|---|---|
| Name | Description |
var |
SubscriptionCost
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLoyaltyPoints
Loyalty points that users receive after purchasing the item. Japan only.
| Returns | |
|---|---|
| Type | Description |
LoyaltyPoints|null |
|
hasLoyaltyPoints
clearLoyaltyPoints
setLoyaltyPoints
Loyalty points that users receive after purchasing the item. Japan only.
| Parameter | |
|---|---|
| Name | Description |
var |
LoyaltyPoints
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<LoyaltyProgram>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProductTypes
Categories of the item (formatted as in product data specification).
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setProductTypes
Categories of the item (formatted as in product data specification).
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSalePrice
Advertised sale price of the item.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasSalePrice
clearSalePrice
setSalePrice
Advertised sale price of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSalePriceEffectiveDate
Date range during which the item is on sale (see product data specification).
| Returns | |
|---|---|
| Type | Description |
Google\Type\Interval|null |
|
hasSalePriceEffectiveDate
clearSalePriceEffectiveDate
setSalePriceEffectiveDate
Date range during which the item is on sale (see product data specification).
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Type\Interval
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSellOnGoogleQuantity
The quantity of the product that is available for selling on Google.
Supported only for online products.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasSellOnGoogleQuantity
clearSellOnGoogleQuantity
setSellOnGoogleQuantity
The quantity of the product that is available for selling on Google.
Supported only for online products.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| 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 |
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 |
ProductDimension
|
| 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 |
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 |
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 |
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 |
ProductDimension
|
| 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 |
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 |
ProductWeight
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShipping
Shipping rules.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setShipping
Shipping rules.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Shipping>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFreeShippingThreshold
Conditions to be met for a product to have free shipping.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setFreeShippingThreshold
Conditions to be met for a product to have free shipping.
| Parameter | |
|---|---|
| Name | Description |
var |
array<FreeShippingThreshold>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShippingWeight
Weight of the item for shipping.
| Returns | |
|---|---|
| Type | Description |
ShippingWeight|null |
|
hasShippingWeight
clearShippingWeight
setShippingWeight
Weight of the item for shipping.
| Parameter | |
|---|---|
| Name | Description |
var |
ShippingWeight
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShippingLength
Length of the item for shipping.
| Returns | |
|---|---|
| Type | Description |
ShippingDimension|null |
|
hasShippingLength
clearShippingLength
setShippingLength
Length of the item for shipping.
| Parameter | |
|---|---|
| Name | Description |
var |
ShippingDimension
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShippingWidth
Width of the item for shipping.
| Returns | |
|---|---|
| Type | Description |
ShippingDimension|null |
|
hasShippingWidth
clearShippingWidth
setShippingWidth
Width of the item for shipping.
| Parameter | |
|---|---|
| Name | Description |
var |
ShippingDimension
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShippingHeight
Height of the item for shipping.
| Returns | |
|---|---|
| Type | Description |
ShippingDimension|null |
|
hasShippingHeight
clearShippingHeight
setShippingHeight
Height of the item for shipping.
| Parameter | |
|---|---|
| Name | Description |
var |
ShippingDimension
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxHandlingTime
Maximal product handling time (in business days).
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMaxHandlingTime
clearMaxHandlingTime
setMaxHandlingTime
Maximal product handling time (in business days).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinHandlingTime
Minimal product handling time (in business days).
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMinHandlingTime
clearMinHandlingTime
setMinHandlingTime
Minimal product handling time (in business days).
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShippingLabel
The shipping label of the product, used to group product in account-level shipping rules.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasShippingLabel
clearShippingLabel
setShippingLabel
The shipping label of the product, used to group product in account-level shipping rules.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTransitTimeLabel
The transit time label of the product, used to group product in account-level transit time tables.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTransitTimeLabel
clearTransitTimeLabel
setTransitTimeLabel
The transit time label of the product, used to group product in account-level transit time tables.
| 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
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)).
| 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
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)).
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaxes
Tax information.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setTaxes
Tax information.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Tax>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTaxCategory
The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasTaxCategory
clearTaxCategory
setTaxCategory
The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasEnergyEfficiencyClass
clearEnergyEfficiencyClass
setEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMinEnergyEfficiencyClass
clearMinEnergyEfficiencyClass
setMinEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMaxEnergyEfficiencyClass
clearMaxEnergyEfficiencyClass
setMaxEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnitPricingMeasure
The measure and dimension of an item.
| Returns | |
|---|---|
| Type | Description |
UnitPricingMeasure|null |
|
hasUnitPricingMeasure
clearUnitPricingMeasure
setUnitPricingMeasure
The measure and dimension of an item.
| Parameter | |
|---|---|
| Name | Description |
var |
UnitPricingMeasure
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnitPricingBaseMeasure
The preference of the denominator of the unit price.
| Returns | |
|---|---|
| Type | Description |
UnitPricingBaseMeasure|null |
|
hasUnitPricingBaseMeasure
clearUnitPricingBaseMeasure
setUnitPricingBaseMeasure
The preference of the denominator of the unit price.
| Parameter | |
|---|---|
| Name | Description |
var |
UnitPricingBaseMeasure
|
| 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 |
|
getAdsGrouping
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAdsGrouping
clearAdsGrouping
setAdsGrouping
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdsLabels
Similar to ads_grouping, but only works on CPC.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setAdsLabels
Similar to ads_grouping, but only works on CPC.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdsRedirect
Allows advertisers to override the item URL when the product is shown within the context of Product ads.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAdsRedirect
clearAdsRedirect
setAdsRedirect
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 |
|
getCostOfGoodsSold
Cost of goods sold. Used for gross profit reporting.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasCostOfGoodsSold
clearCostOfGoodsSold
setCostOfGoodsSold
Cost of goods sold. Used for gross profit reporting.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| 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<ProductDetail>
|
| 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 |
|
getDisplayAdsId
An identifier for an item for dynamic remarketing campaigns.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayAdsId
clearDisplayAdsId
setDisplayAdsId
An identifier for an item for dynamic remarketing campaigns.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayAdsSimilarIds
Advertiser-specified recommendations.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setDisplayAdsSimilarIds
Advertiser-specified recommendations.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayAdsTitle
Title of an item for dynamic remarketing campaigns.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayAdsTitle
clearDisplayAdsTitle
setDisplayAdsTitle
Title of an item for dynamic remarketing campaigns.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayAdsLink
URL directly to your item's landing page for dynamic remarketing campaigns.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasDisplayAdsLink
clearDisplayAdsLink
setDisplayAdsLink
URL directly to your item's landing page for dynamic remarketing campaigns.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayAdsValue
Offer margin for dynamic remarketing campaigns.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasDisplayAdsValue
clearDisplayAdsValue
setDisplayAdsValue
Offer margin for dynamic remarketing campaigns.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPromotionIds
The unique ID of a promotion.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setPromotionIds
The unique ID of a promotion.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPickupMethod
The pick up option for the item.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPickupMethod
clearPickupMethod
setPickupMethod
The pick up option for the item.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPickupSla
Item store pickup timeline.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasPickupSla
clearPickupSla
setPickupSla
Item store pickup timeline.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLinkTemplate
Link template for merchant hosted local storefront.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasLinkTemplate
clearLinkTemplate
setLinkTemplate
Link template for merchant hosted local storefront.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMobileLinkTemplate
Link template for merchant hosted local storefront optimized for mobile devices.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMobileLinkTemplate
clearMobileLinkTemplate
setMobileLinkTemplate
Link template for merchant hosted local storefront optimized for mobile devices.
| 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 |
|
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 |
|
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
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.
| 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 |
|
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCloudExportAdditionalProperties
Extra fields to export to the Cloud Retail program.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
setCloudExportAdditionalProperties
Extra fields to export to the Cloud Retail program.
| Parameter | |
|---|---|
| Name | Description |
var |
array<CloudExportAdditionalProperties>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVirtualModelLink
URL of the 3D image of the item. See the Help Center article for more information.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasVirtualModelLink
clearVirtualModelLink
setVirtualModelLink
URL of the 3D image of the item. See the Help Center article for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Certification>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStructuredTitle
Structured title, for algorithmically (AI)-generated titles.
| Returns | |
|---|---|
| Type | Description |
ProductStructuredTitle|null |
|
hasStructuredTitle
clearStructuredTitle
setStructuredTitle
Structured title, for algorithmically (AI)-generated titles.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductStructuredTitle
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
| Returns | |
|---|---|
| Type | Description |
ProductStructuredDescription|null |
|
hasStructuredDescription
clearStructuredDescription
setStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductStructuredDescription
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAutoPricingMinPrice
A safeguard in the "Automated Discounts" (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on merchants' offers do not fall below this value, thereby preserving the offer's value and profitability.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasAutoPricingMinPrice
clearAutoPricingMinPrice
setAutoPricingMinPrice
A safeguard in the "Automated Discounts" (https://support.google.com/merchants/answer/10295759) and "Dynamic Promotions" (https://support.google.com/merchants/answer/13949249) projects, ensuring that discounts on merchants' offers do not fall below this value, thereby preserving the offer's value and profitability.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|