Class: Google::Apis::AnalyticsreportingV4::Segment

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/analyticsreporting_v4/classes.rb,
lib/google/apis/analyticsreporting_v4/representations.rb,
lib/google/apis/analyticsreporting_v4/representations.rb

Overview

The segment definition, if the report needs to be segmented. A Segment is a subset of the Analytics data. For example, of the entire set of users, one Segment might be users from a particular country or city.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ Segment

Returns a new instance of Segment.



1643
1644
1645
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1643

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

Instance Attribute Details

#dynamic_segment ⇒ Google::Apis::AnalyticsreportingV4::DynamicSegment

Dynamic segment definition for defining the segment within the request. A segment can select users, sessions or both. Corresponds to the JSON property dynamicSegment

Returns:



1636
1637
1638
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1636

def dynamic_segment
  @dynamic_segment
end

#segment_id ⇒ String

The segment ID of a built-in or custom segment, for example gaid::-3. Corresponds to the JSON property segmentId

Returns:

  • (String) 


1641
1642
1643
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1641

def segment_id
  @segment_id
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1648
1649
1650
1651
 
# File 'lib/google/apis/analyticsreporting_v4/classes.rb', line 1648

def update!(**args)
  @dynamic_segment = args[:dynamic_segment] if args.key?(:dynamic_segment)
  @segment_id = args[:segment_id] if args.key?(:segment_id)
end