Class: Google::Apis::CssV1::Attributes

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/css_v1/classes.rb,
lib/google/apis/css_v1/representations.rb,
lib/google/apis/css_v1/representations.rb

Overview

Attributes for CSS Product.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Attributes

Returns a new instance of Attributes.



413
414
415
 
# File 'lib/google/apis/css_v1/classes.rb', line 413

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

Instance Attribute Details

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

Returns:

  • (Array<String>) 


144
145
146
 
# File 'lib/google/apis/css_v1/classes.rb', line 144

def additional_image_links
  @additional_image_links
end

#adult ⇒ Boolean Also known as: adult?

Set to true if the item is targeted towards adults. Corresponds to the JSON property adult

Returns:

  • (Boolean) 


149
150
151
 
# File 'lib/google/apis/css_v1/classes.rb', line 149

def adult
  @adult
end

#age_group ⇒ String

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

Returns:

  • (String) 


155
156
157
 
# File 'lib/google/apis/css_v1/classes.rb', line 155

def age_group
  @age_group
end

#brand ⇒ String

Product Related Attributes.[14-36] Brand of the item. Corresponds to the JSON property brand

Returns:

  • (String) 


160
161
162
 
# File 'lib/google/apis/css_v1/classes.rb', line 160

def brand
  @brand
end

#certifications ⇒ Array<Google::Apis::CssV1::Certification>

A list of certificates claimed by the CSS for the given product. Corresponds to the JSON property certifications

Returns:



165
166
167
 
# File 'lib/google/apis/css_v1/classes.rb', line 165

def certifications
  @certifications
end

#color ⇒ String

Color of the item. Corresponds to the JSON property color

Returns:

  • (String) 


170
171
172
 
# File 'lib/google/apis/css_v1/classes.rb', line 170

def color
  @color
end

#cpp_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 cppAdsRedirect

Returns:

  • (String) 


176
177
178
 
# File 'lib/google/apis/css_v1/classes.rb', line 176

def cpp_ads_redirect
  @cpp_ads_redirect
end

#cpp_link ⇒ String

URL directly linking to your the Product Detail Page of the CSS. Corresponds to the JSON property cppLink

Returns:

  • (String) 


181
182
183
 
# File 'lib/google/apis/css_v1/classes.rb', line 181

def cpp_link
  @cpp_link
end

#cpp_mobile_link ⇒ String

URL for the mobile-optimized version of the Product Detail Page of the CSS. Corresponds to the JSON property cppMobileLink

Returns:

  • (String) 


186
187
188
 
# File 'lib/google/apis/css_v1/classes.rb', line 186

def cpp_mobile_link
  @cpp_mobile_link
end

#custom_label0 ⇒ String

Custom label 0 for custom grouping of items in a Shopping campaign. Corresponds to the JSON property customLabel0

Returns:

  • (String) 


191
192
193
 
# File 'lib/google/apis/css_v1/classes.rb', line 191

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) 


196
197
198
 
# File 'lib/google/apis/css_v1/classes.rb', line 196

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) 


201
202
203
 
# File 'lib/google/apis/css_v1/classes.rb', line 201

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) 


206
207
208
 
# File 'lib/google/apis/css_v1/classes.rb', line 206

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) 


211
212
213
 
# File 'lib/google/apis/css_v1/classes.rb', line 211

def custom_label4
  @custom_label4
end

#description ⇒ String

Description of the item. Corresponds to the JSON property description

Returns:

  • (String) 


216
217
218
 
# File 'lib/google/apis/css_v1/classes.rb', line 216

def description
  @description
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

Returns:

  • (Array<String>) 


222
223
224
 
# File 'lib/google/apis/css_v1/classes.rb', line 222

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 is exposed in productstatuses as googleExpirationDate and might be earlier if expirationDate is too far in the future. Note: It may take 2+ days from the expiration date for the item to actually get deleted. Corresponds to the JSON property expirationDate

Returns:

  • (String) 


232
233
234
 
# File 'lib/google/apis/css_v1/classes.rb', line 232

def expiration_date
  @expiration_date
end

#gender ⇒ String

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

Returns:

  • (String) 


237
238
239
 
# File 'lib/google/apis/css_v1/classes.rb', line 237

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) 


245
246
247
 
# File 'lib/google/apis/css_v1/classes.rb', line 245

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) 


251
252
253
 
# File 'lib/google/apis/css_v1/classes.rb', line 251

def gtin
  @gtin
end

#headline_offer_condition ⇒ String

Condition of the headline offer. Corresponds to the JSON property headlineOfferCondition

Returns:

  • (String) 


256
257
258
 
# File 'lib/google/apis/css_v1/classes.rb', line 256

def headline_offer_condition
  @headline_offer_condition
end

