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.v1alpha.Metric
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
EXPRESSION_FIELD_NUMBER
public static final int EXPRESSION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
INVISIBLE_FIELD_NUMBER
public static final int INVISIBLE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
NAME_FIELD_NUMBER
public static final int NAME_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
getDefaultInstance()
public static Metric getDefaultInstance()
| Returns |
| Type |
Description |
Metric |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
newBuilder()
public static Metric.Builder newBuilder()
newBuilder(Metric prototype)
public static Metric.Builder newBuilder(Metric prototype)
| Parameter |
| Name |
Description |
prototype |
Metric
|
public static Metric parseDelimitedFrom(InputStream input)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
parseFrom(byte[] data)
public static Metric parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
| Returns |
| Type |
Description |
Metric |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Metric parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
parseFrom(ByteString data)
public static Metric parseFrom(ByteString data)
| Returns |
| Type |
Description |
Metric |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Metric parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(CodedInputStream input)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(InputStream input)
| Returns |
| Type |
Description |
Metric |
|
public static Metric parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
parseFrom(ByteBuffer data)
public static Metric parseFrom(ByteBuffer data)
| Returns |
| Type |
Description |
Metric |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Metric parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
| Returns |
| Type |
Description |
Metric |
|
parser()
public static Parser<Metric> parser()
Methods
equals(Object obj)
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getDefaultInstanceForType()
public Metric getDefaultInstanceForType()
| Returns |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
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 |
| Type |
Description |
boolean |
The invisible.
|
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 |
| Type |
Description |
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 |
| Type |
Description |
ByteString |
The bytes for name.
|
getParserForType()
public Parser<Metric> getParserForType()
Overrides
getSerializedSize()
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
hashCode()
| Returns |
| Type |
Description |
int |
|
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
newBuilderForType()
public Metric.Builder newBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Metric.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
toBuilder()
public Metric.Builder toBuilder()
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Overrides
