Class: Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/analytics/admin/v1alpha/audience.rb

Overview

A specific filter for a single dimension or metric.

Defined Under Namespace

Classes: BetweenFilter, InListFilter, NumericFilter, NumericValue, StringFilter

Instance Attribute Summary collapse

Instance Attribute Details

#at_any_point_in_time ⇒ ::Boolean

Returns Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them.

This can only be set when Audience scope is ACROSS_ALL_SESSIONS.

Returns:

  • (::Boolean) —

    Optional. Indicates whether this filter needs dynamic evaluation or not. If set to true, users join the Audience if they ever met the condition (static evaluation). If unset or set to false, user evaluation for an Audience is dynamic; users are added to an Audience when they meet the conditions and then removed when they no longer meet them.

    This can only be set when Audience scope is ACROSS_ALL_SESSIONS.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 68

class AudienceDimensionOrMetricFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A filter for a string-type dimension that matches a particular pattern.
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter::MatchType]
  #     Required. The match type for the string filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The string value to be matched against.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type for the string filter.
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression matches with the string value.
      FULL_REGEXP = 5
    end
  end

  # A filter for a string dimension that matches a particular list of options.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     Required. The list of possible string values to match against. Must be
  #     non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # To represent a number.
  # @!attribute [rw] int64_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     Double value.
  class NumericValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A filter for numeric or date values on a dimension or metric.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
  #     Required. The operation applied to a numeric filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. The numeric or date value to match against.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter.
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal.
      EQUAL = 1

      # Less than.
      LESS_THAN = 2

      # Greater than.
      GREATER_THAN = 4
    end
  end

  # A filter for numeric or date values between certain values on a dimension
  # or metric.
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Begins with this number, inclusive.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Ends with this number, inclusive.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#between_filter ⇒ ::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::BetweenFilter

Returns A filter for numeric or date values between certain values on a dimension or metric.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 68

class AudienceDimensionOrMetricFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A filter for a string-type dimension that matches a particular pattern.
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter::MatchType]
  #     Required. The match type for the string filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The string value to be matched against.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type for the string filter.
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression matches with the string value.
      FULL_REGEXP = 5
    end
  end

  # A filter for a string dimension that matches a particular list of options.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     Required. The list of possible string values to match against. Must be
  #     non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # To represent a number.
  # @!attribute [rw] int64_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     Double value.
  class NumericValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A filter for numeric or date values on a dimension or metric.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
  #     Required. The operation applied to a numeric filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. The numeric or date value to match against.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter.
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal.
      EQUAL = 1

      # Less than.
      LESS_THAN = 2

      # Greater than.
      GREATER_THAN = 4
    end
  end

  # A filter for numeric or date values between certain values on a dimension
  # or metric.
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Begins with this number, inclusive.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Ends with this number, inclusive.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#field_name ⇒ ::String

Returns Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the Google Analytics Data API documentation.

Returns:

  • (::String) —

    Required. Immutable. The dimension name or metric name to filter. If the field name refers to a custom dimension or metric, a scope prefix will be added to the front of the custom dimensions or metric name. For more on scope prefixes or custom dimensions/metrics, reference the Google Analytics Data API documentation.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 68

class AudienceDimensionOrMetricFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A filter for a string-type dimension that matches a particular pattern.
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter::MatchType]
  #     Required. The match type for the string filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The string value to be matched against.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type for the string filter.
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression matches with the string value.
      FULL_REGEXP = 5
    end
  end

  # A filter for a string dimension that matches a particular list of options.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     Required. The list of possible string values to match against. Must be
  #     non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # To represent a number.
  # @!attribute [rw] int64_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     Double value.
  class NumericValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A filter for numeric or date values on a dimension or metric.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
  #     Required. The operation applied to a numeric filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. The numeric or date value to match against.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter.
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal.
      EQUAL = 1

      # Less than.
      LESS_THAN = 2

      # Greater than.
      GREATER_THAN = 4
    end
  end

  # A filter for numeric or date values between certain values on a dimension
  # or metric.
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Begins with this number, inclusive.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Ends with this number, inclusive.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#in_any_n_day_period ⇒ ::Integer

Returns Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window).

For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false.

It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.

Returns:

  • (::Integer) —

    Optional. If set, specifies the time window for which to evaluate data in number of days. If not set, then audience data is evaluated against lifetime data (For example, infinite time window).

    For example, if set to 1 day, only the current day's data is evaluated. The reference point is the current day when at_any_point_in_time is unset or false.

    It can only be set when Audience scope is ACROSS_ALL_SESSIONS and cannot be greater than 60 days.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 68

class AudienceDimensionOrMetricFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A filter for a string-type dimension that matches a particular pattern.
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter::MatchType]
  #     Required. The match type for the string filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The string value to be matched against.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type for the string filter.
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression matches with the string value.
      FULL_REGEXP = 5
    end
  end

  # A filter for a string dimension that matches a particular list of options.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     Required. The list of possible string values to match against. Must be
  #     non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # To represent a number.
  # @!attribute [rw] int64_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     Double value.
  class NumericValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A filter for numeric or date values on a dimension or metric.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
  #     Required. The operation applied to a numeric filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. The numeric or date value to match against.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter.
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal.
      EQUAL = 1

      # Less than.
      LESS_THAN = 2

      # Greater than.
      GREATER_THAN = 4
    end
  end

  # A filter for numeric or date values between certain values on a dimension
  # or metric.
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Begins with this number, inclusive.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Ends with this number, inclusive.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#in_list_filter ⇒ ::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::InListFilter

Returns A filter for a string dimension that matches a particular list of options.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 68

class AudienceDimensionOrMetricFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A filter for a string-type dimension that matches a particular pattern.
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter::MatchType]
  #     Required. The match type for the string filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The string value to be matched against.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type for the string filter.
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression matches with the string value.
      FULL_REGEXP = 5
    end
  end

  # A filter for a string dimension that matches a particular list of options.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     Required. The list of possible string values to match against. Must be
  #     non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # To represent a number.
  # @!attribute [rw] int64_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     Double value.
  class NumericValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A filter for numeric or date values on a dimension or metric.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
  #     Required. The operation applied to a numeric filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. The numeric or date value to match against.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter.
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal.
      EQUAL = 1

      # Less than.
      LESS_THAN = 2

      # Greater than.
      GREATER_THAN = 4
    end
  end

  # A filter for numeric or date values between certain values on a dimension
  # or metric.
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Begins with this number, inclusive.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Ends with this number, inclusive.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#numeric_filter ⇒ ::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter

Returns A filter for numeric or date values on a dimension or metric.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 68

class AudienceDimensionOrMetricFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A filter for a string-type dimension that matches a particular pattern.
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter::MatchType]
  #     Required. The match type for the string filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The string value to be matched against.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type for the string filter.
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression matches with the string value.
      FULL_REGEXP = 5
    end
  end

  # A filter for a string dimension that matches a particular list of options.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     Required. The list of possible string values to match against. Must be
  #     non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # To represent a number.
  # @!attribute [rw] int64_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     Double value.
  class NumericValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A filter for numeric or date values on a dimension or metric.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
  #     Required. The operation applied to a numeric filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. The numeric or date value to match against.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter.
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal.
      EQUAL = 1

      # Less than.
      LESS_THAN = 2

      # Greater than.
      GREATER_THAN = 4
    end
  end

  # A filter for numeric or date values between certain values on a dimension
  # or metric.
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Begins with this number, inclusive.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Ends with this number, inclusive.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#string_filter ⇒ ::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter

Returns A filter for a string-type dimension that matches a particular pattern.

Returns:



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'proto_docs/google/analytics/admin/v1alpha/audience.rb', line 68

class AudienceDimensionOrMetricFilter
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # A filter for a string-type dimension that matches a particular pattern.
  # @!attribute [rw] match_type
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::StringFilter::MatchType]
  #     Required. The match type for the string filter.
  # @!attribute [rw] value
  #   @return [::String]
  #     Required. The string value to be matched against.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class StringFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The match type for the string filter.
    module MatchType
      # Unspecified
      MATCH_TYPE_UNSPECIFIED = 0

      # Exact match of the string value.
      EXACT = 1

      # Begins with the string value.
      BEGINS_WITH = 2

      # Ends with the string value.
      ENDS_WITH = 3

      # Contains the string value.
      CONTAINS = 4

      # Full regular expression matches with the string value.
      FULL_REGEXP = 5
    end
  end

  # A filter for a string dimension that matches a particular list of options.
  # @!attribute [rw] values
  #   @return [::Array<::String>]
  #     Required. The list of possible string values to match against. Must be
  #     non-empty.
  # @!attribute [rw] case_sensitive
  #   @return [::Boolean]
  #     Optional. If true, the match is case-sensitive. If false, the match is
  #     case-insensitive.
  class InListFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # To represent a number.
  # @!attribute [rw] int64_value
  #   @return [::Integer]
  #     Integer value.
  # @!attribute [rw] double_value
  #   @return [::Float]
  #     Double value.
  class NumericValue
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # A filter for numeric or date values on a dimension or metric.
  # @!attribute [rw] operation
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericFilter::Operation]
  #     Required. The operation applied to a numeric filter.
  # @!attribute [rw] value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. The numeric or date value to match against.
  class NumericFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # The operation applied to a numeric filter.
    module Operation
      # Unspecified.
      OPERATION_UNSPECIFIED = 0

      # Equal.
      EQUAL = 1

      # Less than.
      LESS_THAN = 2

      # Greater than.
      GREATER_THAN = 4
    end
  end

  # A filter for numeric or date values between certain values on a dimension
  # or metric.
  # @!attribute [rw] from_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Begins with this number, inclusive.
  # @!attribute [rw] to_value
  #   @return [::Google::Analytics::Admin::V1alpha::AudienceDimensionOrMetricFilter::NumericValue]
  #     Required. Ends with this number, inclusive.
  class BetweenFilter
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end