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.
9216 9217 9218 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9216 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
8637 8638 8639 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8637 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
8643 8644 8645 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8643 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
8648 8649 8650 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8648 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
8653 8654 8655 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8653 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
8659 8660 8661 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8659 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
8664 8665 8666 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8664 def adult @adult end |
#age_group ⇒ String
Target age group of the item.
Corresponds to the JSON property ageGroup
8670 8671 8672 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8670 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
8678 8679 8680 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8678 def auto_pricing_min_price @auto_pricing_min_price end |
#availability ⇒ String
Availability status of the item.
Corresponds to the JSON property availability
8683 8684 8685 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8683 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
8689 8690 8691 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8689 def availability_date @availability_date end |
#brand ⇒ String
Brand of the item.
Corresponds to the JSON property brand
8694 8695 8696 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8694 def brand @brand end |
#canonical_link ⇒ String
URL for the canonical version of your item's landing page.
Corresponds to the JSON property canonicalLink
8699 8700 8701 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8699 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
8706 8707 8708 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8706 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
8712 8713 8714 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8712 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
8717 8718 8719 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8717 def cloud_export_additional_properties @cloud_export_additional_properties end |
#color ⇒ String
Color of the item.
Corresponds to the JSON property color
8722 8723 8724 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8722 def color @color end |
#condition ⇒ String
Condition or state of the item.
Corresponds to the JSON property condition
8727 8728 8729 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8727 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
8732 8733 8734 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8732 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
8737 8738 8739 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8737 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
8746 8747 8748 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8746 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
8751 8752 8753 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8751 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
8756 8757 8758 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8756 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
8761 8762 8763 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8761 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
8766 8767 8768 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8766 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
8771 8772 8773 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8771 def custom_label4 @custom_label4 end |
#description ⇒ String
Description of the item.
Corresponds to the JSON property description
8776 8777 8778 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8776 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
8784 8785 8786 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8784 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
8789 8790 8791 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8789 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
8794 8795 8796 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8794 def display_ads_link @display_ads_link end |
#display_ads_similar_ids ⇒ Array<String>
Advertiser-specified recommendations.
Corresponds to the JSON property displayAdsSimilarIds
8799 8800 8801 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8799 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
8804 8805 8806 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8804 def display_ads_title @display_ads_title end |
#display_ads_value ⇒ Float
Offer margin for dynamic remarketing campaigns.
Corresponds to the JSON property displayAdsValue
8809 8810 8811 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8809 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
8814 8815 8816 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8814 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
8822 8823 8824 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8822 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
8830 8831 8832 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8830 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
8836 8837 8838 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8836 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
8843 8844 8845 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8843 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
8848 8849 8850 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8848 def free_shipping_threshold @free_shipping_threshold end |
#gender ⇒ String
Target gender of the item.
Corresponds to the JSON property gender
8853 8854 8855 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8853 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
8861 8862 8863 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8861 def google_product_category @google_product_category end |
#gtin ⇒ String
Global Trade Item Number (GTIN) of the item.
Corresponds to the JSON property gtin
8866 8867 8868 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8866 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
8874 8875 8876 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8874 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
8881 8882 8883 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8881 def identifier_exists @identifier_exists end |
#image_link ⇒ String
URL of an image of the item.
Corresponds to the JSON property imageLink
8887 8888 8889 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8887 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
8895 8896 8897 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8895 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
8901 8902 8903 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8901 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
8907 8908 8909 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8907 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
8913 8914 8915 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8913 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
8919 8920 8921 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8919 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
8926 8927 8928 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8926 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
8931 8932 8933 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8931 def link @link end |
#link_template ⇒ String
URL template for merchant hosted local storefront.
Corresponds to the JSON property linkTemplate
8936 8937 8938 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8936 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
8942 8943 8944 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8942 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
8949 8950 8951 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8949 def loyalty_programs @loyalty_programs end |
#material ⇒ String
The material of which the item is made.
Corresponds to the JSON property material
8954 8955 8956 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8954 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
8959 8960 8961 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8959 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
8964 8965 8966 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8964 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
8969 8970 8971 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8969 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
8974 8975 8976 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8974 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
8979 8980 8981 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8979 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
8984 8985 8986 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8984 def mobile_link_template @mobile_link_template end |
#mpn ⇒ String
Manufacturer Part Number (MPN) of the item.
Corresponds to the JSON property mpn
8989 8990 8991 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8989 def mpn @mpn end |
#multipack ⇒ Fixnum
The number of identical products in a merchant-defined multipack.
Corresponds to the JSON property multipack
8994 8995 8996 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 8994 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
9003 9004 9005 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9003 def offer_id @offer_id end |
#pattern ⇒ String
The item's pattern (for example, polka dots).
Corresponds to the JSON property pattern
9008 9009 9010 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9008 def pattern @pattern end |
#pause ⇒ String
Publication of this item should be temporarily paused. Acceptable values are: -
"ads
"
Corresponds to the JSON property pause
9014 9015 9016 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9014 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
9020 9021 9022 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9020 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
9027 9028 9029 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9027 def pickup_sla @pickup_sla end |
#price ⇒ Google::Apis::ContentV2_1::Price
Price of the item.
Corresponds to the JSON property price
9032 9033 9034 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9032 def price @price end |
#product_details ⇒ Array<Google::Apis::ContentV2_1::ProductProductDetail>
Technical specification or additional product details.
Corresponds to the JSON property productDetails
9037 9038 9039 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9037 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
9043 9044 9045 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9043 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
9048 9049 9050 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9048 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
9054 9055 9056 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9054 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
9059 9060 9061 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9059 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
9065 9066 9067 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9065 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
9071 9072 9073 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9071 def product_width @product_width end |
#promotion_ids ⇒ Array<String>
The unique ID of a promotion.
Corresponds to the JSON property promotionIds
9076 9077 9078 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9076 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
9081 9082 9083 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9081 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
9086 9087 9088 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9086 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
9092 9093 9094 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9092 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
9097 9098 9099 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9097 def shipping @shipping end |
#shipping_height ⇒ Google::Apis::ContentV2_1::ProductShippingDimension
Height of the item for shipping.
Corresponds to the JSON property shippingHeight
9102 9103 9104 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9102 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
9108 9109 9110 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9108 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
9113 9114 9115 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9113 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
9118 9119 9120 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9118 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
9123 9124 9125 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9123 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
9130 9131 9132 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9130 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
9135 9136 9137 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9135 def size_system @size_system end |
#size_type ⇒ String
The cut of the item. Recommended for apparel items.
Corresponds to the JSON property sizeType
9140 9141 9142 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9140 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
9147 9148 9149 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9147 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
9153 9154 9155 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9153 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
9160 9161 9162 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9160 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
9166 9167 9168 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9166 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
9172 9173 9174 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9172 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
9177 9178 9179 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9177 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
9183 9184 9185 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9183 def tax_category @tax_category end |
#taxes ⇒ Array<Google::Apis::ContentV2_1::ProductTax>
Tax information.
Corresponds to the JSON property taxes
9188 9189 9190 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9188 def taxes @taxes end |
#title ⇒ String
Title of the item.
Corresponds to the JSON property title
9193 9194 9195 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9193 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
9199 9200 9201 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9199 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
9204 9205 9206 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9204 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
9209 9210 9211 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9209 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
9214 9215 9216 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9214 def virtual_model_link @virtual_model_link end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
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 9316 9317 9318 9319 9320 9321 9322 9323 9324 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 9221 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 |