Class: Google::Apis::ContentV2_1::Segments

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

Dimensions according to which metrics are segmented in the response. Values of product dimensions, e.g., offer id, reflect the state of a product at the time of the corresponding event, e.g., impression or order. Segment fields cannot be selected in queries without also selecting at least one metric field. Values are only set for dimensions requested explicitly in the request's search query.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Segments

Returns a new instance of Segments.



13473
13474
13475
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13473

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

Instance Attribute Details

#brand ⇒ String

Brand of the product. Corresponds to the JSON property brand

Returns:

  • (String) 


13350
13351
13352
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13350

def brand
  @brand
end

#category_l1 ⇒ String

Product category (1st level) in Google's product taxonomy. Corresponds to the JSON property categoryL1

Returns:

  • (String) 


13355
13356
13357
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13355

def category_l1
  @category_l1
end

#category_l2 ⇒ String

Product category (2nd level) in Google's product taxonomy. Corresponds to the JSON property categoryL2

Returns:

  • (String) 


13360
13361
13362
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13360

def category_l2
  @category_l2
end

#category_l3 ⇒ String

Product category (3rd level) in Google's product taxonomy. Corresponds to the JSON property categoryL3

Returns:

  • (String) 


13365
13366
13367
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13365

def category_l3
  @category_l3
end

#category_l4 ⇒ String

Product category (4th level) in Google's product taxonomy. Corresponds to the JSON property categoryL4

Returns:

  • (String) 


13370
13371
13372
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13370

def category_l4
  @category_l4
end

#category_l5 ⇒ String

Product category (5th level) in Google's product taxonomy. Corresponds to the JSON property categoryL5

Returns:

  • (String) 


13375
13376
13377
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13375

def category_l5
  @category_l5
end

#currency_code ⇒ String

Currency in which price metrics are represented, e.g., if you select ordered_item_sales_micros, the returned value will be represented by this currency. Corresponds to the JSON property currencyCode

Returns:

  • (String) 


13382
13383
13384
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13382

def currency_code
  @currency_code
end

#custom_label0 ⇒ String

Custom label 0 for custom grouping of products. Corresponds to the JSON property customLabel0

Returns:

  • (String) 


13387
13388
13389
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13387

def custom_label0
  @custom_label0
end

#custom_label1 ⇒ String

Custom label 1 for custom grouping of products. Corresponds to the JSON property customLabel1

Returns:

  • (String) 


13392
13393
13394
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13392

def custom_label1
  @custom_label1
end

#custom_label2 ⇒ String

Custom label 2 for custom grouping of products. Corresponds to the JSON property customLabel2

Returns:

  • (String) 


13397
13398
13399
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13397

def custom_label2
  @custom_label2
end

#custom_label3 ⇒ String

Custom label 3 for custom grouping of products. Corresponds to the JSON property customLabel3

Returns:

  • (String) 


13402
13403
13404
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13402

def custom_label3
  @custom_label3
end

#custom_label4 ⇒ String

Custom label 4 for custom grouping of products. Corresponds to the JSON property customLabel4

Returns:

  • (String) 


13407
13408
13409
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13407

def custom_label4
  @custom_label4
end

#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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property date

Returns:



13419
13420
13421
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13419

def date
  @date
end

#offer_id ⇒ String

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

Returns:

  • (String) 


13424
13425
13426
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13424

def offer_id
  @offer_id
end

#product_type_l1 ⇒ String

Product category (1st level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL1

Returns:

  • (String) 


13429
13430
13431
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13429

def product_type_l1
  @product_type_l1
end

#product_type_l2 ⇒ String

Product category (2nd level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL2

Returns:

  • (String) 


13434
13435
13436
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13434

def product_type_l2
  @product_type_l2
end

#product_type_l3 ⇒ String

Product category (3rd level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL3

Returns:

  • (String) 


13439
13440
13441
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13439

def product_type_l3
  @product_type_l3
end

#product_type_l4 ⇒ String

Product category (4th level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL4

Returns:

  • (String) 


13444
13445
13446
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13444

def product_type_l4
  @product_type_l4
end

#product_type_l5 ⇒ String

Product category (5th level) in merchant's own product taxonomy. Corresponds to the JSON property productTypeL5

Returns:

  • (String) 


13449
13450
13451
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13449

def product_type_l5
  @product_type_l5
end

#program ⇒ String

Program to which metrics apply, e.g., Free Product Listing. Corresponds to the JSON property program

Returns:

  • (String) 


13454
13455
13456
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13454

def program
  @program
end

#title ⇒ String

Title of the product. Corresponds to the JSON property title

Returns:

  • (String) 


13459
13460
13461
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13459

def title
  @title
end

#week ⇒ 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 value, with a zero year, such as an anniversary * A year on its own, with zero month and day values * A year and month value, with a zero day, such as a credit card expiration date Related types are google.type.TimeOfDay and google.protobuf.Timestamp. Corresponds to the JSON property week

Returns:



13471
13472
13473
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13471

def week
  @week
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13478
13479
13480
13481
13482
13483
13484
13485
13486
13487
13488
13489
13490
13491
13492
13493
13494
13495
13496
13497
13498
13499
13500
13501
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13478

def update!(**args)
  @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)
  @currency_code = args[:currency_code] if args.key?(:currency_code)
  @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)
  @date = args[:date] if args.key?(:date)
  @offer_id = args[:offer_id] if args.key?(:offer_id)
  @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)
  @program = args[:program] if args.key?(:program)
  @title = args[:title] if args.key?(:title)
  @week = args[:week] if args.key?(:week)
end