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.



14215
14216
14217
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14215

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

Instance Attribute Details

#brand ⇒ String

Brand of the product. Corresponds to the JSON property brand

Returns:

  • (String) 


14072
14073
14074
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14072

def brand
  @brand
end

#category_l1 ⇒ String

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

Returns:

  • (String) 


14079
14080
14081
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14079

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) 


14086
14087
14088
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14086

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) 


14093
14094
14095
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14093

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) 


14100
14101
14102
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14100

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) 


14107
14108
14109
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14107

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) 


14114
14115
14116
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14114

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) 


14119
14120
14121
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14119

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) 


14124
14125
14126
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14124

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) 


14129
14130
14131
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14129

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) 


14134
14135
14136
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14134

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) 


14139
14140
14141
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14139

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:



14151
14152
14153
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14151

def date
  @date
end

#offer_id ⇒ String

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

Returns:

  • (String) 


14156
14157
14158
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14156

def offer_id
  @offer_id
end

#product_type_l1 ⇒ String

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

Returns:

  • (String) 


14163
14164
14165
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14163

def product_type_l1
  @product_type_l1
end

#product_type_l2 ⇒ String

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

Returns:

  • (String) 


14170
14171
14172
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14170

def product_type_l2
  @product_type_l2
end

#product_type_l3 ⇒ String

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

Returns:

  • (String) 


14177
14178
14179
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14177

def product_type_l3
  @product_type_l3
end

#product_type_l4 ⇒ String

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

Returns:

  • (String) 


14184
14185
14186
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14184

def product_type_l4
  @product_type_l4
end

#product_type_l5 ⇒ String

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

Returns:

  • (String) 


14191
14192
14193
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14191

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) 


14196
14197
14198
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14196

def program
  @program
end

#title ⇒ String

Title of the product. Corresponds to the JSON property title

Returns:

  • (String) 


14201
14202
14203
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14201

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:



14213
14214
14215
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14213

def week
  @week
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



14220
14221
14222
14223
14224
14225
14226
14227
14228
14229
14230
14231
14232
14233
14234
14235
14236
14237
14238
14239
14240
14241
14242
14243
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 14220

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