Class: Google::Apis::AnalyticsreportingV4::SegmentFilter

Inherits:
Object
  • Object
show all
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

Instance Method Summary collapse

Methods included from Core::JsonObjectSupport

#to_json

Methods included from Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ SegmentFilter

Returns a new instance of SegmentFilter.



1834
1835
1836
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1834

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

Returns:

  • (Boolean) 


1818
1819
1820
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1818

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

Returns:



1826
1827
1828
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1826

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

Returns:



1832
1833
1834
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1832

def simple_segment
  @simple_segment
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1839
1840
1841
1842
1843
 
# File 'generated/google/apis/analyticsreporting_v4/classes.rb', line 1839

def update!(**args)
  @not = args[:not] if args.key?(:not)
  @sequence_segment = args[:sequence_segment] if args.key?(:sequence_segment)
  @simple_segment = args[:simple_segment] if args.key?(:simple_segment)
end