Package com.google.analytics.admin.v1alpha

Interface AudienceDimensionOrMetricFilterOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
AudienceDimensionOrMetricFilter, AudienceDimensionOrMetricFilter.Builder
@Generated public interface AudienceDimensionOrMetricFilterOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Details

    • hasStringFilter

      boolean hasStringFilter()
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;
      Returns:
      Whether the stringFilter field is set.

    • getStringFilter

      AudienceDimensionOrMetricFilter.StringFilter getStringFilter()
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;
      Returns:
      The stringFilter.

    • getStringFilterOrBuilder

      AudienceDimensionOrMetricFilter.StringFilterOrBuilder getStringFilterOrBuilder()
       A filter for a string-type dimension that matches a particular pattern.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;

    • hasInListFilter

      boolean hasInListFilter()
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;
      Returns:
      Whether the inListFilter field is set.

    • getInListFilter

      AudienceDimensionOrMetricFilter.InListFilter getInListFilter()
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;
      Returns:
      The inListFilter.

    • getInListFilterOrBuilder

      AudienceDimensionOrMetricFilter.InListFilterOrBuilder getInListFilterOrBuilder()
       A filter for a string dimension that matches a particular list of
 options.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.InListFilter in_list_filter = 3;

    • hasNumericFilter

      boolean hasNumericFilter()
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;
      Returns:
      Whether the numericFilter field is set.

    • getNumericFilter

      AudienceDimensionOrMetricFilter.NumericFilter getNumericFilter()
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;
      Returns:
      The numericFilter.

    • getNumericFilterOrBuilder

      AudienceDimensionOrMetricFilter.NumericFilterOrBuilder getNumericFilterOrBuilder()
       A filter for numeric or date values on a dimension or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;

    • hasBetweenFilter

      boolean hasBetweenFilter()
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;
      Returns:
      Whether the betweenFilter field is set.

    • getBetweenFilter

      AudienceDimensionOrMetricFilter.BetweenFilter getBetweenFilter()
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;
      Returns:
      The betweenFilter.

    • getBetweenFilterOrBuilder

      AudienceDimensionOrMetricFilter.BetweenFilterOrBuilder getBetweenFilterOrBuilder()
       A filter for numeric or date values between certain values on a dimension
 or metric.
      .google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.BetweenFilter between_filter = 5;

    • getFieldName

      String getFieldName()
       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).
      string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The fieldName.

    • getFieldNameBytes

      com.google.protobuf.ByteString getFieldNameBytes()
       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).
      string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
      Returns:
      The bytes for fieldName.

    • getAtAnyPointInTime

      boolean getAtAnyPointInTime()
       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.
      bool at_any_point_in_time = 6 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The atAnyPointInTime.

    • getInAnyNDayPeriod

      int getInAnyNDayPeriod()
       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.
      int32 in_any_n_day_period = 7 [(.google.api.field_behavior) = OPTIONAL];
      Returns:
      The inAnyNDayPeriod.

    • getOneFilterCase

      AudienceDimensionOrMetricFilter.OneFilterCase getOneFilterCase()