Class Metric.Builder (0.57.0)

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.v1alpha.Metric

Implements

MetricOrBuilder

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Metric.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Metric.Builder
Overrides

build()

public Metric build()
Returns
Type Description
Metric

buildPartial()

public Metric buildPartial()
Returns
Type Description
Metric

clear()

public Metric.Builder clear()
Returns
Type Description
Metric.Builder
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;

Returns
Type Description
Metric.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Metric.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Metric.Builder
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;

Returns
Type Description
Metric.Builder

This builder for chaining.

clearName()

public Metric.Builder clearName()

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
Metric.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Metric.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Metric.Builder
Overrides

clone()

public Metric.Builder clone()
Returns
Type Description
Metric.Builder
Overrides

getDefaultInstanceForType()

public Metric getDefaultInstanceForType()
Returns
Type Description
Metric

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
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()

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
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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Metric other)

public Metric.Builder mergeFrom(Metric other)
Parameter
Name Description
other Metric
Returns
Type Description
Metric.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Metric.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Metric.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Metric.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Metric.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Metric.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Metric.Builder
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.

Returns
Type Description
Metric.Builder

This builder for chaining.

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.

Returns
Type Description
Metric.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Metric.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Metric.Builder
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.

Returns
Type Description
Metric.Builder

This builder for chaining.

setName(String value)

public Metric.Builder setName(String value)

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;

Parameter
Name Description
value String

The name to set.

Returns
Type Description
Metric.Builder

This builder for chaining.

setNameBytes(ByteString value)

public Metric.Builder setNameBytes(ByteString value)

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;

Parameter
Name Description
value ByteString

The bytes for name to set.

Returns
Type Description
Metric.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Metric.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Metric.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final Metric.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Metric.Builder
Overrides