Class: Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter

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

Overview

A specific filter for a single dimension or metric.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter

Returns a new instance of GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilter.



389
390
391
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 389

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

Instance Attribute Details

#at_any_point_in_time ⇒ Boolean Also known as: at_any_point_in_time?

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. Corresponds to the JSON property atAnyPointInTime

Returns:

  • (Boolean) 


350
351
352
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 350

def at_any_point_in_time
  @at_any_point_in_time
end

#between_filter ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter

A filter for numeric or date values between certain values on a dimension or metric. Corresponds to the JSON property betweenFilter

Returns:



357
358
359
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 357

def between_filter
  @between_filter
end

#field_name ⇒ String

Required. Immutable. The dimension name or metric name to filter. Corresponds to the JSON property fieldName

Returns:

  • (String) 


362
363
364
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 362

def field_name
  @field_name
end

#in_any_n_day_period ⇒ Fixnum

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 (i.e., 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. Corresponds to the JSON property inAnyNDayPeriod

Returns:

  • (Fixnum) 


372
373
374
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 372

def in_any_n_day_period
  @in_any_n_day_period
end

#in_list_filter ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter

A filter for a string dimension that matches a particular list of options. Corresponds to the JSON property inListFilter

Returns:



377
378
379
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 377

def in_list_filter
  @in_list_filter
end

#numeric_filter ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter

A filter for numeric or date values on a dimension or metric. Corresponds to the JSON property numericFilter

Returns:



382
383
384
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 382

def numeric_filter
  @numeric_filter
end

#string_filter ⇒ Google::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter

A filter for a string-type dimension that matches a particular pattern. Corresponds to the JSON property stringFilter

Returns:



387
388
389
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 387

def string_filter
  @string_filter
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



394
395
396
397
398
399
400
401
402
 
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 394

def update!(**args)
  @at_any_point_in_time = args[:at_any_point_in_time] if args.key?(:at_any_point_in_time)
  @between_filter = args[:between_filter] if args.key?(:between_filter)
  @field_name = args[:field_name] if args.key?(:field_name)
  @in_any_n_day_period = args[:in_any_n_day_period] if args.key?(:in_any_n_day_period)
  @in_list_filter = args[:in_list_filter] if args.key?(:in_list_filter)
  @numeric_filter = args[:numeric_filter] if args.key?(:numeric_filter)
  @string_filter = args[:string_filter] if args.key?(:string_filter)
end