Class: Google::Apis::ContentV2_1::Product

Inherits:
Object
  • Object
show all
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. The following reference documentation lists the field names in the camelCase casing style while the Products Data Specification lists the names in the ** snake_case** casing style.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Product

Returns a new instance of Product.



9277
9278
9279
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9277

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

Additional URLs of images of the item. Corresponds to the JSON property additionalImageLinks

Returns:

  • (Array<String>) 


8688
8689
8690
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8688

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

Returns:

  • (String) 


8694
8695
8696
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8694

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

Returns:

  • (String) 


8699
8700
8701
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8699

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

Returns:

  • (Array<String>) 


8704
8705
8706
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8704

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

Returns:

  • (String) 


8710
8711
8712
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8710

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

Returns:

  • (Boolean) 


8715
8716
8717
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8715

def adult
  @adult
end

#age_group ⇒ String

Target age group of the item. Corresponds to the JSON property ageGroup

Returns:

  • (String) 


8721
8722
8723
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8721

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

Returns:



8729
8730
8731
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8729

def auto_pricing_min_price
  @auto_pricing_min_price
end

#availability ⇒ String

Availability status of the item. Corresponds to the JSON property availability

Returns:

  • (String) 


8734
8735
8736
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8734

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

Returns:

  • (String) 


8740
8741
8742
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8740

def availability_date
  @availability_date
end

#brand ⇒ String

Brand of the item. Corresponds to the JSON property brand

Returns:

  • (String) 


8745
8746
8747
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8745

def brand
  @brand
end

#canonical_link ⇒ String

URL for the canonical version of your item's landing page. Corresponds to the JSON property canonicalLink

Returns:

  • (String) 


8750
8751
8752
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8750

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

Returns:



8757
8758
8759
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8757

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

Returns:

  • (String) 


8763
8764
8765
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8763

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

Returns:



8768
8769
8770
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8768

def cloud_export_additional_properties
  @cloud_export_additional_properties
end

#color ⇒ String

Color of the item. Corresponds to the JSON property color

Returns:

  • (String) 


8773
8774
8775
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8773

def color
  @color
end

#condition ⇒ String

Condition or state of the item. Corresponds to the JSON property condition

Returns:

  • (String) 


8778
8779
8780
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8778

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

Returns:

  • (String) 


8783
8784
8785
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8783

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

Returns:



8788
8789
8790
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8788

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

Returns:



8797
8798
8799
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8797

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

Returns:

  • (String) 


8802
8803
8804
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8802

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

Returns:

  • (String) 


8807
8808
8809
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8807

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

Returns:

  • (String) 


8812
8813
8814
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8812

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

Returns:

  • (String) 


8817
8818
8819
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8817

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

Returns:

  • (String) 


8822
8823
8824
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8822

def custom_label4
  @custom_label4
end

#description ⇒ String

Description of the item. Corresponds to the JSON property description

Returns:

  • (String) 


8827
8828
8829
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8827

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

Returns:

  • (String) 


8835
8836
8837
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8835

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

Returns:

  • (String) 


8840
8841
8842
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8840

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

Returns:

  • (String) 


8845
8846
8847
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8845

def display_ads_link
  @display_ads_link
end

#display_ads_similar_ids ⇒ Array<String>

Advertiser-specified recommendations. Corresponds to the JSON property displayAdsSimilarIds

Returns:

  • (Array<String>) 


8850
8851
8852
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8850

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

Returns:

  • (String) 


8855
8856
8857
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8855

def display_ads_title
  @display_ads_title
end

#display_ads_value ⇒ Float

Offer margin for dynamic remarketing campaigns. Corresponds to the JSON property displayAdsValue

Returns:

  • (Float) 


8860
8861
8862
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8860

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

Returns:

  • (String) 


8865
8866
8867
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8865

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

Returns:

  • (Array<String>) 


8873
8874
8875
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8873

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

Returns:

  • (String) 


8881
8882
8883
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8881

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

Returns:

  • (String) 


8887
8888
8889
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8887

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

Returns:

  • (String) 


8894
8895
8896
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8894

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

Returns:



8899
8900
8901
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8899

