com.google.analytics.data.v1beta

Class Metric

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.analytics.data.v1beta.Metric

All Implemented Interfaces:

MetricOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Metric
extends com.google.protobuf.GeneratedMessageV3
implements MetricOrBuilder

 The quantitative measurements of a report. For example, the metric
 `eventCount` is the total number of events. Requests are allowed up to 10
 metrics.
 

Protobuf type google.analytics.data.v1beta.Metric

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metric.Builder The quantitative measurements of a report.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage,BuilderType extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	EXPRESSION_FIELD_NUMBER
static int	INVISIBLE_FIELD_NUMBER
static int	NAME_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Metric	getDefaultInstance()
Metric	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
String	getExpression() A mathematical expression for derived metrics.
com.google.protobuf.ByteString	getExpressionBytes() A mathematical expression for derived metrics.
boolean	getInvisible() Indicates if a metric is invisible in the report response.
String	getName() The name of the metric.
com.google.protobuf.ByteString	getNameBytes() The name of the metric.
com.google.protobuf.Parser<Metric>	getParserForType()
int	getSerializedSize()
com.google.protobuf.UnknownFieldSet	getUnknownFields()
int	hashCode()
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Metric.Builder	newBuilder()
static Metric.Builder	newBuilder(Metric prototype)
Metric.Builder	newBuilderForType()
protected Metric.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Metric	parseDelimitedFrom(InputStream input)
static Metric	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(byte[] data)
static Metric	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(ByteBuffer data)
static Metric	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(com.google.protobuf.ByteString data)
static Metric	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(com.google.protobuf.CodedInputStream input)
static Metric	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Metric	parseFrom(InputStream input)
static Metric	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Metric>	parser()
Metric.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER

See Also:

Constant Field Values

EXPRESSION_FIELD_NUMBER

public static final int EXPRESSION_FIELD_NUMBER

See Also:

Constant Field Values

INVISIBLE_FIELD_NUMBER

public static final int INVISIBLE_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getUnknownFields

public final com.google.protobuf.UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface com.google.protobuf.MessageOrBuilder

Overrides:

getUnknownFields in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getName

public String getName()

 The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
 for the list of metric names.
 If `expression` is specified, `name` can be any string that you would like
 within the allowed character set. For example if `expression` is
 `screenPageViews/sessions`, you could call that metric's name =
 `viewsPerSession`. Metric names that you choose must match the regular
 expression `^[a-zA-Z0-9_]$`.
 Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
 `expression`.
 

string name = 1;

Specified by:

getName in interface MetricOrBuilder

Returns:

The name.

getNameBytes

public com.google.protobuf.ByteString getNameBytes()

 The name of the metric. See the [API
 Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)
 for the list of metric names.
 If `expression` is specified, `name` can be any string that you would like
 within the allowed character set. For example if `expression` is
 `screenPageViews/sessions`, you could call that metric's name =
 `viewsPerSession`. Metric names that you choose must match the regular
 expression `^[a-zA-Z0-9_]$`.
 Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric
 `expression`.
 

string name = 1;

Specified by:

getNameBytes in interface MetricOrBuilder

Returns:

The bytes for name.

getExpression

public String getExpression()

 A mathematical expression for derived metrics. For example, the metric
 Event count per user is `eventCount/totalUsers`.
 

string expression = 2;

Specified by:

getExpression in interface MetricOrBuilder

Returns:

The expression.

getExpressionBytes

public com.google.protobuf.ByteString getExpressionBytes()

 A mathematical expression for derived metrics. For example, the metric
 Event count per user is `eventCount/totalUsers`.
 

string expression = 2;

Specified by:

getExpressionBytes in interface MetricOrBuilder

Returns:

The bytes for expression.

getInvisible

public boolean getInvisible()

 Indicates if a metric is invisible in the report response. If a metric is
 invisible, the metric will not produce a column in the response, but can be
 used in `metricFilter`, `orderBys`, or a metric `expression`.
 

bool invisible = 3;

Specified by:

getInvisible in interface MetricOrBuilder

Returns:

The invisible.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Metric parseFrom(ByteBuffer data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(ByteBuffer data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(com.google.protobuf.ByteString data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(com.google.protobuf.ByteString data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(byte[] data)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(byte[] data,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Metric parseFrom(InputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Metric parseFrom(InputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

parseDelimitedFrom

public static Metric parseDelimitedFrom(InputStream input)
                                 throws IOException

Throws:

IOException

parseDelimitedFrom

public static Metric parseDelimitedFrom(InputStream input,
                                        com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                 throws IOException

Throws:

IOException

parseFrom

public static Metric parseFrom(com.google.protobuf.CodedInputStream input)
                        throws IOException

Throws:

IOException

parseFrom

public static Metric parseFrom(com.google.protobuf.CodedInputStream input,
                               com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                        throws IOException

Throws:

IOException

newBuilderForType

public Metric.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Metric.Builder newBuilder()

newBuilder

public static Metric.Builder newBuilder(Metric prototype)

toBuilder

public Metric.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Metric.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Metric getDefaultInstance()

parser

public static com.google.protobuf.Parser<Metric> parser()

getParserForType

public com.google.protobuf.Parser<Metric> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Metric getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder