Class: Google::Apis::AnalyticsreportingV4::SegmentFilter
- Inherits:
-
Object
- Object
- Google::Apis::AnalyticsreportingV4::SegmentFilter
- Includes:
- Core::Hashable, Core::JsonObjectSupport
- Defined in:
- generated/google/apis/analyticsreporting_v4/classes.rb,
generated/google/apis/analyticsreporting_v4/representations.rb,
generated/google/apis/analyticsreporting_v4/representations.rb
Overview
SegmentFilter defines the segment to be either a simple or a sequence segment. A simple segment condition contains dimension and metric conditions to select the sessions or users. A sequence segment condition can be used to select users or sessions based on sequential conditions.
Instance Attribute Summary collapse
-
#not ⇒ Boolean
(also: #not?)
If true, match the complement of simple or sequence segment.
-
#sequence_segment ⇒ Google::Apis::AnalyticsreportingV4::SequenceSegment
Sequence conditions consist of one or more steps, where each step is defined by one or more dimension/metric conditions.
-
#simple_segment ⇒ Google::Apis::AnalyticsreportingV4::SimpleSegment
A Simple segment conditions consist of one or more dimension/metric conditions that can be combined.
Instance Method Summary collapse
-
#initialize(**args) ⇒ SegmentFilter
constructor
A new instance of SegmentFilter.
-
#update!(**args) ⇒ Object
Update properties of this object.
Methods included from Core::JsonObjectSupport
Methods included from Core::Hashable
Constructor Details
#initialize(**args) ⇒ SegmentFilter
Returns a new instance of SegmentFilter.
889 890 891 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 889 def initialize(**args) update!(**args) end |
Instance Attribute Details
#not ⇒ Boolean Also known as: not?
If true, match the complement of simple or sequence segment.
For example, to match all visits not from "New York", we can define the
segment as follows:
"sessionSegment":
"segmentFilters": [
"simpleSegment" :
"orFiltersForSegment": [
"segmentFilterClauses":[
"dimensionFilter":
"dimensionName": "ga:city",
"expressions": ["New York"]
]
]
,
"not": "True"
]
,
Corresponds to the JSON property not
880 881 882 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 880 def not @not end |
#sequence_segment ⇒ Google::Apis::AnalyticsreportingV4::SequenceSegment
Sequence conditions consist of one or more steps, where each step is defined
by one or more dimension/metric conditions. Multiple steps can be combined
with special sequence operators.
Corresponds to the JSON property sequenceSegment
858 859 860 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 858 def sequence_segment @sequence_segment end |
#simple_segment ⇒ Google::Apis::AnalyticsreportingV4::SimpleSegment
A Simple segment conditions consist of one or more dimension/metric
conditions that can be combined.
Corresponds to the JSON property simpleSegment
887 888 889 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 887 def simple_segment @simple_segment end |
Instance Method Details
#update!(**args) ⇒ Object
Update properties of this object
894 895 896 897 898 |
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 894 def update!(**args) @sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment) @not = args[:not] if args.key?(:not) @simple_segment = args[:simple_segment] if args.key?(:simple_segment) end |