Class AudienceDimensionOrMetricFilter

A specific filter for a single dimension or metric.

Inheritance
object
AudienceDimensionOrMetricFilter
Implements
Inherited Members
Namespace: Google.Analytics.Admin.V1Alpha
Assembly: Google.Analytics.Admin.V1Alpha.dll
Syntax
public sealed class AudienceDimensionOrMetricFilter : IMessage<AudienceDimensionOrMetricFilter>, IEquatable<AudienceDimensionOrMetricFilter>, IDeepCloneable<AudienceDimensionOrMetricFilter>, IBufferMessage, IMessage

Constructors

AudienceDimensionOrMetricFilter()

Declaration
public AudienceDimensionOrMetricFilter()

AudienceDimensionOrMetricFilter(AudienceDimensionOrMetricFilter)

Declaration
public AudienceDimensionOrMetricFilter(AudienceDimensionOrMetricFilter other)
Parameters
Type Name Description
AudienceDimensionOrMetricFilter other

Properties

AtAnyPointInTime

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.

Declaration
public bool AtAnyPointInTime { get; set; }
Property Value
Type Description
bool

BetweenFilter

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

Declaration
public AudienceDimensionOrMetricFilter.Types.BetweenFilter BetweenFilter { get; set; }
Property Value
Type Description
AudienceDimensionOrMetricFilter.Types.BetweenFilter

FieldName

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] (https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#custom_dimensions).

Declaration
public string FieldName { get; set; }
Property Value
Type Description
string

InAnyNDayPeriod

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.

Declaration
public int InAnyNDayPeriod { get; set; }
Property Value
Type Description
int

InListFilter

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

Declaration
public AudienceDimensionOrMetricFilter.Types.InListFilter InListFilter { get; set; }
Property Value
Type Description
AudienceDimensionOrMetricFilter.Types.InListFilter

NumericFilter

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

Declaration
public AudienceDimensionOrMetricFilter.Types.NumericFilter NumericFilter { get; set; }
Property Value
Type Description
AudienceDimensionOrMetricFilter.Types.NumericFilter

OneFilterCase

Declaration
public AudienceDimensionOrMetricFilter.OneFilterOneofCase OneFilterCase { get; }
Property Value
Type Description
AudienceDimensionOrMetricFilter.OneFilterOneofCase

StringFilter

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

Declaration
public AudienceDimensionOrMetricFilter.Types.StringFilter StringFilter { get; set; }
Property Value
Type Description
AudienceDimensionOrMetricFilter.Types.StringFilter