def free_shipping_threshold
  @free_shipping_threshold
end

#gender ⇒ String

Target gender of the item. Corresponds to the JSON property gender

Returns:

  • (String) 


8904
8905
8906
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8904

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

Returns:

  • (String) 


8912
8913
8914
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8912

def google_product_category
  @google_product_category
end

#gtin ⇒ String

Global Trade Item Number (GTIN) of the item. Corresponds to the JSON property gtin

Returns:

  • (String) 


8917
8918
8919
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8917

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

Returns:

  • (String) 


8925
8926
8927
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8925

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

Returns:

  • (Boolean) 


8932
8933
8934
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8932

def identifier_exists
  @identifier_exists
end

#image_link ⇒ String

URL of an image of the item. Corresponds to the JSON property imageLink

Returns:

  • (String) 


8938
8939
8940
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8938

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

Returns:

  • (Array<String>) 


8946
8947
8948
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8946

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

Returns:



8952
8953
8954
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8952

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

Returns:

  • (Boolean) 


8958
8959
8960
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8958

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

Returns:

  • (String) 


8964
8965
8966
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8964

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

Returns:

  • (String) 


8970
8971
8972
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8970

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

Returns:

  • (Array<String>) 


8977
8978
8979
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8977

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

Returns:

  • (String) 


8982
8983
8984
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8982

def link
  @link
end

#link_template ⇒ String

URL template for merchant hosted local storefront. Corresponds to the JSON property linkTemplate

Returns:

  • (String) 


8987
8988
8989
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8987

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

Returns:



8993
8994
8995
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 8993

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

Returns:



9000
9001
9002
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9000

def loyalty_programs
  @loyalty_programs
end

#material ⇒ String

The material of which the item is made. Corresponds to the JSON property material

Returns:

  • (String) 


9005
9006
9007
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9005

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

Returns:

  • (String) 


9010
9011
9012
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9010

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

Returns:

  • (Fixnum) 


9015
9016
9017
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9015

def max_handling_time
  @max_handling_time
end

#maximum_retail_price ⇒ Google::Apis::ContentV2_1::Price

Maximum retail price (MRP) of the item. Applicable to India only. Corresponds to the JSON property maximumRetailPrice

Returns:



9020
9021
9022
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9020

def maximum_retail_price
  @maximum_retail_price
end

#min_energy_efficiency_class ⇒ String

The energy efficiency class as defined in EU directive 2010/30/EU. Corresponds to the JSON property minEnergyEfficiencyClass

Returns:

  • (String) 


9025
9026
9027
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9025

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

Returns:

  • (Fixnum) 


9030
9031
9032
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9030

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

Returns:

  • (String) 


9035
9036
9037
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9035

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

Returns:

  • (String) 


9040
9041
9042
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9040

def mobile_link_template
  @mobile_link_template
end

#mpn ⇒ String

Manufacturer Part Number (MPN) of the item. Corresponds to the JSON property mpn

Returns:

  • (String) 


9045
9046
9047
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9045

def mpn
  @mpn
end

#multipack ⇒ Fixnum

The number of identical products in a merchant-defined multipack. Corresponds to the JSON property multipack

Returns:

  • (Fixnum) 


9050
9051
9052
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9050

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

Returns:

  • (String) 


9059
9060
9061
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9059

def offer_id
  @offer_id
end

#pattern ⇒ String

The item's pattern (for example, polka dots). Corresponds to the JSON property pattern

Returns:

  • (String) 


9064
9065
9066
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9064

def pattern
  @pattern
end

#pause ⇒ String

Publication of this item should be temporarily paused. Acceptable values are: - "ads" Corresponds to the JSON property pause

Returns:

  • (String) 


9070
9071
9072
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9070

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 property pickupMethod

Returns:

  • (String) 


9076
9077
9078
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9076

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

Returns:

  • (String) 


9083
9084
9085
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9083

def pickup_sla
  @pickup_sla
end

#price ⇒ Google::Apis::ContentV2_1::Price

Price of the item. Corresponds to the JSON property price

Returns:



9088
9089
9090
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9088

def price
  @price
end

