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.



1026
1027
1028
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1026

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

Instance Attribute Details

#at_any_point_in_timeBoolean 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)


982
983
984
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 982

def at_any_point_in_time
  @at_any_point_in_time
end

#between_filterGoogle::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterBetweenFilter

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



989
990
991
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 989

def between_filter
  @between_filter
end

#field_nameString

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

Returns:

  • (String)


999
1000
1001
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 999

def field_name
  @field_name
end

#in_any_n_day_periodFixnum

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

Returns:

  • (Fixnum)


1009
1010
1011
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1009

def in_any_n_day_period
  @in_any_n_day_period
end

#in_list_filterGoogle::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterInListFilter

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



1014
1015
1016
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1014

def in_list_filter
  @in_list_filter
end

#numeric_filterGoogle::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterNumericFilter

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



1019
1020
1021
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1019

def numeric_filter
  @numeric_filter
end

#string_filterGoogle::Apis::AnalyticsadminV1alpha::GoogleAnalyticsAdminV1alphaAudienceDimensionOrMetricFilterStringFilter

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



1024
1025
1026
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1024

def string_filter
  @string_filter
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



1031
1032
1033
1034
1035
1036
1037
1038
1039
# File 'lib/google/apis/analyticsadmin_v1alpha/classes.rb', line 1031

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