Class: Google::Apis::ContentV2_1::Product
- Inherits:
-
Object
- Object
- Google::Apis::ContentV2_1::Product
- Includes:
- Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
- Defined in:
- lib/google/apis/content_v2_1/classes.rb,
lib/google/apis/content_v2_1/representations.rb,
lib/google/apis/content_v2_1/representations.rb
Overview
Required product attributes are primarily defined by the product data specification. See the Product Data Specification Help Center article for information. Product data. After inserting, updating, or deleting a product, it may take several minutes before changes take effect.
Instance Attribute Summary collapse
-
#additional_image_links ⇒ Array<String>
Additional URLs of images of the item.
-
#additional_size_type ⇒ String
Additional cut 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
(also: #adult?)
Should be set to true if the item is targeted towards adults.
-
#age_group ⇒ String
Target age group of the item.
-
#auto_pricing_min_price ⇒ Google::Apis::ContentV2_1::Price
A safeguard in the Automated Discounts and Dynamic Promotions projects, ensuring that discounts on merchants' offers do not fall below this value, thereby preserving the offer's value and profitability.
-
#availability ⇒ String
Availability status of the item.
-
#availability_date ⇒ String
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::Apis::ContentV2_1::ProductCertification>
Product certification, introduced for EU energy efficiency labeling compliance using the EU EPREL database.
-
#channel ⇒ String
Required.
-
#cloud_export_additional_properties ⇒ Array<Google::Apis::ContentV2_1::CloudExportAdditionalProperties>
Extra fields to export to the Cloud Retail program.
-
#color ⇒ String
Color of the item.
-
#condition ⇒ String
Condition or state of the item.
-
#content_language ⇒ String
Required.
-
#cost_of_goods_sold ⇒ Google::Apis::ContentV2_1::Price
Cost of goods sold.
-
#custom_attributes ⇒ Array<Google::Apis::ContentV2_1::CustomAttribute>
A list of custom (merchant-provided) attributes.
-
#custom_label0 ⇒ String
Custom label 0 for custom grouping of items in a Shopping campaign.
-
#custom_label1 ⇒ String
Custom label 1 for custom grouping of items in a Shopping campaign.
-
#custom_label2 ⇒ String
Custom label 2 for custom grouping of items in a Shopping campaign.
-
#custom_label3 ⇒ String
Custom label 3 for custom grouping of items in a Shopping campaign.
-
#custom_label4 ⇒ String
Custom label 4 for custom grouping of items in a Shopping campaign.
-
#description ⇒ String
Description of the item.
-
#disclosure_date ⇒ String
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 cleared check boxes in Merchant Center).
-
#expiration_date ⇒ String
Date on which the item should expire, as specified upon insertion, in ISO 8601 format.
-
#external_seller_id ⇒ String
Required for multi-seller accounts.
-
#feed_label ⇒ String
Feed label for the item.
-
#free_shipping_threshold ⇒ Array<Google::Apis::ContentV2_1::FreeShippingThreshold>
Optional.
-
#gender ⇒ String
Target gender of the item.
-
#google_product_category ⇒ String
Google's category of the item (see Google product taxonomy).
-
#gtin ⇒ String
Global Trade Item Number (GTIN) of the item.
-
#id ⇒ String
The REST ID of the product.
-
#identifier_exists ⇒ Boolean
(also: #identifier_exists?)
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::Apis::ContentV2_1::Installment
Details of a monthly installment payment offering.
-
#is_bundle ⇒ Boolean
(also: #is_bundle?)
Whether the item is a merchant-defined bundle.
-
#item_group_id ⇒ String
Shared identifier for all variants of the same product.
-
#kind ⇒ String
Identifies what kind of resource this is.
-
#lifestyle_image_links ⇒ Array<String>
Additional URLs of lifestyle images of the item.
-
#link ⇒ String
URL directly linking to your item's page on your website.
-
#link_template ⇒ String
URL template for merchant hosted local storefront.
-
#loyalty_program ⇒ Google::Apis::ContentV2_1::LoyaltyProgram
Allows the setting up of loyalty program benefits (for example price or points) .
-
#loyalty_programs ⇒ Array<Google::Apis::ContentV2_1::LoyaltyProgram>
Optional.
-
#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 ⇒ Fixnum
Maximal product handling time (in business days).
-
#min_energy_efficiency_class ⇒ String
The energy efficiency class as defined in EU directive 2010/30/EU.
-
#min_handling_time ⇒ Fixnum
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
URL template for merchant hosted local storefront optimized for mobile devices.
-
#mpn ⇒ String
Manufacturer Part Number (MPN) of the item.
-
#multipack ⇒ Fixnum
The number of identical products in a merchant-defined multipack.
-
#offer_id ⇒ String
Required.
-
#pattern ⇒ String
The item's pattern (for example, polka dots).
-
#pause ⇒ String
Publication of this item should be temporarily paused.
-
#pickup_method ⇒ String
The pick up option for the item.
-
#pickup_sla ⇒ String
Item store pickup timeline.
-
#price ⇒ Google::Apis::ContentV2_1::Price
Price of the item.
-
#product_details ⇒ Array<Google::Apis::ContentV2_1::ProductProductDetail>
Technical specification or additional product details.
-
#product_height ⇒ Google::Apis::ContentV2_1::ProductDimension
The height of the product in the units provided.
-
#product_highlights ⇒ Array<String>
Bullet points describing the most relevant highlights of a product.
-
#product_length ⇒ Google::Apis::ContentV2_1::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::Apis::ContentV2_1::ProductWeight
The weight of the product in the units provided.
-
#product_width ⇒ Google::Apis::ContentV2_1::ProductDimension
The width of the product in the units provided.
-
#promotion_ids ⇒ Array<String>
The unique ID of a promotion.
-
#sale_price ⇒ Google::Apis::ContentV2_1::Price
Advertised sale price of the item.
-
#sale_price_effective_date ⇒ String
Date range during which the item is on sale (see product data specification ).
-
#sell_on_google_quantity ⇒ Fixnum
The quantity of the product that is available for selling on Google.
-
#shipping ⇒ Array<Google::Apis::ContentV2_1::ProductShipping>
Shipping rules.
-
#shipping_height ⇒ Google::Apis::ContentV2_1::ProductShippingDimension
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::Apis::ContentV2_1::ProductShippingDimension
Length of the item for shipping.
-
#shipping_weight ⇒ Google::Apis::ContentV2_1::ProductShippingWeight
Weight of the item for shipping.
-
#shipping_width ⇒ Google::Apis::ContentV2_1::ProductShippingDimension
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_system ⇒ String
System in which the size is specified.
-
#size_type ⇒ String
The cut of the item.
-
#sizes ⇒ Array<String>
Size of the item.
-
#source ⇒ String
Output only.
-
#structured_description ⇒ Google::Apis::ContentV2_1::ProductStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions.
-
#structured_title ⇒ Google::Apis::ContentV2_1::ProductStructuredTitle
Structured title, for algorithmically (AI)-generated titles.
-
#subscription_cost ⇒ Google::Apis::ContentV2_1::ProductSubscriptionCost
Number of periods (months or years) and amount of payment per period for an item with an associated subscription contract.
-
#target_country ⇒ String
Required.
-
#tax_category ⇒ String
The tax category of the product, used to configure detailed tax nexus in account-level tax settings.
-
#taxes ⇒ Array<Google::Apis::ContentV2_1::ProductTax>
Tax information.
-
#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::Apis::ContentV2_1::ProductUnitPricingBaseMeasure
The preference of the denominator of the unit price.
-
#unit_pricing_measure ⇒ Google::Apis::ContentV2_1::ProductUnitPricingMeasure
The measure and dimension of an item.
-
#virtual_model_link ⇒ String
URL of the 3D model of the item to provide more visuals.
Instance Method Summary collapse
-
#initialize(**args) ⇒ Product
constructor
A new instance of Product.
-
#update!(**args) ⇒ Object
Update properties of this object.
Constructor Details
#initialize(**args) ⇒ Product
Returns a new instance of Product.
9207 9208 9209 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9207 def initialize(**args) update!(**args) end |
Instance Attribute Details
#additional_image_links ⇒ Array<String>
Additional URLs of images of the item.
Corresponds to the JSON property additionalImageLinks
8628 8629 8630 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8628 def additional_image_links @additional_image_links end |
#additional_size_type ⇒ String
Additional cut of the item. Used together with size_type to represent combined
size types for apparel items.
Corresponds to the JSON property additionalSizeType
8634 8635 8636 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8634 def additional_size_type @additional_size_type end |
#ads_grouping ⇒ String
Used to group items in an arbitrary way. Only for CPA%, discouraged otherwise.
Corresponds to the JSON property adsGrouping
8639 8640 8641 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8639 def ads_grouping @ads_grouping end |
#ads_labels ⇒ Array<String>
Similar to ads_grouping, but only works on CPC.
Corresponds to the JSON property adsLabels
8644 8645 8646 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8644 def ads_labels @ads_labels end |
#ads_redirect ⇒ String
Allows advertisers to override the item URL when the product is shown within
the context of Product Ads.
Corresponds to the JSON property adsRedirect
8650 8651 8652 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8650 def ads_redirect @ads_redirect end |
#adult ⇒ Boolean Also known as: adult?
Should be set to true if the item is targeted towards adults.
Corresponds to the JSON property adult
8655 8656 8657 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8655 def adult @adult end |
#age_group ⇒ String
Target age group of the item.
Corresponds to the JSON property ageGroup
8661 8662 8663 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8661 def age_group @age_group end |
#auto_pricing_min_price ⇒ Google::Apis::ContentV2_1::Price
A safeguard in the Automated Discounts and Dynamic Promotions projects, ensuring that discounts on merchants' offers do not fall
below this value, thereby preserving the offer's value and profitability.
Corresponds to the JSON property autoPricingMinPrice
8669 8670 8671 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8669 def auto_pricing_min_price @auto_pricing_min_price end |
#availability ⇒ String
Availability status of the item.
Corresponds to the JSON property availability
8674 8675 8676 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8674 def availability @availability end |
#availability_date ⇒ String
The day a pre-ordered product becomes available for delivery, in ISO 8601
format.
Corresponds to the JSON property availabilityDate
8680 8681 8682 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8680 def availability_date @availability_date end |
#brand ⇒ String
Brand of the item.
Corresponds to the JSON property brand
8685 8686 8687 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8685 def brand @brand end |
#canonical_link ⇒ String
URL for the canonical version of your item's landing page.
Corresponds to the JSON property canonicalLink
8690 8691 8692 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8690 def canonical_link @canonical_link end |
#certifications ⇒ Array<Google::Apis::ContentV2_1::ProductCertification>
Product certification,
introduced for EU energy efficiency labeling compliance using the EU EPREL database.
Corresponds to the JSON property certifications
8697 8698 8699 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8697 def certifications @certifications end |
#channel ⇒ String
Required. The item's channel (online or local). Acceptable values are: - "
local
" - "online
"
Corresponds to the JSON property channel
8703 8704 8705 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8703 def channel @channel end |
#cloud_export_additional_properties ⇒ Array<Google::Apis::ContentV2_1::CloudExportAdditionalProperties>
Extra fields to export to the Cloud Retail program.
Corresponds to the JSON property cloudExportAdditionalProperties
8708 8709 8710 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8708 def cloud_export_additional_properties @cloud_export_additional_properties end |
#color ⇒ String
Color of the item.
Corresponds to the JSON property color
8713 8714 8715 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8713 def color @color end |
#condition ⇒ String
Condition or state of the item.
Corresponds to the JSON property condition
8718 8719 8720 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8718 def condition @condition end |
#content_language ⇒ String
Required. The two-letter ISO 639-1 language code for the item.
Corresponds to the JSON property contentLanguage
8723 8724 8725 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8723 def content_language @content_language end |
#cost_of_goods_sold ⇒ Google::Apis::ContentV2_1::Price
Cost of goods sold. Used for gross profit reporting.
Corresponds to the JSON property costOfGoodsSold
8728 8729 8730 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8728 def cost_of_goods_sold @cost_of_goods_sold end |
#custom_attributes ⇒ Array<Google::Apis::ContentV2_1::CustomAttribute>
A list of custom (merchant-provided) attributes. It can also be used for
submitting any attribute of the feed specification in its generic form (for
example, "name": "size type", "value": "regular"
). This is useful for
submitting attributes not explicitly exposed by the API, such as additional
attributes used for Buy on Google (formerly known as Shopping Actions).
Corresponds to the JSON property customAttributes
8737 8738 8739 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8737 def custom_attributes @custom_attributes end |
#custom_label0 ⇒ String
Custom label 0 for custom grouping of items in a Shopping campaign.
Corresponds to the JSON property customLabel0
8742 8743 8744 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8742 def custom_label0 @custom_label0 end |
#custom_label1 ⇒ String
Custom label 1 for custom grouping of items in a Shopping campaign.
Corresponds to the JSON property customLabel1
8747 8748 8749 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8747 def custom_label1 @custom_label1 end |
#custom_label2 ⇒ String
Custom label 2 for custom grouping of items in a Shopping campaign.
Corresponds to the JSON property customLabel2
8752 8753 8754 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8752 def custom_label2 @custom_label2 end |
#custom_label3 ⇒ String
Custom label 3 for custom grouping of items in a Shopping campaign.
Corresponds to the JSON property customLabel3
8757 8758 8759 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8757 def custom_label3 @custom_label3 end |
#custom_label4 ⇒ String
Custom label 4 for custom grouping of items in a Shopping campaign.
Corresponds to the JSON property customLabel4
8762 8763 8764 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8762 def custom_label4 @custom_label4 end |
#description ⇒ String
Description of the item.
Corresponds to the JSON property description
8767 8768 8769 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8767 def description @description end |
#disclosure_date ⇒ String
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.
Corresponds to the JSON property disclosureDate
8775 8776 8777 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8775 def disclosure_date @disclosure_date end |
#display_ads_id ⇒ String
An identifier for an item for dynamic remarketing campaigns.
Corresponds to the JSON property displayAdsId
8780 8781 8782 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8780 def display_ads_id @display_ads_id end |
#display_ads_link ⇒ String
URL directly to your item's landing page for dynamic remarketing campaigns.
Corresponds to the JSON property displayAdsLink
8785 8786 8787 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8785 def display_ads_link @display_ads_link end |
#display_ads_similar_ids ⇒ Array<String>
Advertiser-specified recommendations.
Corresponds to the JSON property displayAdsSimilarIds
8790 8791 8792 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8790 def display_ads_similar_ids @display_ads_similar_ids end |
#display_ads_title ⇒ String
Title of an item for dynamic remarketing campaigns.
Corresponds to the JSON property displayAdsTitle
8795 8796 8797 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8795 def display_ads_title @display_ads_title end |
#display_ads_value ⇒ Float
Offer margin for dynamic remarketing campaigns.
Corresponds to the JSON property displayAdsValue
8800 8801 8802 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8800 def display_ads_value @display_ads_value end |
#energy_efficiency_class ⇒ String
The energy efficiency class as defined in EU directive 2010/30/EU.
Corresponds to the JSON property energyEfficiencyClass
8805 8806 8807 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8805 def energy_efficiency_class @energy_efficiency_class end |
#excluded_destinations ⇒ Array<String>
The list of destinations to exclude for this target (corresponds to cleared check boxes in Merchant
Center). Products that are excluded from all destinations for more than 7 days
are automatically deleted.
Corresponds to the JSON property excludedDestinations
8813 8814 8815 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8813 def excluded_destinations @excluded_destinations end |
#expiration_date ⇒ String
Date on which the item should expire, as specified upon insertion, in ISO 8601
format. The actual expiration date in Google Shopping is exposed in
productstatuses
as googleExpirationDate
and might be earlier if
expirationDate
is too far in the future.
Corresponds to the JSON property expirationDate
8821 8822 8823 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8821 def expiration_date @expiration_date end |
#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.
Corresponds to the JSON property externalSellerId
8827 8828 8829 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8827 def external_seller_id @external_seller_id end |
#feed_label ⇒ String
Feed label for the item. Either targetCountry
or feedLabel
is required.
Must be less than or equal to 20 uppercase letters (A-Z), numbers (0-9), and
dashes (-).
Corresponds to the JSON property feedLabel
8834 8835 8836 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8834 def feed_label @feed_label end |
#free_shipping_threshold ⇒ Array<Google::Apis::ContentV2_1::FreeShippingThreshold>
Optional. Conditions to be met for a product to have free shipping.
Corresponds to the JSON property freeShippingThreshold
8839 8840 8841 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8839 def free_shipping_threshold @free_shipping_threshold end |
#gender ⇒ String
Target gender of the item.
Corresponds to the JSON property gender
8844 8845 8846 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8844 def gender @gender end |
#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.
Corresponds to the JSON property googleProductCategory
8852 8853 8854 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8852 def google_product_category @google_product_category end |
#gtin ⇒ String
Global Trade Item Number (GTIN) of the item.
Corresponds to the JSON property gtin
8857 8858 8859 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8857 def gtin @gtin end |
#id ⇒ String
The REST ID of the product. Content API methods that operate on products take
this as their productId
parameter. The REST ID for a product has one of the
2 forms channel:contentLanguage: targetCountry: offerId or channel:
contentLanguage:feedLabel: offerId.
Corresponds to the JSON property id
8865 8866 8867 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8865 def id @id end |
#identifier_exists ⇒ Boolean Also known as: identifier_exists?
False when the item does not have unique product identifiers appropriate to
its category, such as GTIN, MPN, and brand. Required according to the Unique
Product Identifier Rules for all target countries except for Canada.
Corresponds to the JSON property identifierExists
8872 8873 8874 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8872 def identifier_exists @identifier_exists end |
#image_link ⇒ String
URL of an image of the item.
Corresponds to the JSON property imageLink
8878 8879 8880 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8878 def image_link @image_link end |
#included_destinations ⇒ Array<String>
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
.
Corresponds to the JSON property includedDestinations
8886 8887 8888 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8886 def included_destinations @included_destinations end |
#installment ⇒ Google::Apis::ContentV2_1::Installment
Details of a monthly installment payment offering. Learn more about installments.
Corresponds to the JSON property installment
8892 8893 8894 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8892 def installment @installment end |
#is_bundle ⇒ Boolean Also known as: is_bundle?
Whether the item is a merchant-defined bundle. A bundle is a custom grouping
of different products sold by a merchant for a single price.
Corresponds to the JSON property isBundle
8898 8899 8900 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8898 def is_bundle @is_bundle end |
#item_group_id ⇒ String
Shared identifier for all variants of the same product.
Corresponds to the JSON property itemGroupId
8904 8905 8906 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8904 def item_group_id @item_group_id end |
#kind ⇒ String
Identifies what kind of resource this is. Value: the fixed string "content#
product
"
Corresponds to the JSON property kind
8910 8911 8912 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8910 def kind @kind end |
#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. See the Help Center
article for more information.
Corresponds to the JSON property lifestyleImageLinks
8917 8918 8919 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8917 def lifestyle_image_links @lifestyle_image_links end |
#link ⇒ String
URL directly linking to your item's page on your website.
Corresponds to the JSON property link
8922 8923 8924 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8922 def link @link end |
#link_template ⇒ String
URL template for merchant hosted local storefront.
Corresponds to the JSON property linkTemplate
8927 8928 8929 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8927 def link_template @link_template end |
#loyalty_program ⇒ Google::Apis::ContentV2_1::LoyaltyProgram
Allows the setting up of loyalty program benefits (for example price or points)
. https://support.google.com/merchants/answer/12922446
Corresponds to the JSON property loyaltyProgram
8933 8934 8935 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8933 def loyalty_program @loyalty_program end |
#loyalty_programs ⇒ Array<Google::Apis::ContentV2_1::LoyaltyProgram>
Optional. 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.
Corresponds to the JSON property loyaltyPrograms
8940 8941 8942 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8940 def loyalty_programs @loyalty_programs end |
#material ⇒ String
The material of which the item is made.
Corresponds to the JSON property material
8945 8946 8947 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8945 def material @material end |
#max_energy_efficiency_class ⇒ String
The energy efficiency class as defined in EU directive 2010/30/EU.
Corresponds to the JSON property maxEnergyEfficiencyClass
8950 8951 8952 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8950 def max_energy_efficiency_class @max_energy_efficiency_class end |
#max_handling_time ⇒ Fixnum
Maximal product handling time (in business days).
Corresponds to the JSON property maxHandlingTime
8955 8956 8957 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8955 def max_handling_time @max_handling_time end |
#min_energy_efficiency_class ⇒ String
The energy efficiency class as defined in EU directive 2010/30/EU.
Corresponds to the JSON property minEnergyEfficiencyClass
8960 8961 8962 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8960 def min_energy_efficiency_class @min_energy_efficiency_class end |
#min_handling_time ⇒ Fixnum
Minimal product handling time (in business days).
Corresponds to the JSON property minHandlingTime
8965 8966 8967 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8965 def min_handling_time @min_handling_time end |
#mobile_link ⇒ String
URL for the mobile-optimized version of your item's landing page.
Corresponds to the JSON property mobileLink
8970 8971 8972 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8970 def mobile_link @mobile_link end |
#mobile_link_template ⇒ String
URL template for merchant hosted local storefront optimized for mobile devices.
Corresponds to the JSON property mobileLinkTemplate
8975 8976 8977 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8975 def mobile_link_template @mobile_link_template end |
#mpn ⇒ String
Manufacturer Part Number (MPN) of the item.
Corresponds to the JSON property mpn
8980 8981 8982 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8980 def mpn @mpn end |
#multipack ⇒ Fixnum
The number of identical products in a merchant-defined multipack.
Corresponds to the JSON property multipack
8985 8986 8987 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8985 def multipack @multipack end |
#offer_id ⇒ String
Required. A unique identifier for the item. Leading and trailing whitespaces
are stripped and multiple whitespaces are replaced by a single whitespace upon
submission. Only valid unicode characters are accepted. See the products feed
specification for details. Note: Content API methods that operate on
products take the REST ID of the product, not this identifier.
Corresponds to the JSON property offerId
8994 8995 8996 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8994 def offer_id @offer_id end |
#pattern ⇒ String
The item's pattern (for example, polka dots).
Corresponds to the JSON property pattern
8999 9000 9001 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8999 def pattern @pattern end |
#pause ⇒ String
Publication of this item should be temporarily paused. Acceptable values are: -
"ads
"
Corresponds to the JSON property pause
9005 9006 9007 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9005 def pause @pause end |
#pickup_method ⇒ String
The pick up option for the item. Acceptable values are: - "buy
" - "reserve
"
- "
ship to store
" - "not supported
" Corresponds to the JSON propertypickupMethod
9011 9012 9013 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9011 def pickup_method @pickup_method end |
#pickup_sla ⇒ String
Item store pickup timeline. Acceptable values are: - "same day
" - "next day
" - "2-day
" - "3-day
" - "4-day
" - "5-day
" - "6-day
" - "7-day
" - "
multi-week
"
Corresponds to the JSON property pickupSla
9018 9019 9020 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9018 def pickup_sla @pickup_sla end |
#price ⇒ Google::Apis::ContentV2_1::Price
Price of the item.
Corresponds to the JSON property price
9023 9024 9025 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9023 def price @price end |
#product_details ⇒ Array<Google::Apis::ContentV2_1::ProductProductDetail>
Technical specification or additional product details.
Corresponds to the JSON property productDetails
9028 9029 9030 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9028 def product_details @product_details end |
#product_height ⇒ Google::Apis::ContentV2_1::ProductDimension
The height of the product in the units provided. The value must be between 0 (
exclusive) and 3000 (inclusive).
Corresponds to the JSON property productHeight
9034 9035 9036 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9034 def product_height @product_height end |
#product_highlights ⇒ Array<String>
Bullet points describing the most relevant highlights of a product.
Corresponds to the JSON property productHighlights
9039 9040 9041 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9039 def product_highlights @product_highlights end |
#product_length ⇒ Google::Apis::ContentV2_1::ProductDimension
The length of the product in the units provided. The value must be between 0 (
exclusive) and 3000 (inclusive).
Corresponds to the JSON property productLength
9045 9046 9047 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9045 def product_length @product_length end |
#product_types ⇒ Array<String>
Categories of the item (formatted as in product data specification).
Corresponds to the JSON property productTypes
9050 9051 9052 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9050 def product_types @product_types end |
#product_weight ⇒ Google::Apis::ContentV2_1::ProductWeight
The weight of the product in the units provided. The value must be between 0 (
exclusive) and 2000 (inclusive).
Corresponds to the JSON property productWeight
9056 9057 9058 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9056 def product_weight @product_weight end |
#product_width ⇒ Google::Apis::ContentV2_1::ProductDimension
The width of the product in the units provided. The value must be between 0 (
exclusive) and 3000 (inclusive).
Corresponds to the JSON property productWidth
9062 9063 9064 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9062 def product_width @product_width end |
#promotion_ids ⇒ Array<String>
The unique ID of a promotion.
Corresponds to the JSON property promotionIds
9067 9068 9069 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9067 def promotion_ids @promotion_ids end |
#sale_price ⇒ Google::Apis::ContentV2_1::Price
Advertised sale price of the item.
Corresponds to the JSON property salePrice
9072 9073 9074 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9072 def sale_price @sale_price end |
#sale_price_effective_date ⇒ String
Date range during which the item is on sale (see product data specification ).
Corresponds to the JSON property salePriceEffectiveDate
9077 9078 9079 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9077 def sale_price_effective_date @sale_price_effective_date end |
#sell_on_google_quantity ⇒ Fixnum
The quantity of the product that is available for selling on Google. Supported
only for online products.
Corresponds to the JSON property sellOnGoogleQuantity
9083 9084 9085 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9083 def sell_on_google_quantity @sell_on_google_quantity end |
#shipping ⇒ Array<Google::Apis::ContentV2_1::ProductShipping>
Shipping rules.
Corresponds to the JSON property shipping
9088 9089 9090 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9088 def shipping @shipping end |
#shipping_height ⇒ Google::Apis::ContentV2_1::ProductShippingDimension
Height of the item for shipping.
Corresponds to the JSON property shippingHeight
9093 9094 9095 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9093 def shipping_height @shipping_height end |
#shipping_label ⇒ String
The shipping label of the product, used to group product in account-level
shipping rules.
Corresponds to the JSON property shippingLabel
9099 9100 9101 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9099 def shipping_label @shipping_label end |
#shipping_length ⇒ Google::Apis::ContentV2_1::ProductShippingDimension
Length of the item for shipping.
Corresponds to the JSON property shippingLength
9104 9105 9106 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9104 def shipping_length @shipping_length end |
#shipping_weight ⇒ Google::Apis::ContentV2_1::ProductShippingWeight
Weight of the item for shipping.
Corresponds to the JSON property shippingWeight
9109 9110 9111 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9109 def shipping_weight @shipping_weight end |
#shipping_width ⇒ Google::Apis::ContentV2_1::ProductShippingDimension
Width of the item for shipping.
Corresponds to the JSON property shippingWidth
9114 9115 9116 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9114 def shipping_width @shipping_width end |
#shopping_ads_excluded_countries ⇒ Array<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 MC feed settings.
Corresponds to the JSON property shoppingAdsExcludedCountries
9121 9122 9123 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9121 def shopping_ads_excluded_countries @shopping_ads_excluded_countries end |
#size_system ⇒ String
System in which the size is specified. Recommended for apparel items.
Corresponds to the JSON property sizeSystem
9126 9127 9128 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9126 def size_system @size_system end |
#size_type ⇒ String
The cut of the item. Recommended for apparel items.
Corresponds to the JSON property sizeType
9131 9132 9133 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9131 def size_type @size_type end |
#sizes ⇒ Array<String>
Size of the item. Only one value is allowed. For variants with different sizes,
insert a separate product for each size with the same itemGroupId
value (
see size definition).
Corresponds to the JSON property sizes
9138 9139 9140 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9138 def sizes @sizes end |
#source ⇒ String
Output only. The source of the offer, that is, how the offer was created.
Acceptable values are: - "api
" - "crawl
" - "feed
"
Corresponds to the JSON property source
9144 9145 9146 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9144 def source @source end |
#structured_description ⇒ Google::Apis::ContentV2_1::ProductStructuredDescription
Structured description, for algorithmically (AI)-generated descriptions. See
description
for more information.
Corresponds to the JSON property structuredDescription
9151 9152 9153 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9151 def structured_description @structured_description end |
#structured_title ⇒ Google::Apis::ContentV2_1::ProductStructuredTitle
Structured title, for algorithmically (AI)-generated titles. See title for more information.
Corresponds to the JSON property structuredTitle
9157 9158 9159 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9157 def structured_title @structured_title end |
#subscription_cost ⇒ Google::Apis::ContentV2_1::ProductSubscriptionCost
Number of periods (months or years) and amount of payment per period for an
item with an associated subscription contract.
Corresponds to the JSON property subscriptionCost
9163 9164 9165 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9163 def subscription_cost @subscription_cost end |
#target_country ⇒ String
Required. The CLDR territory code for the item's country of sale.
Corresponds to the JSON property targetCountry
9168 9169 9170 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9168 def target_country @target_country end |
#tax_category ⇒ String
The tax category of the product, used to configure detailed tax nexus in
account-level tax settings.
Corresponds to the JSON property taxCategory
9174 9175 9176 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9174 def tax_category @tax_category end |
#taxes ⇒ Array<Google::Apis::ContentV2_1::ProductTax>
Tax information.
Corresponds to the JSON property taxes
9179 9180 9181 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9179 def taxes @taxes end |
#title ⇒ String
Title of the item.
Corresponds to the JSON property title
9184 9185 9186 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9184 def title @title end |
#transit_time_label ⇒ String
The transit time label of the product, used to group product in account-level
transit time tables.
Corresponds to the JSON property transitTimeLabel
9190 9191 9192 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9190 def transit_time_label @transit_time_label end |
#unit_pricing_base_measure ⇒ Google::Apis::ContentV2_1::ProductUnitPricingBaseMeasure
The preference of the denominator of the unit price.
Corresponds to the JSON property unitPricingBaseMeasure
9195 9196 9197 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9195 def unit_pricing_base_measure @unit_pricing_base_measure end |
#unit_pricing_measure ⇒ Google::Apis::ContentV2_1::ProductUnitPricingMeasure
The measure and dimension of an item.
Corresponds to the JSON property unitPricingMeasure
9200 9201 9202 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9200 def unit_pricing_measure @unit_pricing_measure end |
#virtual_model_link ⇒ String
URL of the 3D model of the item to provide more visuals.
Corresponds to the JSON property virtualModelLink
9205 9206 9207 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9205 def virtual_model_link @virtual_model_link end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
9212 9213 9214 9215 9216 9217 9218 9219 9220 9221 9222 9223 9224 9225 9226 9227 9228 9229 9230 9231 9232 9233 9234 9235 9236 9237 9238 9239 9240 9241 9242 9243 9244 9245 9246 9247 9248 9249 9250 9251 9252 9253 9254 9255 9256 9257 9258 9259 9260 9261 9262 9263 9264 9265 9266 9267 9268 9269 9270 9271 9272 9273 9274 9275 9276 9277 9278 9279 9280 9281 9282 9283 9284 9285 9286 9287 9288 9289 9290 9291 9292 9293 9294 9295 9296 9297 9298 9299 9300 9301 9302 9303 9304 9305 9306 9307 9308 9309 9310 9311 9312 9313 9314 9315 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9212 def update!(**args) @additional_image_links = args[:additional_image_links] if args.key?(:additional_image_links) @additional_size_type = args[:additional_size_type] if args.key?(:additional_size_type) @ads_grouping = args[:ads_grouping] if args.key?(:ads_grouping) @ads_labels = args[:ads_labels] if args.key?(:ads_labels) @ads_redirect = args[:ads_redirect] if args.key?(:ads_redirect) @adult = args[:adult] if args.key?(:adult) @age_group = args[:age_group] if args.key?(:age_group) @auto_pricing_min_price = args[:auto_pricing_min_price] if args.key?(:auto_pricing_min_price) @availability = args[:availability] if args.key?(:availability) @availability_date = args[:availability_date] if args.key?(:availability_date) @brand = args[:brand] if args.key?(:brand) @canonical_link = args[:canonical_link] if args.key?(:canonical_link) @certifications = args[:certifications] if args.key?(:certifications) @channel = args[:channel] if args.key?(:channel) @cloud_export_additional_properties = args[:cloud_export_additional_properties] if args.key?(:cloud_export_additional_properties) @color = args[:color] if args.key?(:color) @condition = args[:condition] if args.key?(:condition) @content_language = args[:content_language] if args.key?(:content_language) @cost_of_goods_sold = args[:cost_of_goods_sold] if args.key?(:cost_of_goods_sold) @custom_attributes = args[:custom_attributes] if args.key?(:custom_attributes) @custom_label0 = args[:custom_label0] if args.key?(:custom_label0) @custom_label1 = args[:custom_label1] if args.key?(:custom_label1) @custom_label2 = args[:custom_label2] if args.key?(:custom_label2) @custom_label3 = args[:custom_label3] if args.key?(:custom_label3) @custom_label4 = args[:custom_label4] if args.key?(:custom_label4) @description = args[:description] if args.key?(:description) @disclosure_date = args[:disclosure_date] if args.key?(:disclosure_date) @display_ads_id = args[:display_ads_id] if args.key?(:display_ads_id) @display_ads_link = args[:display_ads_link] if args.key?(:display_ads_link) @display_ads_similar_ids = args[:display_ads_similar_ids] if args.key?(:display_ads_similar_ids) @display_ads_title = args[:display_ads_title] if args.key?(:display_ads_title) @display_ads_value = args[:display_ads_value] if args.key?(:display_ads_value) @energy_efficiency_class = args[:energy_efficiency_class] if args.key?(:energy_efficiency_class) @excluded_destinations = args[:excluded_destinations] if args.key?(:excluded_destinations) @expiration_date = args[:expiration_date] if args.key?(:expiration_date) @external_seller_id = args[:external_seller_id] if args.key?(:external_seller_id) @feed_label = args[:feed_label] if args.key?(:feed_label) @free_shipping_threshold = args[:free_shipping_threshold] if args.key?(:free_shipping_threshold) @gender = args[:gender] if args.key?(:gender) @google_product_category = args[:google_product_category] if args.key?(:google_product_category) @gtin = args[:gtin] if args.key?(:gtin) @id = args[:id] if args.key?(:id) @identifier_exists = args[:identifier_exists] if args.key?(:identifier_exists) @image_link = args[:image_link] if args.key?(:image_link) @included_destinations = args[:included_destinations] if args.key?(:included_destinations) @installment = args[:installment] if args.key?(:installment) @is_bundle = args[:is_bundle] if args.key?(:is_bundle) @item_group_id = args[:item_group_id] if args.key?(:item_group_id) @kind = args[:kind] if args.key?(:kind) @lifestyle_image_links = args[:lifestyle_image_links] if args.key?(:lifestyle_image_links) @link = args[:link] if args.key?(:link) @link_template = args[:link_template] if args.key?(:link_template) @loyalty_program = args[:loyalty_program] if args.key?(:loyalty_program) @loyalty_programs = args[:loyalty_programs] if args.key?(:loyalty_programs) @material = args[:material] if args.key?(:material) @max_energy_efficiency_class = args[:max_energy_efficiency_class] if args.key?(:max_energy_efficiency_class) @max_handling_time = args[:max_handling_time] if args.key?(:max_handling_time) @min_energy_efficiency_class = args[:min_energy_efficiency_class] if args.key?(:min_energy_efficiency_class) @min_handling_time = args[:min_handling_time] if args.key?(:min_handling_time) @mobile_link = args[:mobile_link] if args.key?(:mobile_link) @mobile_link_template = args[:mobile_link_template] if args.key?(:mobile_link_template) @mpn = args[:mpn] if args.key?(:mpn) @multipack = args[:multipack] if args.key?(:multipack) @offer_id = args[:offer_id] if args.key?(:offer_id) @pattern = args[:pattern] if args.key?(:pattern) @pause = args[:pause] if args.key?(:pause) @pickup_method = args[:pickup_method] if args.key?(:pickup_method) @pickup_sla = args[:pickup_sla] if args.key?(:pickup_sla) @price = args[:price] if args.key?(:price) @product_details = args[:product_details] if args.key?(:product_details) @product_height = args[:product_height] if args.key?(:product_height) @product_highlights = args[:product_highlights] if args.key?(:product_highlights) @product_length = args[:product_length] if args.key?(:product_length) @product_types = args[:product_types] if args.key?(:product_types) @product_weight = args[:product_weight] if args.key?(:product_weight) @product_width = args[:product_width] if args.key?(:product_width) @promotion_ids = args[:promotion_ids] if args.key?(:promotion_ids) @sale_price = args[:sale_price] if args.key?(:sale_price) @sale_price_effective_date = args[:sale_price_effective_date] if args.key?(:sale_price_effective_date) @sell_on_google_quantity = args[:sell_on_google_quantity] if args.key?(:sell_on_google_quantity) @shipping = args[:shipping] if args.key?(:shipping) @shipping_height = args[:shipping_height] if args.key?(:shipping_height) @shipping_label = args[:shipping_label] if args.key?(:shipping_label) @shipping_length = args[:shipping_length] if args.key?(:shipping_length) @shipping_weight = args[:shipping_weight] if args.key?(:shipping_weight) @shipping_width = args[:shipping_width] if args.key?(:shipping_width) @shopping_ads_excluded_countries = args[:shopping_ads_excluded_countries] if args.key?(:shopping_ads_excluded_countries) @size_system = args[:size_system] if args.key?(:size_system) @size_type = args[:size_type] if args.key?(:size_type) @sizes = args[:sizes] if args.key?(:sizes) @source = args[:source] if args.key?(:source) @structured_description = args[:structured_description] if args.key?(:structured_description) @structured_title = args[:structured_title] if args.key?(:structured_title) @subscription_cost = args[:subscription_cost] if args.key?(:subscription_cost) @target_country = args[:target_country] if args.key?(:target_country) @tax_category = args[:tax_category] if args.key?(:tax_category) @taxes = args[:taxes] if args.key?(:taxes) @title = args[:title] if args.key?(:title) @transit_time_label = args[:transit_time_label] if args.key?(:transit_time_label) @unit_pricing_base_measure = args[:unit_pricing_base_measure] if args.key?(:unit_pricing_base_measure) @unit_pricing_measure = args[:unit_pricing_measure] if args.key?(:unit_pricing_measure) @virtual_model_link = args[:virtual_model_link] if args.key?(:virtual_model_link) end |