#headline_offer_installment ⇒ Google::Apis::CssV1::HeadlineOfferInstallment

A message that represents installment. Corresponds to the JSON property headlineOfferInstallment

Returns:



261
262
263
 
# File 'lib/google/apis/css_v1/classes.rb', line 261

def headline_offer_installment
  @headline_offer_installment
end

#headline_offer_link ⇒ String

Link to the headline offer. Corresponds to the JSON property headlineOfferLink

Returns:

  • (String) 


266
267
268
 
# File 'lib/google/apis/css_v1/classes.rb', line 266

def headline_offer_link
  @headline_offer_link
end

#headline_offer_mobile_link ⇒ String

Mobile Link to the headline offer. Corresponds to the JSON property headlineOfferMobileLink

Returns:

  • (String) 


271
272
273
 
# File 'lib/google/apis/css_v1/classes.rb', line 271

def headline_offer_mobile_link
  @headline_offer_mobile_link
end

#headline_offer_price ⇒ Google::Apis::CssV1::Price

The price represented as a number and currency. Corresponds to the JSON property headlineOfferPrice

Returns:



276
277
278
 
# File 'lib/google/apis/css_v1/classes.rb', line 276

def headline_offer_price
  @headline_offer_price
end

#headline_offer_shipping_price ⇒ Google::Apis::CssV1::Price

The price represented as a number and currency. Corresponds to the JSON property headlineOfferShippingPrice

Returns:



281
282
283
 
# File 'lib/google/apis/css_v1/classes.rb', line 281

def headline_offer_shipping_price
  @headline_offer_shipping_price
end

#headline_offer_subscription_cost ⇒ Google::Apis::CssV1::HeadlineOfferSubscriptionCost

The SubscriptionCost of the product. Corresponds to the JSON property headlineOfferSubscriptionCost

Returns:



286
287
288
 
# File 'lib/google/apis/css_v1/classes.rb', line 286

def headline_offer_subscription_cost
  @headline_offer_subscription_cost
end

#high_price ⇒ Google::Apis::CssV1::Price

The price represented as a number and currency. Corresponds to the JSON property highPrice

Returns:



291
292
293
 
# File 'lib/google/apis/css_v1/classes.rb', line 291

def high_price
  @high_price
end

#image_link ⇒ String

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

Returns:

  • (String) 


296
297
298
 
# File 'lib/google/apis/css_v1/classes.rb', line 296

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>) 


303
304
305
 
# File 'lib/google/apis/css_v1/classes.rb', line 303

def included_destinations
  @included_destinations
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) 


309
310
311
 
# File 'lib/google/apis/css_v1/classes.rb', line 309

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) 


315
316
317
 
# File 'lib/google/apis/css_v1/classes.rb', line 315

def item_group_id
  @item_group_id
end

#low_price ⇒ Google::Apis::CssV1::Price

The price represented as a number and currency. Corresponds to the JSON property lowPrice

Returns:



320
321
322
 
# File 'lib/google/apis/css_v1/classes.rb', line 320

def low_price
  @low_price
end

#material ⇒ String

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

Returns:

  • (String) 


325
326
327
 
# File 'lib/google/apis/css_v1/classes.rb', line 325

def material
  @material
end

#mpn ⇒ String

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

Returns:

  • (String) 


331
332
333
 
# File 'lib/google/apis/css_v1/classes.rb', line 331

def mpn
  @mpn
end

#multipack ⇒ Fixnum

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

Returns:

  • (Fixnum) 


336
337
338
 
# File 'lib/google/apis/css_v1/classes.rb', line 336

def multipack
  @multipack
end

#number_of_offers ⇒ Fixnum

The number of aggregate offers. Corresponds to the JSON property numberOfOffers

Returns:

  • (Fixnum) 


341
342
343
 
# File 'lib/google/apis/css_v1/classes.rb', line 341

def number_of_offers
  @number_of_offers
end

#pattern ⇒ String

The item's pattern (e.g. polka dots). Corresponds to the JSON property pattern

Returns:

  • (String) 


346
347
348
 
# File 'lib/google/apis/css_v1/classes.rb', line 346

def pattern
  @pattern
end

#pause ⇒ String

Publication of this item will be temporarily paused. Corresponds to the JSON property pause

Returns:

  • (String) 


351
352
353
 
# File 'lib/google/apis/css_v1/classes.rb', line 351

def pause
  @pause
end

#product_details ⇒ Array<Google::Apis::CssV1::ProductDetail>

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

Returns:



356
357
358
 
# File 'lib/google/apis/css_v1/classes.rb', line 356

def product_details
  @product_details
end

#product_height ⇒ Google::Apis::CssV1::ProductDimension

The dimension of the product. Corresponds to the JSON property productHeight

Returns:



361
362
363
 
# File 'lib/google/apis/css_v1/classes.rb', line 361

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>) 


