Reference documentation and code samples for the Google Shopping Merchant Products V1 Client class ProductAttributes.
Product attributes.
Generated from protobuf message google.shopping.merchant.products.v1.ProductAttributes
Namespace
Google \ Shopping \ Merchant \ Products \ V1Methods
__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 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 |
string[]
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 |
int
Target age group of the item. |
↳ availability |
int
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. For example, "Google". |
↳ color |
string
Color of the item. For example, "red". |
↳ condition |
int
Condition or state of the item. |
↳ gender |
int
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. |
↳ gtins |
string[]
Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs. |
↳ item_group_id |
string
Shared identifier for all variants of the same product. |
↳ material |
string
The material of which the item is made. For example, "Leather" or "Cotton". |
↳ 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. |
↳ maximum_retail_price |
Google\Shopping\Type\Price
Maximum retail price (MRP) of the item. Applicable to India only. |
↳ installment |
ProductInstallment
Number and amount of installments to pay for an item. |
↳ subscription_cost |
SubscriptionCost
Number of periods (weeks, 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 |
string[]
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. |
↳ carrier_shipping |
array<ProductAttributes\CarrierShipping>
Rules for carrier-based shipping. |
↳ 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_handling_business_days |
array<ProductAttributes\ShippingBusinessDaysConfig>
The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed. |
↳ shipping_transit_business_days |
array<ProductAttributes\ShippingBusinessDaysConfig>
The business days during which orders are in transit. If not provided, Monday to Friday business days will be assumed. |
↳ handling_cutoff_times |
array<HandlingCutoffTime>
The handling cutoff times for shipping. |
↳ shipping_label |
string
The shipping label of the product, used to group products in account-level shipping rules. Max. 100 characters. For more information, see Shipping label. |
↳ return_policy_label |
string
The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see Return policy label. |
↳ 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 |
int
System in which the size is specified. Recommended for apparel items. For more information, see Size system. |
↳ size_types |
int[]
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. |
↳ energy_efficiency_class |
int
The energy efficiency class as defined in EU directive 2010/30/EU. |
↳ min_energy_efficiency_class |
int
The energy efficiency class as defined in EU directive 2010/30/EU. |
↳ max_energy_efficiency_class |
int
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 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 |
string[]
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 |
string[]
Bullet points describing the most relevant product highlights. |
↳ display_ads_id |
string
An identifier for an item for dynamic remarketing campaigns. |
↳ display_ads_similar_ids |
string[]
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 |
string[]
The unique ID of a promotion. |
↳ pickup_method |
int
The pickup option for the item. |
↳ pickup_sla |
int
Item store pickup timeline. For more information, see Pickup SLA. |
↳ pickup_cost |
PickupCost
Optional. The pickup cost for an item when a customer buys it online and picks it up at a store. |
↳ link_template |
string
Link template for business hosted local storefront. |
↳ mobile_link_template |
string
Link template for business 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 |
int[]
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 |
int[]
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 |
string[]
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 |
int
Publication of this item will be temporarily paused. |
↳ lifestyle_image_links |
string[]
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<ProductCertification>
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 |
StructuredTitle
Structured title, for algorithmically (AI)-generated titles. |
↳ structured_description |
StructuredDescription
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 |
array<ProductSustainabilityIncentive>
The list of sustainability incentive programs. |
↳ video_links |
string[]
Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the Help Center article for more information. |
↳ minimum_order_values |
array<ProductMinimumOrderValue>
The minimum value in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100. |
↳ vin |
string
The Vehicle Identification Number (VIN) of the vehicle. |
↳ model |
string
The Model of the vehicle, such as |
↳ trim |
string
The Trim of the vehicle model, such as |
↳ body_style |
int
The body style of the vehicle. |
↳ year |
int|string
The Year of the vehicle model. |
↳ mileage |
ProductAttributes\Mileage
The number of miles/kms on the vehicle. See the Mileage for more information. |
↳ electric_range |
ProductAttributes\Mileage
The electric range of the vehicle in miles/kms. |
↳ fuel_consumption |
ProductAttributes\FuelConsumption
The fuel consumption of the vehicle. |
↳ fuel_consumption_discharged_battery |
ProductAttributes\FuelConsumption
The fuel consumption of the vehicle when the hybrid battery is discharged. See the Help Center article for more information. |
↳ energy_consumption |
ProductAttributes\EnergyConsumption
The energy consumption of the vehicle. |
↳ co2_emissions |
ProductAttributes\Co2Emissions
The co2 emission of the vehicle. |
↳ date_first_registered |
string
The date the vehicle was first registered. Format: |
↳ engine |
int
The engine type of the vehicle. |
↳ emissions_standard |
int
The emission standard of the vehicle. |
↳ certified_pre_owned |
bool
Whether the vehicle is OEM certified pre-owned. |
↳ vehicle_msrp |
Google\Shopping\Type\Price
The MSRP (Manufacturer Suggested Retail Price) for the vehicle in its current configuration. See the Vehicle MSRP for more information. |
↳ vehicle_all_in_price |
Google\Shopping\Type\Price
The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the Vehicle all-in price for more information. |
↳ vehicle_price_type |
int
The price type of the vehicle. |
↳ vehicle_mandatory_inspection_included |
bool
Whether the vehicle is sold with mandatory inspection and maintenance performed before delivery. See the Vehicle mandatory inspection included for more information.` |
↳ vehicle_expenses |
Google\Shopping\Type\Price
The miscellaneous expenses like insurance and registration fees of the vehicle. See the Vehicle expenses for more information. |
↳ warranty |
ProductAttributes\Warranty
The warranty of the vehicle. |
↳ display_address |
ProductAttributes\DisplayAddress
The display address of the property. |
↳ latitude |
float
The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places. |
↳ longitude |
float
The longitude of the property. The value must be between -180 (inclusive) and 180 (inclusive), up to 6 decimal places. |
↳ neighborhood |
string
The neighborhood (locality) of the property, such as |
↳ unit_area |
ProductAttributes\UnitArea
The unit area of the property, such as |
↳ number_of_units |
int|string
The number of units available for a specific floor plan of the property. The value must be greater than 0. |
↳ property_name |
string
The name of the property. |
↳ number_of_bedrooms |
float
The number of bedrooms in the property. The value must be greater than or equal to 0 and a multiple of 1.0. |
↳ number_of_bathrooms |
float
The number of bathrooms in the property. The value must be greater than 0 and a multiple of 0.5. |
↳ property_type |
int
The type of property. |
↳ amenity_feature |
int[]
The amenity features for the property. |
↳ utilities_included |
int[]
The utilities included for the property. |
↳ pet_policy |
ProductAttributes\PetPolicy
The pet policy for the property. |
↳ specialty_housing_type |
int
The specialty housing type for the property. |
↳ product_fee |
array<ProductAttributes\ProductFee>
The product fee for the property. |
↳ short_title |
string
The short title of the item. |
↳ questions_and_answers |
array<ProductAttributes\QuestionAndAnswer>
Optional. Contains user-, merchant-, and manufacturer-authored questions and answers about the product. Max 30 question and answer pairs. Max 10000 characters total. Each question can have max 1000 characters. Each answer can have max 1000 characters. |
↳ popularity_rank |
float
Optional. Indicates the popularity of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest). |
↳ item_group_title |
string
Optional. Represents the title of the product group to which this variant product belongs. This can be used along with the item group id attribute. It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently. |
↳ document_links |
string[]
Optional. Contains a list of PDF document URLs for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant. |
↳ variant_options |
array<ProductAttributes\VariantOption>
Optional. Contains the list of all variant-identifying options of this product. |
↳ related_products |
array<ProductAttributes\RelatedProduct>
Optional. Specifies how other products are related to this product. |
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 business-defined sub-API. A sub-API is a custom grouping of different products sold by a business for a single price.
| Returns | |
|---|---|
| Type | Description |
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.
| 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\RepeatedField<string> |
|
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 |
int |
|
hasAgeGroup
clearAgeGroup
setAgeGroup
Target age group of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAvailability
Availability status of the item.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasAvailability
clearAvailability
setAvailability
Availability status of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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.
For example, "Google".
| Returns | |
|---|---|
| Type | Description |
string |
|
hasBrand
clearBrand
setBrand
Brand of the item.
For example, "Google".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getColor
Color of the item.
For example, "red".
| Returns | |
|---|---|
| Type | Description |
string |
|
hasColor
clearColor
setColor
Color of the item.
For example, "red".
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCondition
Condition or state of the item.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasCondition
clearCondition
setCondition
Condition or state of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getGender
Target gender of the item.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasGender
clearGender
setGender
Target gender of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 |
|
getGtins
Global Trade Item Numbers (GTIN) of the item.
You can provide up to 10 GTINs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setGtins
Global Trade Item Numbers (GTIN) of the item.
You can provide up to 10 GTINs.
| 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. For example, "Leather" or "Cotton".
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMaterial
clearMaterial
setMaterial
The material of which the item is made. For example, "Leather" or "Cotton".
| 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 |
|
getMaximumRetailPrice
Maximum retail price (MRP) of the item. Applicable to India only.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasMaximumRetailPrice
clearMaximumRetailPrice
setMaximumRetailPrice
Maximum retail price (MRP) of the item. Applicable to India only.
| 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 |
ProductInstallment|null |
|
hasInstallment
clearInstallment
setInstallment
Number and amount of installments to pay for an item.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductInstallment
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSubscriptionCost
Number of periods (weeks, 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 (weeks, 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\RepeatedField<LoyaltyProgram> |
|
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\RepeatedField<string> |
|
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\RepeatedField<Shipping> |
|
setShipping
Shipping rules.
| Parameter | |
|---|---|
| Name | Description |
var |
array<Shipping>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCarrierShipping
Rules for carrier-based shipping.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductAttributes\CarrierShipping> |
|
setCarrierShipping
Rules for carrier-based shipping.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductAttributes\CarrierShipping>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFreeShippingThreshold
Conditions to be met for a product to have free shipping.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<FreeShippingThreshold> |
|
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 |
|
getShippingHandlingBusinessDays
The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductAttributes\ShippingBusinessDaysConfig> |
|
setShippingHandlingBusinessDays
The business days during which orders can be handled. If not provided, Monday to Friday business days will be assumed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductAttributes\ShippingBusinessDaysConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShippingTransitBusinessDays
The business days during which orders are in transit.
If not provided, Monday to Friday business days will be assumed.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductAttributes\ShippingBusinessDaysConfig> |
|
setShippingTransitBusinessDays
The business days during which orders are in transit.
If not provided, Monday to Friday business days will be assumed.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductAttributes\ShippingBusinessDaysConfig>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getHandlingCutoffTimes
The handling cutoff times for shipping.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<HandlingCutoffTime> |
|
setHandlingCutoffTimes
The handling cutoff times for shipping.
| Parameter | |
|---|---|
| Name | Description |
var |
array<HandlingCutoffTime>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShippingLabel
The shipping label of the product, used to group products in account-level shipping rules. Max. 100 characters. For more information, see Shipping label.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasShippingLabel
clearShippingLabel
setShippingLabel
The shipping label of the product, used to group products in account-level shipping rules. Max. 100 characters. For more information, see Shipping label.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getReturnPolicyLabel
The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see Return policy label.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasReturnPolicyLabel
clearReturnPolicyLabel
setReturnPolicyLabel
The return label of the product, used to group products in account-level return policies. Max. 100 characters. For more information, see Return policy label.
| 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
Size.
| 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
Size.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSizeSystem
System in which the size is specified. Recommended for apparel items.
For more information, see Size system.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasSizeSystem
clearSizeSystem
setSizeSystem
System in which the size is specified. Recommended for apparel items.
For more information, see Size system.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 Size type.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasEnergyEfficiencyClass
clearEnergyEfficiencyClass
setEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMinEnergyEfficiencyClass
clearMinEnergyEfficiencyClass
setMinEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMaxEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasMaxEnergyEfficiencyClass
clearMaxEnergyEfficiencyClass
setMaxEnergyEfficiencyClass
The energy efficiency class as defined in EU directive 2010/30/EU.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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 business-defined multipack.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasMultipack
clearMultipack
setMultipack
The number of identical products in a business-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. For more information, see Display ads attribute.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasAdsGrouping
clearAdsGrouping
setAdsGrouping
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAdsLabels
Similar to ads_grouping, but only works on CPC.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
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\RepeatedField<ProductDetail> |
|
setProductDetails
Technical specification or additional product details.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductDetail>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProductHighlights
Bullet points describing the most relevant product highlights.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setProductHighlights
Bullet points describing the most relevant product highlights.
| 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. For more information, see Display ads attribute specification.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setDisplayAdsSimilarIds
Advertiser-specified recommendations. For more information, see Display ads attribute specification.
| 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. For more information, see Display ads attribute.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasDisplayAdsValue
clearDisplayAdsValue
setDisplayAdsValue
Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPromotionIds
The unique ID of a promotion.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setPromotionIds
The unique ID of a promotion.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPickupMethod
The pickup option for the item.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasPickupMethod
clearPickupMethod
setPickupMethod
The pickup option for the item.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPickupSla
Item store pickup timeline. For more information, see Pickup SLA.
| Returns | |
|---|---|
| Type | Description |
int |
|
hasPickupSla
clearPickupSla
setPickupSla
Item store pickup timeline. For more information, see Pickup SLA.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPickupCost
Optional. The pickup cost for an item when a customer buys it online and picks it up at a store.
| Returns | |
|---|---|
| Type | Description |
PickupCost|null |
|
hasPickupCost
clearPickupCost
setPickupCost
Optional. The pickup cost for an item when a customer buys it online and picks it up at a store.
| Parameter | |
|---|---|
| Name | Description |
var |
PickupCost
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLinkTemplate
Link template for business hosted local storefront.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasLinkTemplate
clearLinkTemplate
setLinkTemplate
Link template for business hosted local storefront.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMobileLinkTemplate
Link template for business hosted local storefront optimized for mobile devices.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasMobileLinkTemplate
clearMobileLinkTemplate
setMobileLinkTemplate
Link template for business 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.
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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| 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\RepeatedField<string> |
|
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 |
int |
|
hasPause
clearPause
setPause
Publication of this item will be temporarily paused.
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| 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\RepeatedField<string> |
|
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\RepeatedField<CloudExportAdditionalProperties> |
|
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\RepeatedField<ProductCertification> |
|
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<ProductCertification>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStructuredTitle
Structured title, for algorithmically (AI)-generated titles.
| Returns | |
|---|---|
| Type | Description |
StructuredTitle|null |
|
hasStructuredTitle
clearStructuredTitle
setStructuredTitle
Structured title, for algorithmically (AI)-generated titles.
| Parameter | |
|---|---|
| Name | Description |
var |
StructuredTitle
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
| Returns | |
|---|---|
| Type | Description |
StructuredDescription|null |
|
hasStructuredDescription
clearStructuredDescription
setStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
| Parameter | |
|---|---|
| Name | Description |
var |
StructuredDescription
|
| Returns | |
|---|---|
| Type | Description |
$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.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
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.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSustainabilityIncentives
The list of sustainability incentive programs.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductSustainabilityIncentive> |
|
setSustainabilityIncentives
The list of sustainability incentive programs.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductSustainabilityIncentive>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVideoLinks
Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the Help Center article for more information.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setVideoLinks
Optional. A list of video URLs for the item. Use this attribute to provide more visuals for your product beyond your image attributes. See the Help Center article for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMinimumOrderValues
The minimum value in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductMinimumOrderValue> |
|
setMinimumOrderValues
The minimum value in the cart before a customer can initiate checkout. Supports multiple minimum order values. Different minimum order values can be specified per country, service and surface. Maximum entries: 100.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductMinimumOrderValue>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVin
The Vehicle Identification Number (VIN) of the vehicle.
| Returns | |
|---|---|
| Type | Description |
string |
|
setVin
The Vehicle Identification Number (VIN) of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getModel
The Model of the
vehicle, such as LX, EX, and others.
| Returns | |
|---|---|
| Type | Description |
string |
|
setModel
The Model of the
vehicle, such as LX, EX, and others.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getTrim
The Trim of the
vehicle model, such as S, SV, SL and others.
| Returns | |
|---|---|
| Type | Description |
string |
|
setTrim
The Trim of the
vehicle model, such as S, SV, SL and others.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getBodyStyle
The body style of the vehicle.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type VehicleBodyStyle. |
setBodyStyle
The body style of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type VehicleBodyStyle. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getYear
The Year of the vehicle model.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
setYear
The Year of the vehicle model.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getMileage
The number of miles/kms on the vehicle. See the Mileage for more information.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\Mileage|null |
|
hasMileage
clearMileage
setMileage
The number of miles/kms on the vehicle. See the Mileage for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\Mileage
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getElectricRange
The electric range of the vehicle in miles/kms.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\Mileage|null |
|
hasElectricRange
clearElectricRange
setElectricRange
The electric range of the vehicle in miles/kms.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\Mileage
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFuelConsumption
The fuel consumption of the vehicle.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\FuelConsumption|null |
|
hasFuelConsumption
clearFuelConsumption
setFuelConsumption
The fuel consumption of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\FuelConsumption
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getFuelConsumptionDischargedBattery
The fuel consumption of the vehicle when the hybrid battery is discharged.
See the Help Center article for more information.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\FuelConsumption|null |
|
hasFuelConsumptionDischargedBattery
clearFuelConsumptionDischargedBattery
setFuelConsumptionDischargedBattery
The fuel consumption of the vehicle when the hybrid battery is discharged.
See the Help Center article for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\FuelConsumption
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEnergyConsumption
The energy consumption of the vehicle.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\EnergyConsumption|null |
|
hasEnergyConsumption
clearEnergyConsumption
setEnergyConsumption
The energy consumption of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\EnergyConsumption
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCo2Emissions
The co2 emission of the vehicle.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\Co2Emissions|null |
|
hasCo2Emissions
clearCo2Emissions
setCo2Emissions
The co2 emission of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\Co2Emissions
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDateFirstRegistered
The date the vehicle was first registered. Format: YYYY-MM. See the
Date first
registered for more
information.
| Returns | |
|---|---|
| Type | Description |
string |
|
setDateFirstRegistered
The date the vehicle was first registered. Format: YYYY-MM. See the
Date first
registered for more
information.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEngine
The engine type of the vehicle.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type EngineType. |
setEngine
The engine type of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type EngineType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getEmissionsStandard
The emission standard of the vehicle.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type EmissionsStandard. |
setEmissionsStandard
The emission standard of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type EmissionsStandard. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getCertifiedPreOwned
Whether the vehicle is OEM certified pre-owned.
| Returns | |
|---|---|
| Type | Description |
bool |
|
setCertifiedPreOwned
Whether the vehicle is OEM certified pre-owned.
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVehicleMsrp
The MSRP (Manufacturer Suggested Retail Price) for the vehicle in its current configuration. See the Vehicle MSRP for more information.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasVehicleMsrp
clearVehicleMsrp
setVehicleMsrp
The MSRP (Manufacturer Suggested Retail Price) for the vehicle in its current configuration. See the Vehicle MSRP for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVehicleAllInPrice
The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the Vehicle all-in price for more information.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasVehicleAllInPrice
clearVehicleAllInPrice
setVehicleAllInPrice
The all-in advertised price for a vehicle, which includes costs for the following – any accessories attached to the vehicle, environmental levies, extra warranty, fuel, freight, pre-delivery inspection (PDI), dealer fees for handling licensing, provincial regulatory fees, miscellaneous dealer charges for security etching and nitrogen tire fill, and factory-to-customer or dealer-to-customer discounts or incentives. See the Vehicle all-in price for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVehiclePriceType
The price type of the vehicle.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type VehiclePriceType. |
setVehiclePriceType
The price type of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type VehiclePriceType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVehicleMandatoryInspectionIncluded
Whether the vehicle is sold with mandatory inspection and maintenance performed before delivery. See the Vehicle mandatory inspection included for more information.`
| Returns | |
|---|---|
| Type | Description |
bool |
|
setVehicleMandatoryInspectionIncluded
Whether the vehicle is sold with mandatory inspection and maintenance performed before delivery. See the Vehicle mandatory inspection included for more information.`
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVehicleExpenses
The miscellaneous expenses like insurance and registration fees of the vehicle. See the Vehicle expenses for more information.
| Returns | |
|---|---|
| Type | Description |
Google\Shopping\Type\Price|null |
|
hasVehicleExpenses
clearVehicleExpenses
setVehicleExpenses
The miscellaneous expenses like insurance and registration fees of the vehicle. See the Vehicle expenses for more information.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Shopping\Type\Price
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getWarranty
The warranty of the vehicle.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\Warranty|null |
|
hasWarranty
clearWarranty
setWarranty
The warranty of the vehicle.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\Warranty
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDisplayAddress
The display address of the property.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\DisplayAddress|null |
|
hasDisplayAddress
clearDisplayAddress
setDisplayAddress
The display address of the property.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\DisplayAddress
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLatitude
The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasLatitude
clearLatitude
setLatitude
The latitude of the property. The value must be between -90 (inclusive) and 90 (inclusive), up to 6 decimal places.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getLongitude
The longitude of the property. The value must be between -180 (inclusive) and 180 (inclusive), up to 6 decimal places.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasLongitude
clearLongitude
setLongitude
The longitude of the property. The value must be between -180 (inclusive) and 180 (inclusive), up to 6 decimal places.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNeighborhood
The neighborhood (locality) of the property, such as Wallingford,
Greenwood, etc.
| Returns | |
|---|---|
| Type | Description |
string |
|
setNeighborhood
The neighborhood (locality) of the property, such as Wallingford,
Greenwood, etc.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUnitArea
The unit area of the property, such as 1000 sqft.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\UnitArea|null |
|
hasUnitArea
clearUnitArea
setUnitArea
The unit area of the property, such as 1000 sqft.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\UnitArea
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNumberOfUnits
The number of units available for a specific floor plan of the property.
The value must be greater than 0.
| Returns | |
|---|---|
| Type | Description |
int|string |
|
hasNumberOfUnits
clearNumberOfUnits
setNumberOfUnits
The number of units available for a specific floor plan of the property.
The value must be greater than 0.
| Parameter | |
|---|---|
| Name | Description |
var |
int|string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPropertyName
The name of the property.
| Returns | |
|---|---|
| Type | Description |
string |
|
setPropertyName
The name of the property.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNumberOfBedrooms
The number of bedrooms in the property. The value must be greater than or equal to 0 and a multiple of 1.0.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasNumberOfBedrooms
clearNumberOfBedrooms
setNumberOfBedrooms
The number of bedrooms in the property. The value must be greater than or equal to 0 and a multiple of 1.0.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getNumberOfBathrooms
The number of bathrooms in the property. The value must be greater than 0 and a multiple of 0.5.
| Returns | |
|---|---|
| Type | Description |
float |
|
hasNumberOfBathrooms
clearNumberOfBathrooms
setNumberOfBathrooms
The number of bathrooms in the property. The value must be greater than 0 and a multiple of 0.5.
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPropertyType
The type of property.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type PropertyType. |
setPropertyType
The type of property.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type PropertyType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getAmenityFeature
The amenity features for the property.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
setAmenityFeature
The amenity features for the property.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getUtilitiesIncluded
The utilities included for the property.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<int> |
|
setUtilitiesIncluded
The utilities included for the property.
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPetPolicy
The pet policy for the property.
| Returns | |
|---|---|
| Type | Description |
ProductAttributes\PetPolicy|null |
|
hasPetPolicy
clearPetPolicy
setPetPolicy
The pet policy for the property.
| Parameter | |
|---|---|
| Name | Description |
var |
ProductAttributes\PetPolicy
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getSpecialtyHousingType
The specialty housing type for the property.
| Returns | |
|---|---|
| Type | Description |
int |
Enum of type SpecialtyHousingType. |
setSpecialtyHousingType
The specialty housing type for the property.
| Parameter | |
|---|---|
| Name | Description |
var |
int
Enum of type SpecialtyHousingType. |
| Returns | |
|---|---|
| Type | Description |
$this |
|
getProductFee
The product fee for the property.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductAttributes\ProductFee> |
|
setProductFee
The product fee for the property.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductAttributes\ProductFee>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getShortTitle
The short title of the item.
| Returns | |
|---|---|
| Type | Description |
string |
|
hasShortTitle
clearShortTitle
setShortTitle
The short title of the item.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getQuestionsAndAnswers
Optional. Contains user-, merchant-, and manufacturer-authored questions and answers about the product. Max 30 question and answer pairs. Max 10000 characters total.
Each question can have max 1000 characters. Each answer can have max 1000 characters.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductAttributes\QuestionAndAnswer> |
|
setQuestionsAndAnswers
Optional. Contains user-, merchant-, and manufacturer-authored questions and answers about the product. Max 30 question and answer pairs. Max 10000 characters total.
Each question can have max 1000 characters. Each answer can have max 1000 characters.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductAttributes\QuestionAndAnswer>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getPopularityRank
Optional. Indicates the popularity of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
| Returns | |
|---|---|
| Type | Description |
float |
|
setPopularityRank
Optional. Indicates the popularity of the product in a merchant's inventory. Using a scale of 0.0 (lowest) to 100.0 (highest).
| Parameter | |
|---|---|
| Name | Description |
var |
float
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getItemGroupTitle
Optional. Represents the title of the product group to which this variant product belongs. This can be used along with the item group id attribute.
It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
| Returns | |
|---|---|
| Type | Description |
string |
|
setItemGroupTitle
Optional. Represents the title of the product group to which this variant product belongs. This can be used along with the item group id attribute.
It lets you perform better grouping of variant products, and helps identifying common product characteristics more efficiently.
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getDocumentLinks
Optional. Contains a list of PDF document URLs for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<string> |
|
setDocumentLinks
Optional. Contains a list of PDF document URLs for the product. Examples are training manuals, user guides, assembly instructions, package inserts, etc. Must start with "http://" or "https://"), ASCII characters only, and RFC 3986 compliant.
| Parameter | |
|---|---|
| Name | Description |
var |
string[]
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getVariantOptions
Optional. Contains the list of all variant-identifying options of this product.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductAttributes\VariantOption> |
|
setVariantOptions
Optional. Contains the list of all variant-identifying options of this product.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductAttributes\VariantOption>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|
getRelatedProducts
Optional. Specifies how other products are related to this product.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\RepeatedField<ProductAttributes\RelatedProduct> |
|
setRelatedProducts
Optional. Specifies how other products are related to this product.
| Parameter | |
|---|---|
| Name | Description |
var |
array<ProductAttributes\RelatedProduct>
|
| Returns | |
|---|---|
| Type | Description |
$this |
|