Class AudienceDimensionOrMetricFilter (0.62.0)

Version latest

• 0.62.0 (latest)
• 0.61.0
• 0.59.0
• 0.58.0
• 0.57.0
• 0.56.0
• 0.55.0
• 0.54.0
• 0.53.0
• 0.52.0
• 0.51.0
• 0.50.0
• 0.49.0
• 0.47.0
• 0.46.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.34.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.0
• 0.21.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0

public final class AudienceDimensionOrMetricFilter extends GeneratedMessageV3 implements AudienceDimensionOrMetricFilterOrBuilder

A specific filter for a single dimension or metric.

Protobuf type google.analytics.admin.v1alpha.AudienceDimensionOrMetricFilter

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AudienceDimensionOrMetricFilter

Implements

AudienceDimensionOrMetricFilterOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

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()

Returns
Type	Description
AudienceDimensionOrMetricFilter

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static AudienceDimensionOrMetricFilter.Builder newBuilder()

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

newBuilder(AudienceDimensionOrMetricFilter prototype)

public static AudienceDimensionOrMetricFilter.Builder newBuilder(AudienceDimensionOrMetricFilter prototype)

Parameter
Name	Description
prototype	AudienceDimensionOrMetricFilter

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

parseDelimitedFrom(InputStream input)

public static AudienceDimensionOrMetricFilter parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceDimensionOrMetricFilter parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static AudienceDimensionOrMetricFilter parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AudienceDimensionOrMetricFilter parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AudienceDimensionOrMetricFilter parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AudienceDimensionOrMetricFilter parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AudienceDimensionOrMetricFilter parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceDimensionOrMetricFilter parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static AudienceDimensionOrMetricFilter parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AudienceDimensionOrMetricFilter parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static AudienceDimensionOrMetricFilter parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AudienceDimensionOrMetricFilter parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
AudienceDimensionOrMetricFilter

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<AudienceDimensionOrMetricFilter> parser()

Returns
Type	Description
Parser<AudienceDimensionOrMetricFilter>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

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;

Returns
Type	Description
AudienceDimensionOrMetricFilter.BetweenFilter	The betweenFilter.

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;

Returns
Type	Description
AudienceDimensionOrMetricFilter.BetweenFilterOrBuilder

getDefaultInstanceForType()

public AudienceDimensionOrMetricFilter getDefaultInstanceForType()

Returns
Type	Description
AudienceDimensionOrMetricFilter

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;

Returns
Type	Description
AudienceDimensionOrMetricFilter.InListFilter	The inListFilter.

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;

Returns
Type	Description
AudienceDimensionOrMetricFilter.InListFilterOrBuilder

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;

Returns
Type	Description
AudienceDimensionOrMetricFilter.NumericFilter	The numericFilter.

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;

Returns
Type	Description
AudienceDimensionOrMetricFilter.NumericFilterOrBuilder

getOneFilterCase()

public AudienceDimensionOrMetricFilter.OneFilterCase getOneFilterCase()

Returns
Type	Description
AudienceDimensionOrMetricFilter.OneFilterCase

getParserForType()

public Parser<AudienceDimensionOrMetricFilter> getParserForType()

Returns
Type	Description
Parser<AudienceDimensionOrMetricFilter>

Overrides

GeneratedMessageV3.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessageV3.getSerializedSize()

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;

Returns
Type	Description
AudienceDimensionOrMetricFilter.StringFilter	The stringFilter.

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;

Returns
Type	Description
AudienceDimensionOrMetricFilter.StringFilterOrBuilder

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()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.isInitialized()

newBuilderForType()

public AudienceDimensionOrMetricFilter.Builder newBuilderForType()

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AudienceDimensionOrMetricFilter.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

Overrides

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent parent)

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Parameter
Name	Description
unused	UnusedPrivateParameter

Returns
Type	Description
Object

Overrides

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

toBuilder()

public AudienceDimensionOrMetricFilter.Builder toBuilder()

Returns
Type	Description
AudienceDimensionOrMetricFilter.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessageV3.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException