Reference documentation and code samples for the Google Analytics Data V1alpha Client class Metric.
The quantitative measurements of a report. For example, the metriceventCountis the total number of events. Requests are allowed up to 10
metrics.
Generated from protobuf messagegoogle.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 theAPI Metricsfor the list of metric names supported by core reporting methods such asrunReportandbatchRunReports. SeeRealtime Metricsfor the list of metric names supported by therunRealtimeReportmethod. SeeFunnel Metricsfor the list of metric names supported by therunFunnelReportmethod. Ifexpressionis specified,namecan be any string that you would like within the allowed character set. For example ifexpressionisscreenPageViews/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 bynameinmetricFilter,orderBys, and metricexpression.
↳ expression
string
A mathematical expression for derived metrics. For example, the metric Event count per user iseventCount/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 inmetricFilter,orderBys, or a metricexpression.
getName
The name of the metric. See theAPI
Metricsfor the list of metric names supported by core reporting methods such
asrunReportandbatchRunReports. SeeRealtime
Metricsfor the list of metric names supported by therunRealtimeReportmethod. SeeFunnel
Metricsfor the list of metric names supported by therunFunnelReportmethod.
Ifexpressionis specified,namecan be any string that you would like
within the allowed character set. For example ifexpressionisscreenPageViews/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 bynameinmetricFilter,orderBys, and metricexpression.
Returns
Type
Description
string
setName
The name of the metric. See theAPI
Metricsfor the list of metric names supported by core reporting methods such
asrunReportandbatchRunReports. SeeRealtime
Metricsfor the list of metric names supported by therunRealtimeReportmethod. SeeFunnel
Metricsfor the list of metric names supported by therunFunnelReportmethod.
Ifexpressionis specified,namecan be any string that you would like
within the allowed character set. For example ifexpressionisscreenPageViews/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 bynameinmetricFilter,orderBys, and metricexpression.
Parameter
Name
Description
var
string
Returns
Type
Description
$this
getExpression
A mathematical expression for derived metrics. For example, the metric
Event count per user iseventCount/totalUsers.
Returns
Type
Description
string
setExpression
A mathematical expression for derived metrics. For example, the metric
Event count per user iseventCount/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 inmetricFilter,orderBys, or a metricexpression.
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 inmetricFilter,orderBys, or a metricexpression.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Analytics Data V1alpha Client - Class Metric (0.22.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.22.3 (latest)](/php/docs/reference/analytics-data/latest/V1alpha.Metric)\n- [0.22.2](/php/docs/reference/analytics-data/0.22.2/V1alpha.Metric)\n- [0.21.1](/php/docs/reference/analytics-data/0.21.1/V1alpha.Metric)\n- [0.20.1](/php/docs/reference/analytics-data/0.20.1/V1alpha.Metric)\n- [0.19.0](/php/docs/reference/analytics-data/0.19.0/V1alpha.Metric)\n- [0.18.0](/php/docs/reference/analytics-data/0.18.0/V1alpha.Metric)\n- [0.17.1](/php/docs/reference/analytics-data/0.17.1/V1alpha.Metric)\n- [0.16.4](/php/docs/reference/analytics-data/0.16.4/V1alpha.Metric)\n- [0.14.0](/php/docs/reference/analytics-data/0.14.0/V1alpha.Metric)\n- [0.13.0](/php/docs/reference/analytics-data/0.13.0/V1alpha.Metric)\n- [0.12.0](/php/docs/reference/analytics-data/0.12.0/V1alpha.Metric)\n- [0.11.2](/php/docs/reference/analytics-data/0.11.2/V1alpha.Metric)\n- [0.10.1](/php/docs/reference/analytics-data/0.10.1/V1alpha.Metric)\n- [0.9.5](/php/docs/reference/analytics-data/0.9.5/V1alpha.Metric) \n| **Beta**\n|\n|\n| This library is covered by the [Pre-GA Offerings Terms](/terms/service-terms#1)\n| of the Terms of Service. Pre-GA libraries might have limited support,\n| and changes to pre-GA libraries might not be compatible with other pre-GA versions.\n| For more information, see the\n[launch stage descriptions](/products#product-launch-stages). \nReference documentation and code samples for the Google Analytics Data V1alpha Client class Metric.\n\nThe quantitative measurements of a report. For example, the metric\n`eventCount` is the total number of events. Requests are allowed up to 10\nmetrics.\n\nGenerated from protobuf message `google.analytics.data.v1alpha.Metric`\n\nNamespace\n---------\n\nGoogle \\\\ Analytics \\\\ Data \\\\ V1alpha\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getName\n\nThe name of the metric. See the [API\nMetrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)\nfor the list of metric names supported by core reporting methods such\nas `runReport` and `batchRunReports`. See\n[Realtime\nMetrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics)\nfor the list of metric names supported by the `runRealtimeReport`\nmethod. See\n[Funnel\nMetrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics)\nfor the list of metric names supported by the `runFunnelReport`\nmethod.\n\nIf `expression` is specified, `name` can be any string that you would like\nwithin the allowed character set. For example if `expression` is\n`screenPageViews/sessions`, you could call that metric's name =\n`viewsPerSession`. Metric names that you choose must match the regular\nexpression `^[a-zA-Z0-9_]$`.\nMetrics are referenced by `name` in `metricFilter`, `orderBys`, and metric\n`expression`.\n\n### setName\n\nThe name of the metric. See the [API\nMetrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics)\nfor the list of metric names supported by core reporting methods such\nas `runReport` and `batchRunReports`. See\n[Realtime\nMetrics](https://developers.google.com/analytics/devguides/reporting/data/v1/realtime-api-schema#metrics)\nfor the list of metric names supported by the `runRealtimeReport`\nmethod. See\n[Funnel\nMetrics](https://developers.google.com/analytics/devguides/reporting/data/v1/exploration-api-schema#metrics)\nfor the list of metric names supported by the `runFunnelReport`\nmethod.\n\nIf `expression` is specified, `name` can be any string that you would like\nwithin the allowed character set. For example if `expression` is\n`screenPageViews/sessions`, you could call that metric's name =\n`viewsPerSession`. Metric names that you choose must match the regular\nexpression `^[a-zA-Z0-9_]$`.\nMetrics are referenced by `name` in `metricFilter`, `orderBys`, and metric\n`expression`.\n\n### getExpression\n\nA mathematical expression for derived metrics. For example, the metric\nEvent count per user is `eventCount/totalUsers`.\n\n### setExpression\n\nA mathematical expression for derived metrics. For example, the metric\nEvent count per user is `eventCount/totalUsers`.\n\n### getInvisible\n\nIndicates if a metric is invisible in the report response. If a metric is\ninvisible, the metric will not produce a column in the response, but can be\nused in `metricFilter`, `orderBys`, or a metric `expression`.\n\n### setInvisible\n\nIndicates if a metric is invisible in the report response. If a metric is\ninvisible, the metric will not produce a column in the response, but can be\nused in `metricFilter`, `orderBys`, or a metric `expression`."]]