public final class AudienceDimensionOrMetricFilter extends GeneratedMessageV3 implements AudienceDimensionOrMetricFilterOrBuilder
A specific filter for a single dimension or metric.
Protobuf type google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
Static Fields
AT_ANY_POINT_IN_TIME_FIELD_NUMBER
public static final int AT_ANY_POINT_IN_TIME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
BETWEEN_FILTER_FIELD_NUMBER
public static final int BETWEEN_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
FIELD_NAME_FIELD_NUMBER
public static final int FIELD_NAME_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IN_ANY_N_DAY_PERIOD_FIELD_NUMBER
public static final int IN_ANY_N_DAY_PERIOD_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
IN_LIST_FILTER_FIELD_NUMBER
public static final int IN_LIST_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
NUMERIC_FILTER_FIELD_NUMBER
public static final int NUMERIC_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
STRING_FILTER_FIELD_NUMBER
public static final int STRING_FILTER_FIELD_NUMBER
| Field Value |
|---|
| Type | Description |
int | |
Static Methods
getDefaultInstance()
public static AudienceDimensionOrMetricFilter getDefaultInstance()
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static AudienceDimensionOrMetricFilter.Builder newBuilder()
newBuilder(AudienceDimensionOrMetricFilter prototype)
public static AudienceDimensionOrMetricFilter.Builder newBuilder(AudienceDimensionOrMetricFilter prototype)
public static AudienceDimensionOrMetricFilter parseDelimitedFrom(InputStream input)
public static AudienceDimensionOrMetricFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(byte[] data)
public static AudienceDimensionOrMetricFilter parseFrom(byte[] data)
| Parameter |
|---|
| Name | Description |
data | byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static AudienceDimensionOrMetricFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteString data)
public static AudienceDimensionOrMetricFilter parseFrom(ByteString data)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AudienceDimensionOrMetricFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static AudienceDimensionOrMetricFilter parseFrom(CodedInputStream input)
public static AudienceDimensionOrMetricFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static AudienceDimensionOrMetricFilter parseFrom(InputStream input)
public static AudienceDimensionOrMetricFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
parseFrom(ByteBuffer data)
public static AudienceDimensionOrMetricFilter parseFrom(ByteBuffer data)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static AudienceDimensionOrMetricFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
parser()
public static Parser<AudienceDimensionOrMetricFilter> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
|---|
| Name | Description |
obj | Object
|
Overrides
getAtAnyPointInTime()
public 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 |
|---|
| Type | Description |
boolean | The atAnyPointInTime.
|
getBetweenFilter()
public 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;
getBetweenFilterOrBuilder()
public 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;
getDefaultInstanceForType()
public AudienceDimensionOrMetricFilter getDefaultInstanceForType()
getFieldName()
public 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.
string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
String | The fieldName.
|
getFieldNameBytes()
public 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.
string field_name = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.field_behavior) = IMMUTABLE];
| Returns |
|---|
| Type | Description |
ByteString | The bytes for fieldName.
|
getInAnyNDayPeriod()
public 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 |
|---|
| Type | Description |
int | The inAnyNDayPeriod.
|
getInListFilter()
public 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;
getInListFilterOrBuilder()
public 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;
getNumericFilter()
public AudienceDimensionOrMetricFilter.NumericFilter getNumericFilter()
A filter for numeric or date values on a dimension or metric.
.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;
getNumericFilterOrBuilder()
public AudienceDimensionOrMetricFilter.NumericFilterOrBuilder getNumericFilterOrBuilder()
A filter for numeric or date values on a dimension or metric.
.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;
getOneFilterCase()
public AudienceDimensionOrMetricFilter.OneFilterCase getOneFilterCase()
getParserForType()
public Parser<AudienceDimensionOrMetricFilter> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
|---|
| Type | Description |
int | |
Overrides
getStringFilter()
public AudienceDimensionOrMetricFilter.StringFilter getStringFilter()
A filter for a string-type dimension that matches a particular pattern.
.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;
getStringFilterOrBuilder()
public AudienceDimensionOrMetricFilter.StringFilterOrBuilder getStringFilterOrBuilder()
A filter for a string-type dimension that matches a particular pattern.
.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;
hasBetweenFilter()
public 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 |
|---|
| Type | Description |
boolean | Whether the betweenFilter field is set.
|
hasInListFilter()
public 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 |
|---|
| Type | Description |
boolean | Whether the inListFilter field is set.
|
hasNumericFilter()
public boolean hasNumericFilter()
A filter for numeric or date values on a dimension or metric.
.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.NumericFilter numeric_filter = 4;
| Returns |
|---|
| Type | Description |
boolean | Whether the numericFilter field is set.
|
hasStringFilter()
public boolean hasStringFilter()
A filter for a string-type dimension that matches a particular pattern.
.google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter.StringFilter string_filter = 2;
| Returns |
|---|
| Type | Description |
boolean | Whether the stringFilter field is set.
|
hashCode()
| Returns |
|---|
| Type | Description |
int | |
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public AudienceDimensionOrMetricFilter.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected AudienceDimensionOrMetricFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Overrides
toBuilder()
public AudienceDimensionOrMetricFilter.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
