Google Analytics Data V1alpha Client - Class Metric (0.21.0)

Reference documentation and code samples for the Google Analytics Data V1alpha Client class Metric.

The quantitative measurements of a report. For example, the metric eventCount is the total number of events. Requests are allowed up to 10 metrics.

Generated from protobuf message google.analytics.data.v1alpha.Metric

Namespace

Google \ Analytics \ Data \ V1alpha

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

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.
↳ expression string

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.
↳ invisible bool

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.

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.

Returns
Type Description
string

setName

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.

Parameter
Name Description
var string
Returns
Type Description
$this

getExpression

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

Returns
Type Description
string

setExpression

A mathematical expression for derived metrics. For example, the metric Event count per user is eventCount/totalUsers.

Parameter
Name Description
var string
Returns
Type Description
$this

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.

Returns
Type Description
bool

setInvisible

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.

Parameter
Name Description
var bool
Returns
Type Description
$this