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()
Returns
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Metric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
Overrides
build()
Returns
buildPartial()
public Metric buildPartial()
Returns
clear()
public Metric.Builder clear()
Returns
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)
Parameter
Returns
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)
Parameter
Returns
Overrides
clone()
public Metric.Builder clone()
Returns
Overrides
getDefaultInstanceForType()
public Metric getDefaultInstanceForType()
Returns
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()
Returns
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;
| 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;
| 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;
| 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;
| 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;
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
mergeFrom(Metric other)
public Metric.Builder mergeFrom(Metric other)
Parameter
Returns
public Metric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Overrides
Exceptions
mergeFrom(Message other)
public Metric.Builder mergeFrom(Message other)
Parameter
Returns
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Metric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
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;
| Name | Description |
| value | String
The expression to set.
|
Returns
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;
| Name | Description |
| value | ByteString
The bytes for expression to set.
|
Returns
setField(Descriptors.FieldDescriptor field, Object value)
public Metric.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Returns
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;
| Name | Description |
| value | boolean
The invisible to set.
|
Returns
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;
| Name | Description |
| value | String
The name to set.
|
Returns
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;
| Name | Description |
| value | ByteString
The bytes for name to set.
|
Returns
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Metric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Returns
Overrides
setUnknownFields(UnknownFieldSet unknownFields)
public final Metric.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Returns
Overrides
