Interface MetricOrBuilder (0.57.0)

public interface MetricOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getExpression()

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