Class: Google::Apis::ContentV2_1::ProductView

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

Product fields. Values are only set for fields requested explicitly in the request's search query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ ProductView

Returns a new instance of ProductView.



10425
10426
10427
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10425

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

Instance Attribute Details

#aggregated_destination_status ⇒ String

Aggregated destination status. Corresponds to the JSON property aggregatedDestinationStatus

Returns:

  • (String) 


10258
10259
10260
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10258

def aggregated_destination_status
  @aggregated_destination_status
end

#availability ⇒ String

Availability of the product. Corresponds to the JSON property availability

Returns:

  • (String) 


10263
10264
10265
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10263

def availability
  @availability
end

#brand ⇒ String

Brand of the product. Corresponds to the JSON property brand

Returns:

  • (String) 


10268
10269
10270
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10268

def brand
  @brand
end

#category_l1 ⇒ String

First level of the product category in Google's product taxonomy. Corresponds to the JSON property categoryL1

Returns:

  • (String) 


10274
10275
10276
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10274

def category_l1
  @category_l1
end

#category_l2 ⇒ String

Second level of the product category in Google's product taxonomy. Corresponds to the JSON property categoryL2

Returns:

  • (String) 


10280
10281
10282
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10280

def category_l2
  @category_l2
end

#category_l3 ⇒ String

Third level of the product category in Google's product taxonomy. Corresponds to the JSON property categoryL3

Returns:

  • (String) 


10286
10287
10288
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10286

def category_l3
  @category_l3
end

#category_l4 ⇒ String

Fourth level of the product category in Google's product taxonomy. Corresponds to the JSON property categoryL4

Returns:

  • (String) 


10292
10293
10294
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10292

def category_l4
  @category_l4
end

#category_l5 ⇒ String

Fifth level of the product category in Google's product taxonomy. Corresponds to the JSON property categoryL5

Returns:

  • (String) 


10298
10299
10300
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10298

def category_l5
  @category_l5
end

#channel ⇒ String

Channel of the product (online versus local). Corresponds to the JSON property channel

Returns:

  • (String) 


10303
10304
10305
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10303

def channel
  @channel
end

#click_potential ⇒ String

Estimated performance potential compared to highest performing products of the merchant. Corresponds to the JSON property clickPotential

Returns:

  • (String) 


10309
10310
10311
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10309

def click_potential
  @click_potential
end

#click_potential_rank ⇒ Fixnum

Rank of the product based on its click potential. A product with click_potential_rank 1 has the highest click potential among the merchant's products that fulfill the search query conditions. Corresponds to the JSON property clickPotentialRank

Returns:

  • (Fixnum) 


10316
10317
10318
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10316

def click_potential_rank
  @click_potential_rank
end

#condition ⇒ String

Condition of the product. Corresponds to the JSON property condition

Returns:

  • (String) 


10321
10322
10323
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10321

def condition
  @condition
end

#creation_time ⇒ String

The time the merchant created the product in timestamp seconds. Corresponds to the JSON property creationTime

Returns:

  • (String) 


10326
10327
10328
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10326

def creation_time
  @creation_time
end

#currency_code ⇒ String

Product price currency code (for example, ISO 4217). Absent if product price is not available. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


10332
10333
10334
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10332

def currency_code
  @currency_code
end

#expiration_date ⇒ Google::Apis::ContentV2_1::Date

Represents a whole or partial calendar date, such as a birthday. The time of day and time zone are either specified elsewhere or are insignificant. The date is relative to the Gregorian Calendar. This can represent one of the following: * A full date, with non-zero year, month, and day values. * A month and day, with a zero year (for example, an anniversary). * A year on its own, with a zero month and a zero day. * A year and month, with a zero day (for example, a credit card expiration date). Related types: * google.type. TimeOfDay * google.type.DateTime * google.protobuf.Timestamp Corresponds to the JSON property expirationDate

Returns:



10344
10345
10346
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10344

def expiration_date
  @expiration_date
end

#gtin ⇒ Array<String>

GTIN of the product. Corresponds to the JSON property gtin

Returns:

  • (Array<String>) 


10349
10350
10351
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10349

def gtin
  @gtin
end

#id ⇒ String

The REST ID of the product, in the form of channel:contentLanguage: targetCountry:offerId. Content API methods that operate on products take this as their productId parameter. Should always be included in the SELECT clause. Corresponds to the JSON property id

Returns:

  • (String) 


10356
10357
10358
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10356

def id
  @id
end

#item_group_id ⇒ String

Item group ID provided by the merchant for grouping variants together. Corresponds to the JSON property itemGroupId

Returns:

  • (String) 


10361
10362
10363
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10361

def item_group_id
  @item_group_id
end

