Class: Google::Analytics::Data::V1beta::Filter
- Inherits:
-
Object
- Object
- Google::Analytics::Data::V1beta::Filter
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/analytics/data/v1beta/data.rb
Overview
An expression to filter dimension or metric values.
Defined Under Namespace
Classes: BetweenFilter, InListFilter, NumericFilter, StringFilter
Instance Attribute Summary collapse
-
#between_filter ⇒ ::Google::Analytics::Data::V1beta::Filter::BetweenFilter
A filter for two values.
-
#field_name ⇒ ::String
The dimension name or metric name.
-
#in_list_filter ⇒ ::Google::Analytics::Data::V1beta::Filter::InListFilter
A filter for in list values.
-
#numeric_filter ⇒ ::Google::Analytics::Data::V1beta::Filter::NumericFilter
A filter for numeric or date values.
-
#string_filter ⇒ ::Google::Analytics::Data::V1beta::Filter::StringFilter
Strings related filter.
Instance Attribute Details
#between_filter ⇒ ::Google::Analytics::Data::V1beta::Filter::BetweenFilter
Returns A filter for two values.
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 276 class Filter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The filter for string # @!attribute [rw] match_type # @return [::Google::Analytics::Data::V1beta::Filter::StringFilter::MatchType] # The match type for this filter. # @!attribute [rw] value # @return [::String] # The string value used for the matching. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class StringFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The match type of a 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 match for the regular expression with the string value. FULL_REGEXP = 5 # Partial match for the regular expression with the string value. PARTIAL_REGEXP = 6 end end # The result needs to be in a list of string values. # @!attribute [rw] values # @return [::Array<::String>] # The list of string values. # Must be non-empty. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class InListFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Filters for numeric or date values. # @!attribute [rw] operation # @return [::Google::Analytics::Data::V1beta::Filter::NumericFilter::Operation] # The operation type for this filter. # @!attribute [rw] value # @return [::Google::Analytics::Data::V1beta::NumericValue] # A numeric value or a date value. 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 # Less than or equal LESS_THAN_OR_EQUAL = 3 # Greater than GREATER_THAN = 4 # Greater than or equal GREATER_THAN_OR_EQUAL = 5 end end # To express that the result needs to be between two numbers (inclusive). # @!attribute [rw] from_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Begins with this number. # @!attribute [rw] to_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Ends with this number. class BetweenFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#field_name ⇒ ::String
Returns The dimension name or metric name.
In most methods, dimensions & metrics can be used for the first time in this field. However in a RunPivotReportRequest, this field must be additionally specified by name in the RunPivotReportRequest's dimensions or metrics.
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 276 class Filter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The filter for string # @!attribute [rw] match_type # @return [::Google::Analytics::Data::V1beta::Filter::StringFilter::MatchType] # The match type for this filter. # @!attribute [rw] value # @return [::String] # The string value used for the matching. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class StringFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The match type of a 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 match for the regular expression with the string value. FULL_REGEXP = 5 # Partial match for the regular expression with the string value. PARTIAL_REGEXP = 6 end end # The result needs to be in a list of string values. # @!attribute [rw] values # @return [::Array<::String>] # The list of string values. # Must be non-empty. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class InListFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Filters for numeric or date values. # @!attribute [rw] operation # @return [::Google::Analytics::Data::V1beta::Filter::NumericFilter::Operation] # The operation type for this filter. # @!attribute [rw] value # @return [::Google::Analytics::Data::V1beta::NumericValue] # A numeric value or a date value. 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 # Less than or equal LESS_THAN_OR_EQUAL = 3 # Greater than GREATER_THAN = 4 # Greater than or equal GREATER_THAN_OR_EQUAL = 5 end end # To express that the result needs to be between two numbers (inclusive). # @!attribute [rw] from_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Begins with this number. # @!attribute [rw] to_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Ends with this number. class BetweenFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#in_list_filter ⇒ ::Google::Analytics::Data::V1beta::Filter::InListFilter
Returns A filter for in list values.
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 276 class Filter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The filter for string # @!attribute [rw] match_type # @return [::Google::Analytics::Data::V1beta::Filter::StringFilter::MatchType] # The match type for this filter. # @!attribute [rw] value # @return [::String] # The string value used for the matching. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class StringFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The match type of a 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 match for the regular expression with the string value. FULL_REGEXP = 5 # Partial match for the regular expression with the string value. PARTIAL_REGEXP = 6 end end # The result needs to be in a list of string values. # @!attribute [rw] values # @return [::Array<::String>] # The list of string values. # Must be non-empty. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class InListFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Filters for numeric or date values. # @!attribute [rw] operation # @return [::Google::Analytics::Data::V1beta::Filter::NumericFilter::Operation] # The operation type for this filter. # @!attribute [rw] value # @return [::Google::Analytics::Data::V1beta::NumericValue] # A numeric value or a date value. 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 # Less than or equal LESS_THAN_OR_EQUAL = 3 # Greater than GREATER_THAN = 4 # Greater than or equal GREATER_THAN_OR_EQUAL = 5 end end # To express that the result needs to be between two numbers (inclusive). # @!attribute [rw] from_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Begins with this number. # @!attribute [rw] to_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Ends with this number. class BetweenFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#numeric_filter ⇒ ::Google::Analytics::Data::V1beta::Filter::NumericFilter
Returns A filter for numeric or date values.
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 276 class Filter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The filter for string # @!attribute [rw] match_type # @return [::Google::Analytics::Data::V1beta::Filter::StringFilter::MatchType] # The match type for this filter. # @!attribute [rw] value # @return [::String] # The string value used for the matching. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class StringFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The match type of a 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 match for the regular expression with the string value. FULL_REGEXP = 5 # Partial match for the regular expression with the string value. PARTIAL_REGEXP = 6 end end # The result needs to be in a list of string values. # @!attribute [rw] values # @return [::Array<::String>] # The list of string values. # Must be non-empty. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class InListFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Filters for numeric or date values. # @!attribute [rw] operation # @return [::Google::Analytics::Data::V1beta::Filter::NumericFilter::Operation] # The operation type for this filter. # @!attribute [rw] value # @return [::Google::Analytics::Data::V1beta::NumericValue] # A numeric value or a date value. 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 # Less than or equal LESS_THAN_OR_EQUAL = 3 # Greater than GREATER_THAN = 4 # Greater than or equal GREATER_THAN_OR_EQUAL = 5 end end # To express that the result needs to be between two numbers (inclusive). # @!attribute [rw] from_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Begins with this number. # @!attribute [rw] to_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Ends with this number. class BetweenFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#string_filter ⇒ ::Google::Analytics::Data::V1beta::Filter::StringFilter
Returns Strings related filter.
276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 |
# File 'proto_docs/google/analytics/data/v1beta/data.rb', line 276 class Filter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The filter for string # @!attribute [rw] match_type # @return [::Google::Analytics::Data::V1beta::Filter::StringFilter::MatchType] # The match type for this filter. # @!attribute [rw] value # @return [::String] # The string value used for the matching. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class StringFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # The match type of a 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 match for the regular expression with the string value. FULL_REGEXP = 5 # Partial match for the regular expression with the string value. PARTIAL_REGEXP = 6 end end # The result needs to be in a list of string values. # @!attribute [rw] values # @return [::Array<::String>] # The list of string values. # Must be non-empty. # @!attribute [rw] case_sensitive # @return [::Boolean] # If true, the string value is case sensitive. class InListFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Filters for numeric or date values. # @!attribute [rw] operation # @return [::Google::Analytics::Data::V1beta::Filter::NumericFilter::Operation] # The operation type for this filter. # @!attribute [rw] value # @return [::Google::Analytics::Data::V1beta::NumericValue] # A numeric value or a date value. 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 # Less than or equal LESS_THAN_OR_EQUAL = 3 # Greater than GREATER_THAN = 4 # Greater than or equal GREATER_THAN_OR_EQUAL = 5 end end # To express that the result needs to be between two numbers (inclusive). # @!attribute [rw] from_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Begins with this number. # @!attribute [rw] to_value # @return [::Google::Analytics::Data::V1beta::NumericValue] # Ends with this number. class BetweenFilter include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |