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 products data specification. See the Products 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.
-
#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.
-
#channel ⇒ String
Required.
-
#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.
-
#display_ads_id ⇒ String
An identifier for an item for dynamic remarketing campaigns.
-
#display_ads_link ⇒ String
URL directly to your item's landing page for dynamic remarketing campaigns.
-
#display_ads_similar_ids ⇒ Array<String>
Advertiser-specified recommendations.
-
#display_ads_title ⇒ String
Title of an item for dynamic remarketing campaigns.
-
#display_ads_value ⇒ Float
Offer margin for dynamic remarketing campaigns.
-
#energy_efficiency_class ⇒ String
The energy efficiency class as defined in EU directive 2010/30/EU.
-
#excluded_destinations ⇒ Array<String>
The list of destinations to exclude for this target (corresponds to unchecked check boxes in Merchant Center).
-
#expiration_date ⇒ String
Date on which the item should expire, as specified upon insertion, in ISO 8601 format.
-
#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
Number and amount of installments to pay for an item.
-
#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.
-
#link ⇒ String
URL directly linking to your item's page on your website.
-
#link_template ⇒ String
URL template for merchant hosted local storefront.
-
#loyalty_points ⇒ Google::Apis::ContentV2_1::LoyaltyPoints
Loyalty points that users receive after purchasing the item.
-
#material ⇒ String
The material of which the item is made.
-
#max_energy_efficiency_class ⇒ String
The energy efficiency class as defined in EU directive 2010/30/EU.
-
#max_handling_time ⇒ 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 (e.g. polka dots).
-
#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 products 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 products 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
The source of the offer, i.e., how the offer was created.
-
#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.
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.
10644 10645 10646 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10644 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
10155 10156 10157 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10155 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
10161 10162 10163 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10161 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
10166 10167 10168 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10166 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
10171 10172 10173 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10171 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
10177 10178 10179 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10177 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
10182 10183 10184 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10182 def adult @adult end |
#age_group ⇒ String
Target age group of the item.
Corresponds to the JSON property ageGroup
10188 10189 10190 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10188 def age_group @age_group end |
#availability ⇒ String
Availability status of the item.
Corresponds to the JSON property availability
10193 10194 10195 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10193 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
10199 10200 10201 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10199 def availability_date @availability_date end |
#brand ⇒ String
Brand of the item.
Corresponds to the JSON property brand
10204 10205 10206 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10204 def brand @brand end |
#canonical_link ⇒ String
URL for the canonical version of your item's landing page.
Corresponds to the JSON property canonicalLink
10209 10210 10211 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10209 def canonical_link @canonical_link end |
#channel ⇒ String
Required. The item's channel (online or local). Acceptable values are: - "
local" - "online"
Corresponds to the JSON property channel
10215 10216 10217 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10215 def channel @channel end |
#color ⇒ String
Color of the item.
Corresponds to the JSON property color
10220 10221 10222 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10220 def color @color end |
#condition ⇒ String
Condition or state of the item.
Corresponds to the JSON property condition
10225 10226 10227 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10225 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
10230 10231 10232 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10230 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
10235 10236 10237 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10235 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 (e.g.,
"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 propertycustomAttributes`
10244 10245 10246 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10244 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
10249 10250 10251 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10249 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
10254 10255 10256 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10254 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
10259 10260 10261 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10259 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
10264 10265 10266 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10264 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
10269 10270 10271 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10269 def custom_label4 @custom_label4 end |
#description ⇒ String
Description of the item.
Corresponds to the JSON property description
10274 10275 10276 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10274 def description @description end |
#display_ads_id ⇒ String
An identifier for an item for dynamic remarketing campaigns.
Corresponds to the JSON property displayAdsId
10279 10280 10281 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10279 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
10284 10285 10286 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10284 def display_ads_link @display_ads_link end |
#display_ads_similar_ids ⇒ Array<String>
Advertiser-specified recommendations.
Corresponds to the JSON property displayAdsSimilarIds
10289 10290 10291 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10289 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
10294 10295 10296 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10294 def display_ads_title @display_ads_title end |
#display_ads_value ⇒ Float
Offer margin for dynamic remarketing campaigns.
Corresponds to the JSON property displayAdsValue
10299 10300 10301 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10299 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
10304 10305 10306 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10304 def energy_efficiency_class @energy_efficiency_class end |
#excluded_destinations ⇒ Array<String>
The list of destinations to exclude for this target (corresponds to unchecked
check boxes in Merchant Center).
Corresponds to the JSON property excludedDestinations
10310 10311 10312 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10310 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
10318 10319 10320 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10318 def expiration_date @expiration_date end |
#gender ⇒ String
Target gender of the item.
Corresponds to the JSON property gender
10323 10324 10325 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10323 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
10331 10332 10333 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10331 def google_product_category @google_product_category end |
#gtin ⇒ String
Global Trade Item Number (GTIN) of the item.
Corresponds to the JSON property gtin
10336 10337 10338 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10336 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 is of the form
channel:contentLanguage: targetCountry: offerId.
Corresponds to the JSON property id
10343 10344 10345 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10343 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
10350 10351 10352 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10350 def identifier_exists @identifier_exists end |
#image_link ⇒ String
URL of an image of the item.
Corresponds to the JSON property imageLink
10356 10357 10358 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10356 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
10363 10364 10365 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10363 def included_destinations @included_destinations end |
#installment ⇒ Google::Apis::ContentV2_1::Installment
Number and amount of installments to pay for an item.
Corresponds to the JSON property installment
10368 10369 10370 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10368 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
10374 10375 10376 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10374 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
10380 10381 10382 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10380 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
10386 10387 10388 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10386 def kind @kind end |
#link ⇒ String
URL directly linking to your item's page on your website.
Corresponds to the JSON property link
10391 10392 10393 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10391 def link @link end |
#link_template ⇒ String
URL template for merchant hosted local storefront.
Corresponds to the JSON property linkTemplate
10396 10397 10398 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10396 def link_template @link_template end |
#loyalty_points ⇒ Google::Apis::ContentV2_1::LoyaltyPoints
Loyalty points that users receive after purchasing the item. Japan only.
Corresponds to the JSON property loyaltyPoints
10401 10402 10403 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10401 def loyalty_points @loyalty_points end |
#material ⇒ String
The material of which the item is made.
Corresponds to the JSON property material
10406 10407 10408 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10406 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
10411 10412 10413 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10411 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
10416 10417 10418 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10416 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
10421 10422 10423 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10421 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
10426 10427 10428 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10426 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
10431 10432 10433 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10431 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
10436 10437 10438 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10436 def mobile_link_template @mobile_link_template end |
#mpn ⇒ String
Manufacturer Part Number (MPN) of the item.
Corresponds to the JSON property mpn
10441 10442 10443 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10441 def mpn @mpn end |
#multipack ⇒ Fixnum
The number of identical products in a merchant-defined multipack.
Corresponds to the JSON property multipack
10446 10447 10448 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10446 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
10455 10456 10457 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10455 def offer_id @offer_id end |
#pattern ⇒ String
The item's pattern (e.g. polka dots).
Corresponds to the JSON property pattern
10460 10461 10462 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10460 def pattern @pattern 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
10466 10467 10468 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10466 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
10473 10474 10475 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10473 def pickup_sla @pickup_sla end |
#price ⇒ Google::Apis::ContentV2_1::Price
Price of the item.
Corresponds to the JSON property price
10478 10479 10480 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10478 def price @price end |
#product_details ⇒ Array<Google::Apis::ContentV2_1::ProductProductDetail>
Technical specification or additional product details.
Corresponds to the JSON property productDetails
10483 10484 10485 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10483 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
10489 10490 10491 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10489 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
10494 10495 10496 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10494 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
10500 10501 10502 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10500 def product_length @product_length end |
#product_types ⇒ Array<String>
Categories of the item (formatted as in products data specification).
Corresponds to the JSON property productTypes
10505 10506 10507 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10505 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
10511 10512 10513 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10511 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
10517 10518 10519 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10517 def product_width @product_width end |
#promotion_ids ⇒ Array<String>
The unique ID of a promotion.
Corresponds to the JSON property promotionIds
10522 10523 10524 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10522 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
10527 10528 10529 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10527 def sale_price @sale_price end |
#sale_price_effective_date ⇒ String
Date range during which the item is on sale (see products data specification ).
Corresponds to the JSON property salePriceEffectiveDate
10532 10533 10534 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10532 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
10538 10539 10540 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10538 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
10543 10544 10545 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10543 def shipping @shipping end |
#shipping_height ⇒ Google::Apis::ContentV2_1::ProductShippingDimension
Height of the item for shipping.
Corresponds to the JSON property shippingHeight
10548 10549 10550 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10548 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
10554 10555 10556 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10554 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
10559 10560 10561 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10559 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
10564 10565 10566 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10564 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
10569 10570 10571 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10569 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
10576 10577 10578 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10576 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
10581 10582 10583 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10581 def size_system @size_system end |
#size_type ⇒ String
The cut of the item. Recommended for apparel items.
Corresponds to the JSON property sizeType
10586 10587 10588 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10586 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
10593 10594 10595 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10593 def sizes @sizes end |
#source ⇒ String
The source of the offer, i.e., how the offer was created. Acceptable values
are: - "api" - "crawl" - "feed"
Corresponds to the JSON property source
10599 10600 10601 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10599 def source @source 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
10605 10606 10607 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10605 def subscription_cost @subscription_cost end |
#target_country ⇒ String
Required. The CLDR territory code for the item.
Corresponds to the JSON property targetCountry
10610 10611 10612 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10610 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
10616 10617 10618 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10616 def tax_category @tax_category end |
#taxes ⇒ Array<Google::Apis::ContentV2_1::ProductTax>
Tax information.
Corresponds to the JSON property taxes
10621 10622 10623 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10621 def taxes @taxes end |
#title ⇒ String
Title of the item.
Corresponds to the JSON property title
10626 10627 10628 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10626 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
10632 10633 10634 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10632 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
10637 10638 10639 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10637 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
10642 10643 10644 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10642 def unit_pricing_measure @unit_pricing_measure end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
10649 10650 10651 10652 10653 10654 10655 10656 10657 10658 10659 10660 10661 10662 10663 10664 10665 10666 10667 10668 10669 10670 10671 10672 10673 10674 10675 10676 10677 10678 10679 10680 10681 10682 10683 10684 10685 10686 10687 10688 10689 10690 10691 10692 10693 10694 10695 10696 10697 10698 10699 10700 10701 10702 10703 10704 10705 10706 10707 10708 10709 10710 10711 10712 10713 10714 10715 10716 10717 10718 10719 10720 10721 10722 10723 10724 10725 10726 10727 10728 10729 10730 10731 10732 10733 10734 10735 10736 10737 10738 10739 |
# File 'lib/google/apis/content_v2_1/classes.rb', line 10649 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) @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) @channel = args[:channel] if args.key?(:channel) @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) @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) @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) @link = args[:link] if args.key?(:link) @link_template = args[:link_template] if args.key?(:link_template) @loyalty_points = args[:loyalty_points] if args.key?(:loyalty_points) @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) @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) @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) end |