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, such as offer_id, reflect the state of a product at the time of the corresponding event, for example, 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.



13309
13310
13311
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13309

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

Instance Attribute Details

#brand ⇒ String

Brand of the product. Corresponds to the JSON property brand

Returns:

  • (String) 


13159
13160
13161
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13159

def brand
  @brand
end

#category_l1 ⇒ String

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

Returns:

  • (String) 


13166
13167
13168
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13166

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) 


13173
13174
13175
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13173

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) 


13180
13181
13182
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13180

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) 


13187
13188
13189
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13187

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) 


13194
13195
13196
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13194

def category_l5
  @category_l5
end

#currency_code ⇒ String

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

Returns:

  • (String) 


13201
13202
13203
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13201

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) 


13206
13207
13208
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13206

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) 


13211
13212
13213
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13211

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) 


13216
13217
13218
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13216

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) 


13221
13222
13223
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13221

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) 


13226
13227
13228
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13226

def custom_label4
  @custom_label4
end

#customer_country_code ⇒ String

Code of the country where the customer is located at the time of the event. Represented in the ISO 3166 format. If the customer country cannot be determined, a special 'ZZ' code is returned. Corresponds to the JSON property customerCountryCode

Returns:

  • (String) 


13233
13234
13235
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13233

def customer_country_code
  @customer_country_code
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, 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 date

Returns:



13245
13246
13247
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13245

def date
  @date
end

#offer_id ⇒ String

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

Returns:

  • (String) 


13250
13251
13252
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13250

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) 


13257
13258
13259
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13257

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) 


13264
13265
13266
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13264

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) 


13271
13272
13273
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13271

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) 


13278
13279
13280
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13278

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) 


13285
13286
13287
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13285

def product_type_l5
  @product_type_l5
end

#program ⇒ String

Program to which metrics apply, for example, Free Product Listing. Corresponds to the JSON property program

Returns:

  • (String) 


13290
13291
13292
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13290

def program
  @program
end

#title ⇒ String

Title of the product. Corresponds to the JSON property title

Returns:

  • (String) 


13295
13296
13297
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13295

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, 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 week

Returns:



13307
13308
13309
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13307

def week
  @week
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



13314
13315
13316
13317
13318
13319
13320
13321
13322
13323
13324
13325
13326
13327
13328
13329
13330
13331
13332
13333
13334
13335
13336
13337
13338
 
# File 'lib/google/apis/content_v2_1/classes.rb', line 13314

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)
  @customer_country_code = args[:customer_country_code] if args.key?(:customer_country_code)
  @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