Class Metric (0.50.0)

public final class Metric extends 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

Implements

MetricOrBuilder

Static Fields

EXPRESSION_FIELD_NUMBER

public static final int EXPRESSION_FIELD_NUMBER
Field Value
TypeDescription
int

INVISIBLE_FIELD_NUMBER

public static final int INVISIBLE_FIELD_NUMBER
Field Value
TypeDescription
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Metric getDefaultInstance()
Returns
TypeDescription
Metric

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static Metric.Builder newBuilder()
Returns
TypeDescription
Metric.Builder

newBuilder(Metric prototype)

public static Metric.Builder newBuilder(Metric prototype)
Parameter
NameDescription
prototypeMetric
Returns
TypeDescription
Metric.Builder

parseDelimitedFrom(InputStream input)

public static Metric parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Metric
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Metric
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Metric parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Metric
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Metric
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Metric parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Metric
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Metric
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Metric parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Metric
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Metric
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Metric parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Metric
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Metric
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Metric parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Metric
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Metric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Metric
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<Metric> parser()
Returns
TypeDescription
Parser<Metric>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public Metric getDefaultInstanceForType()
Returns
TypeDescription
Metric

getExpression()

public String getExpression()

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

string expression = 2;

Returns
TypeDescription
String

The expression.

getExpressionBytes()

public ByteString getExpressionBytes()

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

string expression = 2;

Returns
TypeDescription
ByteString

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;

Returns
TypeDescription
boolean

The invisible.

getName()

public String getName()

The name of the metric. See the API Metrics for the list of metric names supported by core reporting methods such as runReport and batchRunReports. See Realtime Metrics for the list of metric names supported by the runRealtimeReport method. See Funnel Metrics for the list of metric names supported by the runFunnelReport method.

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;

Returns
TypeDescription
String

The name.

getNameBytes()

public ByteString getNameBytes()

The name of the metric. See the API Metrics for the list of metric names supported by core reporting methods such as runReport and batchRunReports. See Realtime Metrics for the list of metric names supported by the runRealtimeReport method. See Funnel Metrics for the list of metric names supported by the runFunnelReport method.

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;

Returns
TypeDescription
ByteString

The bytes for name.

getParserForType()

public Parser<Metric> getParserForType()
Returns
TypeDescription
Parser<Metric>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Metric.Builder newBuilderForType()
Returns
TypeDescription
Metric.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Metric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Metric.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Metric.Builder toBuilder()
Returns
TypeDescription
Metric.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException