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.
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.
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.
[[["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,["# Interface MetricOrBuilder (0.83.0)\n\nVersion latestkeyboard_arrow_down\n\n- [0.83.0 (latest)](/java/docs/reference/google-analytics-data/latest/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.81.0](/java/docs/reference/google-analytics-data/0.81.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.79.0](/java/docs/reference/google-analytics-data/0.79.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.78.0](/java/docs/reference/google-analytics-data/0.78.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.75.0](/java/docs/reference/google-analytics-data/0.75.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.74.0](/java/docs/reference/google-analytics-data/0.74.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.73.0](/java/docs/reference/google-analytics-data/0.73.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.71.0](/java/docs/reference/google-analytics-data/0.71.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.70.0](/java/docs/reference/google-analytics-data/0.70.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.69.0](/java/docs/reference/google-analytics-data/0.69.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.68.0](/java/docs/reference/google-analytics-data/0.68.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.67.0](/java/docs/reference/google-analytics-data/0.67.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.66.0](/java/docs/reference/google-analytics-data/0.66.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.65.0](/java/docs/reference/google-analytics-data/0.65.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.64.0](/java/docs/reference/google-analytics-data/0.64.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.63.0](/java/docs/reference/google-analytics-data/0.63.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.62.0](/java/docs/reference/google-analytics-data/0.62.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.60.0](/java/docs/reference/google-analytics-data/0.60.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.59.0](/java/docs/reference/google-analytics-data/0.59.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.58.0](/java/docs/reference/google-analytics-data/0.58.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.57.0](/java/docs/reference/google-analytics-data/0.57.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.56.0](/java/docs/reference/google-analytics-data/0.56.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.55.0](/java/docs/reference/google-analytics-data/0.55.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.54.0](/java/docs/reference/google-analytics-data/0.54.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.53.0](/java/docs/reference/google-analytics-data/0.53.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.52.0](/java/docs/reference/google-analytics-data/0.52.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.51.0](/java/docs/reference/google-analytics-data/0.51.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.50.0](/java/docs/reference/google-analytics-data/0.50.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.48.0](/java/docs/reference/google-analytics-data/0.48.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.47.0](/java/docs/reference/google-analytics-data/0.47.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.46.0](/java/docs/reference/google-analytics-data/0.46.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.45.0](/java/docs/reference/google-analytics-data/0.45.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.44.0](/java/docs/reference/google-analytics-data/0.44.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.43.0](/java/docs/reference/google-analytics-data/0.43.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.42.0](/java/docs/reference/google-analytics-data/0.42.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.41.0](/java/docs/reference/google-analytics-data/0.41.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.40.0](/java/docs/reference/google-analytics-data/0.40.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.39.0](/java/docs/reference/google-analytics-data/0.39.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.38.0](/java/docs/reference/google-analytics-data/0.38.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.35.0](/java/docs/reference/google-analytics-data/0.35.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.34.0](/java/docs/reference/google-analytics-data/0.34.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.33.0](/java/docs/reference/google-analytics-data/0.33.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.32.0](/java/docs/reference/google-analytics-data/0.32.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.31.0](/java/docs/reference/google-analytics-data/0.31.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.30.0](/java/docs/reference/google-analytics-data/0.30.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.29.0](/java/docs/reference/google-analytics-data/0.29.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.28.0](/java/docs/reference/google-analytics-data/0.28.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.27.0](/java/docs/reference/google-analytics-data/0.27.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.26.0](/java/docs/reference/google-analytics-data/0.26.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.25.0](/java/docs/reference/google-analytics-data/0.25.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.24.0](/java/docs/reference/google-analytics-data/0.24.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.23.0](/java/docs/reference/google-analytics-data/0.23.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.22.0](/java/docs/reference/google-analytics-data/0.22.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.21.0](/java/docs/reference/google-analytics-data/0.21.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.20.0](/java/docs/reference/google-analytics-data/0.20.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.19.0](/java/docs/reference/google-analytics-data/0.19.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.18.0](/java/docs/reference/google-analytics-data/0.18.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.17.0](/java/docs/reference/google-analytics-data/0.17.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.16.0](/java/docs/reference/google-analytics-data/0.16.0/com.google.analytics.data.v1beta.MetricOrBuilder)\n- [0.15.0](/java/docs/reference/google-analytics-data/0.15.0/com.google.analytics.data.v1beta.MetricOrBuilder) \n\n public interface MetricOrBuilder extends MessageOrBuilder\n\nImplements\n----------\n\n[MessageOrBuilder](https://cloud.google.com/java/docs/reference/protobuf/latest/com.google.protobuf.MessageOrBuilder.html)\n\nMethods\n-------\n\n### getExpression()\n\n public abstract String getExpression()\n\nA mathematical expression for derived metrics. For example, the metric\nEvent count per user is `eventCount/totalUsers`.\n\n`string expression = 2;`\n\n### getExpressionBytes()\n\n public abstract ByteString getExpressionBytes()\n\nA mathematical expression for derived metrics. For example, the metric\nEvent count per user is `eventCount/totalUsers`.\n\n`string expression = 2;`\n\n### getInvisible()\n\n public abstract boolean 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`bool invisible = 3;`\n\n### getName()\n\n public abstract String 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_]$`.\n\nMetrics are referenced by `name` in `metricFilter`, `orderBys`, and metric\n`expression`.\n\n`string name = 1;`\n\n### getNameBytes()\n\n public abstract ByteString getNameBytes()\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_]$`.\n\nMetrics are referenced by `name` in `metricFilter`, `orderBys`, and metric\n`expression`.\n\n`string name = 1;`"]]