366
367
368
 
# File 'lib/google/apis/css_v1/classes.rb', line 366

def product_highlights
  @product_highlights
end

#product_length ⇒ Google::Apis::CssV1::ProductDimension

The dimension of the product. Corresponds to the JSON property productLength

Returns:



371
372
373
 
# File 'lib/google/apis/css_v1/classes.rb', line 371

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

Returns:

  • (Array<String>) 


377
378
379
 
# File 'lib/google/apis/css_v1/classes.rb', line 377

def product_types
  @product_types
end

#product_weight ⇒ Google::Apis::CssV1::ProductWeight

The weight of the product. Corresponds to the JSON property productWeight

Returns:



382
383
384
 
# File 'lib/google/apis/css_v1/classes.rb', line 382

def product_weight
  @product_weight
end

#product_width ⇒ Google::Apis::CssV1::ProductDimension

The dimension of the product. Corresponds to the JSON property productWidth

Returns:



387
388
389
 
# File 'lib/google/apis/css_v1/classes.rb', line 387

def product_width
  @product_width
end

#size ⇒ 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 https://support.google.com/merchants/answer/6324492). Corresponds to the JSON property size

Returns:

  • (String) 


394
395
396
 
# File 'lib/google/apis/css_v1/classes.rb', line 394

def size
  @size
end

#size_system ⇒ String

System in which the size is specified. Recommended for apparel items. Corresponds to the JSON property sizeSystem

Returns:

  • (String) 


399
400
401
 
# File 'lib/google/apis/css_v1/classes.rb', line 399

def size_system
  @size_system
end

#size_types ⇒ Array<String>

The cut of the item. It can be used to represent combined size types for apparel items. Maximum two of size types can be provided (see https://support. google.com/merchants/answer/6324497). Corresponds to the JSON property sizeTypes

Returns:

  • (Array<String>) 


406
407
408
 
# File 'lib/google/apis/css_v1/classes.rb', line 406

def size_types
  @size_types
end

#title ⇒ String

Title of the item. Corresponds to the JSON property title

Returns:

  • (String) 


411
412
413
 
# File 'lib/google/apis/css_v1/classes.rb', line 411

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
 
# File 'lib/google/apis/css_v1/classes.rb', line 418

def update!(**args)
  @additional_image_links = args[:additional_image_links] if args.key?(:additional_image_links)
  @adult = args[:adult] if args.key?(:adult)
  @age_group = args[:age_group] if args.key?(:age_group)
  @brand = args[:brand] if args.key?(:brand)
  @certifications = args[:certifications] if args.key?(:certifications)
  @color = args[:color] if args.key?(:color)
  @cpp_ads_redirect = args[:cpp_ads_redirect] if args.key?(:cpp_ads_redirect)
  @cpp_link = args[:cpp_link] if args.key?(:cpp_link)
  @cpp_mobile_link = args[:cpp_mobile_link] if args.key?(:cpp_mobile_link)
  @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)
  @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)
  @headline_offer_condition = args[:headline_offer_condition] if args.key?(:headline_offer_condition)
  @headline_offer_installment = args[:headline_offer_installment] if args.key?(:headline_offer_installment)
  @headline_offer_link = args[:headline_offer_link] if args.key?(:headline_offer_link)
  @headline_offer_mobile_link = args[:headline_offer_mobile_link] if args.key?(:headline_offer_mobile_link)
  @headline_offer_price = args[:headline_offer_price] if args.key?(:headline_offer_price)
  @headline_offer_shipping_price = args[:headline_offer_shipping_price] if args.key?(:headline_offer_shipping_price)
  @headline_offer_subscription_cost = args[:headline_offer_subscription_cost] if args.key?(:headline_offer_subscription_cost)
  @high_price = args[:high_price] if args.key?(:high_price)
  @image_link = args[:image_link] if args.key?(:image_link)
  @included_destinations = args[:included_destinations] if args.key?(:included_destinations)
  @is_bundle = args[:is_bundle] if args.key?(:is_bundle)
  @item_group_id = args[:item_group_id] if args.key?(:item_group_id)
  @low_price = args[:low_price] if args.key?(:low_price)
  @material = args[:material] if args.key?(:material)
  @mpn = args[:mpn] if args.key?(:mpn)
  @multipack = args[:multipack] if args.key?(:multipack)
  @number_of_offers = args[:number_of_offers] if args.key?(:number_of_offers)
  @pattern = args[:pattern] if args.key?(:pattern)
  @pause = args[:pause] if args.key?(:pause)
  @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)
  @size = args[:size] if args.key?(:size)
  @size_system = args[:size_system] if args.key?(:size_system)
  @size_types = args[:size_types] if args.key?(:size_types)
  @title = args[:title] if args.key?(:title)
end