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.



10434
10435
10436
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10434

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

Instance Attribute Details

#aggregated_destination_status ⇒ String

Aggregated destination status. Corresponds to the JSON property aggregatedDestinationStatus

Returns:

  • (String) 


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

def aggregated_destination_status
  @aggregated_destination_status
end

#availability ⇒ String

Availability of the product. Corresponds to the JSON property availability

Returns:

  • (String) 


10272
10273
10274
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10272

def availability
  @availability
end

#brand ⇒ String

Brand of the product. Corresponds to the JSON property brand

Returns:

  • (String) 


10277
10278
10279
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10277

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) 


10283
10284
10285
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10283

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) 


10289
10290
10291
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10289

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) 


10295
10296
10297
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10295

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) 


10301
10302
10303
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10301

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) 


10307
10308
10309
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10307

def category_l5
  @category_l5
end

#channel ⇒ String

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

Returns:

  • (String) 


10312
10313
10314
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10312

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) 


10318
10319
10320
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10318

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) 


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

def click_potential_rank
  @click_potential_rank
end

#condition ⇒ String

Condition of the product. Corresponds to the JSON property condition

Returns:

  • (String) 


10330
10331
10332
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10330

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) 


10335
10336
10337
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10335

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) 


10341
10342
10343
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10341

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:



10353
10354
10355
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10353

def expiration_date
  @expiration_date
end

#gtin ⇒ Array<String>

GTIN of the product. Corresponds to the JSON property gtin

Returns:

  • (Array<String>) 


10358
10359
10360
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10358

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) 


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

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) 


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

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:



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

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) 


10380
10381
10382
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10380

def language_code
  @language_code
end

#offer_id ⇒ String

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

Returns:

  • (String) 


10385
10386
10387
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10385

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) 


10392
10393
10394
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10392

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) 


10398
10399
10400
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10398

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) 


10404
10405
10406
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10404

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) 


10410
10411
10412
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10410

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) 


10416
10417
10418
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10416

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) 


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

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) 


10427
10428
10429
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10427

def shipping_label
  @shipping_label
end

#title ⇒ String

Title of the product. Corresponds to the JSON property title

Returns:

  • (String) 


10432
10433
10434
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10432

def title
  @title
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10439
10440
10441
10442
10443
10444
10445
10446
10447
10448
10449
10450
10451
10452
10453
10454
10455
10456
10457
10458
10459
10460
10461
10462
10463
10464
10465
10466
10467
10468
10469
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 10439

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