Reference documentation and code samples for the Google Analytics Data V1beta API class Google::Analytics::Data::V1beta::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.
Inherits
Object
Extended By
Google::Protobuf::MessageExts::ClassMethods
Includes
Google::Protobuf::MessageExts
Methods
#expression
defexpression()->::String
Returns
(::String) — A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
#expression=
defexpression=(value)->::String
Parameter
value (::String) — A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
Returns
(::String) — A mathematical expression for derived metrics. For example, the metric
Event count per user is eventCount/totalUsers.
#invisible
definvisible()->::Boolean
Returns
(::Boolean) — 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.
#invisible=
definvisible=(value)->::Boolean
Parameter
value (::Boolean) — 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
(::Boolean) — 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.
#name
defname()->::String
Returns
(::String) — 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.
#name=
defname=(value)->::String
Parameter
value (::String) — 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.
Returns
(::String) — 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.
[[["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-08-28 UTC."],[],[],null,["# Google Analytics Data V1beta API - Class Google::Analytics::Data::V1beta::Metric (v0.4.3)\n\nVersion latestkeyboard_arrow_down\n\n- [0.4.3 (latest)](/ruby/docs/reference/google-analytics-data-v1beta/latest/Google-Analytics-Data-V1beta-Metric)\n- [0.4.2](/ruby/docs/reference/google-analytics-data-v1beta/0.4.2/Google-Analytics-Data-V1beta-Metric) \nReference documentation and code samples for the Google Analytics Data V1beta API class Google::Analytics::Data::V1beta::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\nInherits\n--------\n\n- Object \n\nExtended By\n-----------\n\n- Google::Protobuf::MessageExts::ClassMethods \n\nIncludes\n--------\n\n- Google::Protobuf::MessageExts\n\nMethods\n-------\n\n### #expression\n\n def expression() -\u003e ::String\n\n**Returns**\n\n- (::String) --- A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.\n\n### #expression=\n\n def expression=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`. \n**Returns**\n\n- (::String) --- A mathematical expression for derived metrics. For example, the metric Event count per user is `eventCount/totalUsers`.\n\n### #invisible\n\n def invisible() -\u003e ::Boolean\n\n**Returns**\n\n- (::Boolean) --- 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`.\n\n### #invisible=\n\n def invisible=(value) -\u003e ::Boolean\n\n**Parameter**\n\n- **value** (::Boolean) --- 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`. \n**Returns**\n\n- (::Boolean) --- 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`.\n\n### #name\n\n def name() -\u003e ::String\n\n**Returns**\n\n- (::String) --- The name of the metric. See the [API\n Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names.\n\n\n If `expression` is specified, `name` can be any string that you would like\n within 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\n expression `^[a-zA-Z0-9_]$`.\n\n Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric\n `expression`.\n\n### #name=\n\n def name=(value) -\u003e ::String\n\n**Parameter**\n\n- **value** (::String) --- The name of the metric. See the [API\n Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names.\n\n\n If `expression` is specified, `name` can be any string that you would like\n within 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\n expression `^[a-zA-Z0-9_]$`.\n\n Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric\n`expression`. \n**Returns**\n\n- (::String) --- The name of the metric. See the [API\n Metrics](https://developers.google.com/analytics/devguides/reporting/data/v1/api-schema#metrics) for the list of metric names.\n\n\n If `expression` is specified, `name` can be any string that you would like\n within 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\n expression `^[a-zA-Z0-9_]$`.\n\n Metrics are referenced by `name` in `metricFilter`, `orderBys`, and metric\n `expression`."]]