public static final class Metric.Builder extends GeneratedMessageV3.Builder<Metric.Builder> 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
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Metric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Overrides
build()
buildPartial()
public Metric buildPartial()
clear()
public Metric.Builder clear()
Overrides
clearExpression()
public Metric.Builder clearExpression()
A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
string expression = 2;
clearField(Descriptors.FieldDescriptor field)
public Metric.Builder clearField(Descriptors.FieldDescriptor field)
Overrides
clearInvisible()
public Metric.Builder clearInvisible()
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;
clearName()
public Metric.Builder clearName()
The name of the metric. See the API
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;
clearOneof(Descriptors.OneofDescriptor oneof)
public Metric.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Overrides
clone()
public Metric.Builder clone()
Overrides
getDefaultInstanceForType()
public Metric getDefaultInstanceForType()
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Overrides
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.
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.
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.
|
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
isInitialized()
public final boolean isInitialized()
Overrides
mergeFrom(Metric other)
public Metric.Builder mergeFrom(Metric other)
| Parameter |
|---|
| Name | Description |
other | Metric
|
public Metric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Overrides
mergeFrom(Message other)
public Metric.Builder mergeFrom(Message other)
| Parameter |
|---|
| Name | Description |
other | Message
|
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Metric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Overrides
setExpression(String value)
public Metric.Builder setExpression(String value)
A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
string expression = 2;
| Parameter |
|---|
| Name | Description |
value | String
The expression to set.
|
setExpressionBytes(ByteString value)
public Metric.Builder setExpressionBytes(ByteString value)
A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
string expression = 2;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for expression to set.
|
setField(Descriptors.FieldDescriptor field, Object value)
public Metric.Builder setField(Descriptors.FieldDescriptor field, Object value)
Overrides
setInvisible(boolean value)
public Metric.Builder setInvisible(boolean value)
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;
| Parameter |
|---|
| Name | Description |
value | boolean
The invisible to set.
|
setName(String value)
public Metric.Builder setName(String value)
The name of the metric. See the API
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;
| Parameter |
|---|
| Name | Description |
value | String
The name to set.
|
setNameBytes(ByteString value)
public Metric.Builder setNameBytes(ByteString value)
The name of the metric. See the API
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;
| Parameter |
|---|
| Name | Description |
value | ByteString
The bytes for name to set.
|
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Metric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Metric.Builder setUnknownFields(UnknownFieldSet unknownFields)
Overrides
