Class: Google::Shopping::Merchant::Products::V1beta::Attributes
- Inherits:
-
Object
- Object
- Google::Shopping::Merchant::Products::V1beta::Attributes
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/shopping/merchant/products/v1beta/products_common.rb
Overview
Attributes.
Instance Attribute Summary collapse
-
#additional_image_links ⇒ ::Array<::String>
Additional URLs of images of the item.
-
#ads_grouping ⇒ ::String
Used to group items in an arbitrary way.
-
#ads_labels ⇒ ::Array<::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.
-
#adult ⇒ ::Boolean
Set to true if the item is targeted towards adults.
-
#age_group ⇒ ::String
Target age group of the item.
-
#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.
-
#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.
-
#canonical_link ⇒ ::String
URL for the canonical version of your item's landing page.
-
#certifications ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::Certification>
Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database.
-
#cloud_export_additional_properties ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::CloudExportAdditionalProperties>
Extra fields to export to the Cloud Retail program.
-
#color ⇒ ::String
Color of the item.
-
#condition ⇒ ::String
Condition or state of the item.
-
#cost_of_goods_sold ⇒ ::Google::Shopping::Type::Price
Cost of goods sold.
-
#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.
-
#description ⇒ ::String
Description of the item.
-
#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.
-
#display_ads_id ⇒ ::String
An identifier for an item for dynamic remarketing campaigns.
-
#display_ads_link ⇒ ::String
URL directly to your item's landing page for dynamic remarketing campaigns.
-
#display_ads_similar_ids ⇒ ::Array<::String>
Advertiser-specified recommendations.
-
#display_ads_title ⇒ ::String
Title of an item for dynamic remarketing campaigns.
-
#display_ads_value ⇒ ::Float
Offer margin for dynamic remarketing campaigns.
-
#energy_efficiency_class ⇒ ::String
The energy efficiency class as defined in EU directive 2010/30/EU.
-
#excluded_destinations ⇒ ::Array<::String>
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
-
#expiration_date ⇒ ::Google::Protobuf::Timestamp
Date on which the item should expire, as specified upon insertion, in ISO 8601 format.
-
#external_seller_id ⇒ ::String
Required for multi-seller accounts.
-
#free_shipping_threshold ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::FreeShippingThreshold>
Conditions to be met for a product to have free shipping.
-
#gender ⇒ ::String
Target gender of the item.
-
#google_product_category ⇒ ::String
Google's category of the item (see Google product taxonomy).
-
#gtin ⇒ ::Array<::String>
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#gtins ⇒ ::Array<::String>
Global Trade Item Numbers (GTIN) of the item.
-
#identifier_exists ⇒ ::Boolean
Set this value to false when the item does not have unique product identifiers appropriate to its category, such as GTIN, MPN, and brand.
-
#image_link ⇒ ::String
URL of an image of the item.
-
#included_destinations ⇒ ::Array<::String>
The list of destinations to include for this target (corresponds to checked check boxes in Merchant Center).
-
#installment ⇒ ::Google::Shopping::Merchant::Products::V1beta::Installment
Number and amount of installments to pay for an item.
-
#is_bundle ⇒ ::Boolean
Whether the item is a business-defined sub-API.
-
#item_group_id ⇒ ::String
Shared identifier for all variants of the same product.
-
#lifestyle_image_links ⇒ ::Array<::String>
Additional URLs of lifestyle images of the item, used to explicitly identify images that showcase your item in a real-world context.
-
#link ⇒ ::String
URL directly linking to your item's page on your online store.
-
#link_template ⇒ ::String
Link template for business hosted local storefront.
-
#loyalty_points ⇒ ::Google::Shopping::Merchant::Products::V1beta::LoyaltyPoints
Loyalty points that users receive after purchasing the item.
-
#loyalty_programs ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::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.
-
#material ⇒ ::String
The material of which the item is made.
-
#max_energy_efficiency_class ⇒ ::String
The energy efficiency class as defined in EU directive 2010/30/EU.
-
#max_handling_time ⇒ ::Integer
Maximal product handling time (in business days).
-
#maximum_retail_price ⇒ ::Google::Shopping::Type::Price
Maximum retail price (MRP) of the item.
-
#min_energy_efficiency_class ⇒ ::String
The energy efficiency class as defined in EU directive 2010/30/EU.
-
#min_handling_time ⇒ ::Integer
Minimal product handling time (in business days).
-
#mobile_link ⇒ ::String
URL for the mobile-optimized version of your item's landing page.
-
#mobile_link_template ⇒ ::String
Link template for business hosted local storefront optimized for mobile devices.
-
#mpn ⇒ ::String
Manufacturer Part Number (MPN) of the item.
-
#multipack ⇒ ::Integer
The number of identical products in a business-defined multipack.
-
#pattern ⇒ ::String
The item's pattern.
-
#pause ⇒ ::String
Publication of this item will be temporarily paused.
-
#pickup_method ⇒ ::String
The pickup option for the item.
-
#pickup_sla ⇒ ::String
Item store pickup timeline.
-
#price ⇒ ::Google::Shopping::Type::Price
Price of the item.
-
#product_details ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::ProductDetail>
Technical specification or additional product details.
-
#product_height ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductDimension
The height of the product in the units provided.
-
#product_highlights ⇒ ::Array<::String>
Bullet points describing the most relevant product highlights.
-
#product_length ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductDimension
The length of the product in the units provided.
-
#product_types ⇒ ::Array<::String>
Categories of the item (formatted as in product data specification).
-
#product_weight ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductWeight
The weight of the product in the units provided.
-
#product_width ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductDimension
The width of the product in the units provided.
-
#promotion_ids ⇒ ::Array<::String>
The unique ID of a promotion.
-
#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 ⇒ ::Integer
The quantity of the product that is available for selling on Google.
-
#shipping ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::Shipping>
Shipping rules.
-
#shipping_height ⇒ ::Google::Shopping::Merchant::Products::V1beta::ShippingDimension
Height of the item for shipping.
-
#shipping_label ⇒ ::String
The shipping label of the product, used to group product in account-level shipping rules.
-
#shipping_length ⇒ ::Google::Shopping::Merchant::Products::V1beta::ShippingDimension
Length of the item for shipping.
-
#shipping_weight ⇒ ::Google::Shopping::Merchant::Products::V1beta::ShippingWeight
Weight of the item for shipping.
-
#shipping_width ⇒ ::Google::Shopping::Merchant::Products::V1beta::ShippingDimension
Width of the item for shipping.
-
#shopping_ads_excluded_countries ⇒ ::Array<::String>
List of country codes (ISO 3166-1 alpha-2) to exclude the offer from Shopping Ads destination.
-
#size ⇒ ::String
Size of the item.
-
#size_system ⇒ ::String
System in which the size is specified.
-
#size_types ⇒ ::Array<::String>
The cut of the item.
-
#structured_description ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
-
#structured_title ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductStructuredTitle
Structured title, for algorithmically (AI)-generated titles.
-
#subscription_cost ⇒ ::Google::Shopping::Merchant::Products::V1beta::SubscriptionCost
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
-
#sustainability_incentives ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::ProductSustainabilityIncentive>
The list of sustainability incentive programs.
-
#tax_category ⇒ ::String
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#taxes ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::Tax>
deprecated
Deprecated.
This field is deprecated and may be removed in the next major version update.
-
#title ⇒ ::String
Title of the item.
-
#transit_time_label ⇒ ::String
The transit time label of the product, used to group product in account-level transit time tables.
-
#unit_pricing_base_measure ⇒ ::Google::Shopping::Merchant::Products::V1beta::UnitPricingBaseMeasure
The preference of the denominator of the unit price.
-
#unit_pricing_measure ⇒ ::Google::Shopping::Merchant::Products::V1beta::UnitPricingMeasure
The measure and dimension of an item.
-
#virtual_model_link ⇒ ::String
URL of the 3D image of the item.
Instance Attribute Details
#additional_image_links ⇒ ::Array<::String>
Returns Additional URLs of images of the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#ads_grouping ⇒ ::String
Returns Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise. For more information, see Display ads attribute.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#ads_labels ⇒ ::Array<::String>
Returns Similar to ads_grouping, but only works on CPC.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#ads_redirect ⇒ ::String
Returns Allows advertisers to override the item URL when the product is shown within the context of Product ads.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#adult ⇒ ::Boolean
Returns Set to true if the item is targeted towards adults.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#age_group ⇒ ::String
Returns Target age group of the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#auto_pricing_min_price ⇒ ::Google::Shopping::Type::Price
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#availability ⇒ ::String
Returns Availability status of the item. For example, "in_stock" or "out_of_stock".
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#availability_date ⇒ ::Google::Protobuf::Timestamp
Returns The day a pre-ordered product becomes available for delivery, in ISO 8601 format.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#brand ⇒ ::String
Returns Brand of the item. For example, "Google".
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#canonical_link ⇒ ::String
Returns URL for the canonical version of your item's landing page.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#certifications ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::Certification>
Returns Product Certifications, for example for energy efficiency labeling of products recorded in the EU EPREL database. See the Help Center article for more information.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#cloud_export_additional_properties ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::CloudExportAdditionalProperties>
Returns Extra fields to export to the Cloud Retail program.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#color ⇒ ::String
Returns Color of the item. For example, "red".
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#condition ⇒ ::String
Returns Condition or state of the item. For example, "new" or "used".
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#cost_of_goods_sold ⇒ ::Google::Shopping::Type::Price
Returns Cost of goods sold. Used for gross profit reporting.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#custom_label_0 ⇒ ::String
Returns Custom label 0 for custom grouping of items in a Shopping campaign.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#custom_label_1 ⇒ ::String
Returns Custom label 1 for custom grouping of items in a Shopping campaign.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#custom_label_2 ⇒ ::String
Returns Custom label 2 for custom grouping of items in a Shopping campaign.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#custom_label_3 ⇒ ::String
Returns Custom label 3 for custom grouping of items in a Shopping campaign.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#custom_label_4 ⇒ ::String
Returns Custom label 4 for custom grouping of items in a Shopping campaign.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#description ⇒ ::String
Returns Description of the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#disclosure_date ⇒ ::Google::Protobuf::Timestamp
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#display_ads_id ⇒ ::String
Returns An identifier for an item for dynamic remarketing campaigns.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#display_ads_link ⇒ ::String
Returns URL directly to your item's landing page for dynamic remarketing campaigns.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#display_ads_similar_ids ⇒ ::Array<::String>
Returns Advertiser-specified recommendations. For more information, see Display ads attribute specification.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#display_ads_title ⇒ ::String
Returns Title of an item for dynamic remarketing campaigns.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#display_ads_value ⇒ ::Float
Returns Offer margin for dynamic remarketing campaigns. For more information, see Display ads attribute.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#energy_efficiency_class ⇒ ::String
Returns The energy efficiency class as defined in EU directive 2010/30/EU.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#excluded_destinations ⇒ ::Array<::String>
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#expiration_date ⇒ ::Google::Protobuf::Timestamp
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#external_seller_id ⇒ ::String
Returns Required for multi-seller accounts. Use this attribute if you're a marketplace uploading products for various sellers to your multi-seller account.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#free_shipping_threshold ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::FreeShippingThreshold>
Returns Conditions to be met for a product to have free shipping.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#gender ⇒ ::String
Returns Target gender of the item. For example, "male" or "female".
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#google_product_category ⇒ ::String
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#gtin ⇒ ::Array<::String>
This field is deprecated and may be removed in the next major version update.
Returns Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
Deprecated: Use gtins instead.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#gtins ⇒ ::Array<::String>
Returns Global Trade Item Numbers (GTIN) of the item. You can provide up to 10 GTINs.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#identifier_exists ⇒ ::Boolean
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#image_link ⇒ ::String
Returns URL of an image of the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#included_destinations ⇒ ::Array<::String>
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#installment ⇒ ::Google::Shopping::Merchant::Products::V1beta::Installment
Returns Number and amount of installments to pay for an item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#is_bundle ⇒ ::Boolean
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#item_group_id ⇒ ::String
Returns Shared identifier for all variants of the same product.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#lifestyle_image_links ⇒ ::Array<::String>
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#link ⇒ ::String
Returns URL directly linking to your item's page on your online store.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#link_template ⇒ ::String
Returns Link template for business hosted local storefront.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#loyalty_points ⇒ ::Google::Shopping::Merchant::Products::V1beta::LoyaltyPoints
Returns Loyalty points that users receive after purchasing the item. Japan only.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#loyalty_programs ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::LoyaltyProgram>
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#material ⇒ ::String
Returns The material of which the item is made. For example, "Leather" or "Cotton".
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#max_energy_efficiency_class ⇒ ::String
Returns The energy efficiency class as defined in EU directive 2010/30/EU.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#max_handling_time ⇒ ::Integer
Returns Maximal product handling time (in business days).
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#maximum_retail_price ⇒ ::Google::Shopping::Type::Price
Returns Maximum retail price (MRP) of the item. Applicable to India only.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#min_energy_efficiency_class ⇒ ::String
Returns The energy efficiency class as defined in EU directive 2010/30/EU.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#min_handling_time ⇒ ::Integer
Returns Minimal product handling time (in business days).
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#mobile_link ⇒ ::String
Returns URL for the mobile-optimized version of your item's landing page.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#mobile_link_template ⇒ ::String
Returns Link template for business hosted local storefront optimized for mobile devices.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#mpn ⇒ ::String
Returns Manufacturer Part Number (MPN) of the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#multipack ⇒ ::Integer
Returns The number of identical products in a business-defined multipack.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#pattern ⇒ ::String
Returns The item's pattern. For example, polka dots.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#pause ⇒ ::String
Returns Publication of this item will be temporarily paused.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#pickup_method ⇒ ::String
Returns The pickup option for the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#pickup_sla ⇒ ::String
Returns Item store pickup timeline. For more information, see Pickup SLA.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#price ⇒ ::Google::Shopping::Type::Price
Returns Price of the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#product_details ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::ProductDetail>
Returns Technical specification or additional product details.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#product_height ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductDimension
Returns The height of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#product_highlights ⇒ ::Array<::String>
Returns Bullet points describing the most relevant product highlights.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#product_length ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductDimension
Returns The length of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#product_types ⇒ ::Array<::String>
Returns Categories of the item (formatted as in product data specification).
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#product_weight ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductWeight
Returns The weight of the product in the units provided. The value must be between 0 (exclusive) and 2000 (inclusive).
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#product_width ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductDimension
Returns The width of the product in the units provided. The value must be between 0 (exclusive) and 3000 (inclusive).
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#promotion_ids ⇒ ::Array<::String>
Returns The unique ID of a promotion.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#sale_price ⇒ ::Google::Shopping::Type::Price
Returns Advertised sale price of the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#sale_price_effective_date ⇒ ::Google::Type::Interval
Returns Date range during which the item is on sale, see product data specification.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#sell_on_google_quantity ⇒ ::Integer
Returns The quantity of the product that is available for selling on Google. Supported only for online products.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#shipping ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::Shipping>
Returns Shipping rules.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#shipping_height ⇒ ::Google::Shopping::Merchant::Products::V1beta::ShippingDimension
Returns Height of the item for shipping.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#shipping_label ⇒ ::String
Returns The shipping label of the product, used to group product in account-level shipping rules.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#shipping_length ⇒ ::Google::Shopping::Merchant::Products::V1beta::ShippingDimension
Returns Length of the item for shipping.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#shipping_weight ⇒ ::Google::Shopping::Merchant::Products::V1beta::ShippingWeight
Returns Weight of the item for shipping.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#shipping_width ⇒ ::Google::Shopping::Merchant::Products::V1beta::ShippingDimension
Returns Width of the item for shipping.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#shopping_ads_excluded_countries ⇒ ::Array<::String>
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#size ⇒ ::String
Returns 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.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#size_system ⇒ ::String
Returns System in which the size is specified. Recommended for apparel items. For example, "US", "UK", "DE". For more information, see Size system.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#size_types ⇒ ::Array<::String>
Returns The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided, see Size type. For example, "petite", "plus size".
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#structured_description ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductStructuredDescription
Returns Structured description, for algorithmically (AI)-generated descriptions.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#structured_title ⇒ ::Google::Shopping::Merchant::Products::V1beta::ProductStructuredTitle
Returns Structured title, for algorithmically (AI)-generated titles.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#subscription_cost ⇒ ::Google::Shopping::Merchant::Products::V1beta::SubscriptionCost
Returns Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#sustainability_incentives ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::ProductSustainabilityIncentive>
Returns The list of sustainability incentive programs.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#tax_category ⇒ ::String
This field is deprecated and may be removed in the next major version update.
Returns The tax category of the product.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#taxes ⇒ ::Array<::Google::Shopping::Merchant::Products::V1beta::Tax>
This field is deprecated and may be removed in the next major version update.
Returns Tax information.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#title ⇒ ::String
Returns Title of the item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#transit_time_label ⇒ ::String
Returns The transit time label of the product, used to group product in account-level transit time tables.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#unit_pricing_base_measure ⇒ ::Google::Shopping::Merchant::Products::V1beta::UnitPricingBaseMeasure
Returns The preference of the denominator of the unit price.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#unit_pricing_measure ⇒ ::Google::Shopping::Merchant::Products::V1beta::UnitPricingMeasure
Returns The measure and dimension of an item.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |
#virtual_model_link ⇒ ::String
Returns URL of the 3D image of the item. See the Help Center article for more information.
430 431 432 433 |
# File 'proto_docs/google/shopping/merchant/products/v1beta/products_common.rb', line 430 class Attributes include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end |