#product_details ⇒ Array<Google::Apis::ContentV2_1::ProductProductDetail>

Technical specification or additional product details. Corresponds to the JSON property productDetails

Returns:



9093
9094
9095
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9093

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

Returns:



9099
9100
9101
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9099

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

Returns:

  • (Array<String>) 


9104
9105
9106
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9104

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

Returns:



9110
9111
9112
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9110

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

Returns:

  • (Array<String>) 


9115
9116
9117
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9115

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

Returns:



9121
9122
9123
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9121

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

Returns:



9127
9128
9129
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9127

def product_width
  @product_width
end

#promotion_ids ⇒ Array<String>

The unique ID of a promotion. Corresponds to the JSON property promotionIds

Returns:

  • (Array<String>) 


9132
9133
9134
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9132

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

Returns:



9137
9138
9139
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9137

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

Returns:

  • (String) 


9142
9143
9144
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9142

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

Returns:

  • (Fixnum) 


9148
9149
9150
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9148

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

Returns:



9153
9154
9155
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9153

def shipping
  @shipping
end

#shipping_height ⇒ Google::Apis::ContentV2_1::ProductShippingDimension

Height of the item for shipping. Corresponds to the JSON property shippingHeight

Returns:



9158
9159
9160
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9158

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

Returns:

  • (String) 


9164
9165
9166
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9164

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

Returns:



9169
9170
9171
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9169

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

Returns:



9174
9175
9176
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9174

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

Returns:



9179
9180
9181
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9179

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

Returns:

  • (Array<String>) 


9186
9187
9188
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9186

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

Returns:

  • (String) 


9191
9192
9193
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9191

def size_system
  @size_system
end

#size_type ⇒ String

The cut of the item. Recommended for apparel items. Corresponds to the JSON property sizeType

Returns:

  • (String) 


9196
9197
9198
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9196

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

Returns:

  • (Array<String>) 


9203
9204
9205
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9203

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

Returns:

  • (String) 


9209
9210
9211
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9209

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

Returns:



9216
9217
9218
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9216

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

Returns:



9222
9223
9224
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9222

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

Returns:



9228
9229
9230
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9228

def subscription_cost
  @subscription_cost
end

#sustainability_incentives ⇒ Array<Google::Apis::ContentV2_1::ProductSustainabilityIncentive>

Optional. The list of sustainability incentive programs. Corresponds to the JSON property sustainabilityIncentives

Returns:



9233
9234
9235
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9233

def sustainability_incentives
  @sustainability_incentives
end

#target_country ⇒ String

Required. The CLDR territory code for the item's country of sale. Corresponds to the JSON property targetCountry

Returns:

  • (String) 


9238
9239
9240
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9238

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

Returns:

  • (String) 


9244
9245
9246
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9244

def tax_category
  @tax_category
end

#taxes ⇒ Array<Google::Apis::ContentV2_1::ProductTax>

Tax information. Corresponds to the JSON property taxes

Returns:



9249
9250
9251
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9249

def taxes
  @taxes
end

#title ⇒ String

Title of the item. Corresponds to the JSON property title

Returns:

  • (String) 


9254
9255
9256
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9254

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

Returns:

  • (String) 


9260
9261
9262
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9260

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

Returns:



9265
9266
9267
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9265

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

Returns:



9270
9271
9272
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9270

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

Returns:

  • (String) 


9275
9276
9277
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9275

def virtual_model_link
  @virtual_model_link
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



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
9325
9326
9327
9328
9329
9330
9331
9332
9333
9334
9335
9336
9337
9338
9339
9340
9341
9342
9343
9344
9345
9346
9347
9348
9349
9350
9351
9352
9353
9354
9355
9356
9357
9358
9359
9360
9361
9362
9363
9364
9365
9366
9367
9368
9369
9370
9371
9372
9373
9374
9375
9376
9377
9378
9379
9380
9381
9382
9383
9384
9385
9386
9387
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 9282

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)
  @maximum_retail_price = args[:maximum_retail_price] if args.key?(:maximum_retail_price)
  @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)
  @sustainability_incentives = args[:sustainability_incentives] if args.key?(:sustainability_incentives)
  @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