#item_issues ⇒ Array<Google::Apis::ContentV2_1::ProductViewItemIssue>

List of item issues for the product. Corresponds to the JSON property itemIssues

Returns:



10366
10367
10368
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10366

def item_issues
  @item_issues
end

#language_code ⇒ String

Language code of the product in BCP 47 format. Corresponds to the JSON property languageCode

Returns:

  • (String) 


10371
10372
10373
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10371

def language_code
  @language_code
end

#offer_id ⇒ String

Merchant-provided id of the product. Corresponds to the JSON property offerId

Returns:

  • (String) 


10376
10377
10378
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10376

def offer_id
  @offer_id
end

#price_micros ⇒ Fixnum

Product price specified as micros (1 millionth of a standard unit, 1 USD = 1000000 micros) in the product currency. Absent in case the information about the price of the product is not available. Corresponds to the JSON property priceMicros

Returns:

  • (Fixnum) 


10383
10384
10385
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10383

def price_micros
  @price_micros
end

#product_type_l1 ⇒ String

First level of the product type in merchant's own product taxonomy. Corresponds to the JSON property productTypeL1

Returns:

  • (String) 


10389
10390
10391
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10389

def product_type_l1
  @product_type_l1
end

#product_type_l2 ⇒ String

Second level of the product type in merchant's own product taxonomy. Corresponds to the JSON property productTypeL2

Returns:

  • (String) 


10395
10396
10397
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10395

def product_type_l2
  @product_type_l2
end

#product_type_l3 ⇒ String

Third level of the product type in merchant's own product taxonomy. Corresponds to the JSON property productTypeL3

Returns:

  • (String) 


10401
10402
10403
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10401

def product_type_l3
  @product_type_l3
end

#product_type_l4 ⇒ String

Fourth level of the product type in merchant's own product taxonomy. Corresponds to the JSON property productTypeL4

Returns:

  • (String) 


10407
10408
10409
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10407

def product_type_l4
  @product_type_l4
end

#product_type_l5 ⇒ String

Fifth level of the product type in merchant's own product taxonomy. Corresponds to the JSON property productTypeL5

Returns:

  • (String) 


10413
10414
10415
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10413

def product_type_l5
  @product_type_l5
end

#shipping_label ⇒ String

The normalized shipping label specified in the feed Corresponds to the JSON property shippingLabel

Returns:

  • (String) 


10418
10419
10420
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10418

def shipping_label
  @shipping_label
end

#title ⇒ String

Title of the product. Corresponds to the JSON property title

Returns:

  • (String) 


10423
10424
10425
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10423

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10430
10431
10432
10433
10434
10435
10436
10437
10438
10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10430

def update!(**args)
  @aggregated_destination_status = args[:aggregated_destination_status] if args.key?(:aggregated_destination_status)
  @availability = args[:availability] if args.key?(:availability)
  @brand = args[:brand] if args.key?(:brand)
  @category_l1 = args[:category_l1] if args.key?(:category_l1)
  @category_l2 = args[:category_l2] if args.key?(:category_l2)
  @category_l3 = args[:category_l3] if args.key?(:category_l3)
  @category_l4 = args[:category_l4] if args.key?(:category_l4)
  @category_l5 = args[:category_l5] if args.key?(:category_l5)
  @channel = args[:channel] if args.key?(:channel)
  @click_potential = args[:click_potential] if args.key?(:click_potential)
  @click_potential_rank = args[:click_potential_rank] if args.key?(:click_potential_rank)
  @condition = args[:condition] if args.key?(:condition)
  @creation_time = args[:creation_time] if args.key?(:creation_time)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @expiration_date = args[:expiration_date] if args.key?(:expiration_date)
  @gtin = args[:gtin] if args.key?(:gtin)
  @id = args[:id] if args.key?(:id)
  @item_group_id = args[:item_group_id] if args.key?(:item_group_id)
  @item_issues = args[:item_issues] if args.key?(:item_issues)
  @language_code = args[:language_code] if args.key?(:language_code)
  @offer_id = args[:offer_id] if args.key?(:offer_id)
  @price_micros = args[:price_micros] if args.key?(:price_micros)
  @product_type_l1 = args[:product_type_l1] if args.key?(:product_type_l1)
  @product_type_l2 = args[:product_type_l2] if args.key?(:product_type_l2)
  @product_type_l3 = args[:product_type_l3] if args.key?(:product_type_l3)
  @product_type_l4 = args[:product_type_l4] if args.key?(:product_type_l4)
  @product_type_l5 = args[:product_type_l5] if args.key?(:product_type_l5)
  @shipping_label = args[:shipping_label] if args.key?(:shipping_label)
  @title = args[:title] if args.key?(:title)
end