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

Inherits:

Object

• Object
• Google::Apis::ContentV2_1::Segments

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

• #date ⇒ Google::Apis::ContentV2_1::Date

  Represents a whole or partial calendar date, such as a birthday.

• #offer_id ⇒ String

  Merchant-provided id of the product.

• #program ⇒ String

  Program to which metrics apply, e.g., Free Product Listing.

Instance Method Summary

• #initialize(**args) ⇒ Segments constructor

  A new instance of Segments.

• #update!(**args) ⇒ Object

  Update properties of this object.

Constructor Details

#initialize(**args) ⇒ Segments

Returns a new instance of Segments.

# File 'lib/google/apis/content_v2_1/classes.rb', line 13183

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

Instance Attribute Details

#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:

• (Google::Apis::ContentV2_1::Date)

# File 'lib/google/apis/content_v2_1/classes.rb', line 13171

def date
  @date
end

#offer_id ⇒ String

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

Returns:

• (String)

# File 'lib/google/apis/content_v2_1/classes.rb', line 13176

def offer_id
  @offer_id
end

#program ⇒ String

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

Returns:

• (String)

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

def program
  @program
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

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

def update!(**args)
  @date = args[:date] if args.key?(:date)
  @offer_id = args[:offer_id] if args.key?(:offer_id)
  @program = args[:program] if args.key?(:program)
end