Try the MCP server for Google Analytics. Install from
GitHub, and see the
announcement for more details.
REST Resource: properties.customMetrics
Stay organized with collections
Save and categorize content based on your preferences.
Resource: CustomMetric
A definition for a custom metric.
| JSON representation |
{
"name": string,
"parameterName": string,
"displayName": string,
"description": string,
"measurementUnit": enum (MeasurementUnit),
"scope": enum (MetricScope),
"restrictedMetricType": [
enum (RestrictedMetricType)
]
} |
| Fields |
name |
string
Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
|
parameterName |
string
Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics.
|
displayName |
string
Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets.
|
description |
string
Optional. Description for this custom dimension. Max length of 150 characters.
|
measurementUnit |
enum (MeasurementUnit)
Required. The type for the custom metric's value.
|
scope |
enum (MetricScope)
Required. Immutable. The scope of this custom metric.
|
restrictedMetricType[] |
enum (RestrictedMetricType)
Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit.
|
MeasurementUnit
Possible types of representing the custom metric's value.
Currency representation may change in the future, requiring a breaking API change.
| Enums |
MEASUREMENT_UNIT_UNSPECIFIED |
MeasurementUnit unspecified or missing. |
STANDARD |
This metric uses default units. |
CURRENCY |
This metric measures a currency. |
FEET |
This metric measures feet. |
METERS |
This metric measures meters. |
KILOMETERS |
This metric measures kilometers. |
MILES |
This metric measures miles. |
MILLISECONDS |
This metric measures milliseconds. |
SECONDS |
This metric measures seconds. |
MINUTES |
This metric measures minutes. |
HOURS |
This metric measures hours. |
MetricScope
The scope of this metric.
| Enums |
METRIC_SCOPE_UNSPECIFIED |
Scope unknown or not specified. |
EVENT |
Metric scoped to an event. |
RestrictedMetricType
Labels that mark the data in this custom metric as data that should be restricted to specific users.
| Enums |
RESTRICTED_METRIC_TYPE_UNSPECIFIED |
Type unknown or unspecified. |
COST_DATA |
Metric reports cost data. |
REVENUE_DATA |
Metric reports revenue data. |
Methods |
|
|
Archives a CustomMetric on a property. |
|
|
Creates a CustomMetric. |
|
|
Lookup for a single CustomMetric. |
|
|
Lists CustomMetrics on a property. |
|
|
Updates a CustomMetric on a property. |
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-04-02 UTC.
[null,null,["Last updated 2025-04-02 UTC."],[[["\u003cp\u003eA \u003ccode\u003eCustomMetric\u003c/code\u003e defines custom metrics for data analysis within Google Analytics, allowing users to track specific events and parameters relevant to their business needs.\u003c/p\u003e\n"],["\u003cp\u003eThese metrics can be defined with various units of measurement (\u003ccode\u003eMeasurementUnit\u003c/code\u003e) including standard, currency, time, and distance, catering to diverse data types.\u003c/p\u003e\n"],["\u003cp\u003eThe scope of a custom metric can be specified (\u003ccode\u003eMetricScope\u003c/code\u003e) to be associated with an event, dictating the context in which the metric is collected.\u003c/p\u003e\n"],["\u003cp\u003eCustom metrics can also be designated as containing restricted data types such as cost or revenue (\u003ccode\u003eRestrictedMetricType\u003c/code\u003e) for enhanced privacy and access control.\u003c/p\u003e\n"],["\u003cp\u003eGoogle Analytics provides methods to manage custom metrics: \u003ccode\u003earchive\u003c/code\u003e, \u003ccode\u003ecreate\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003elist\u003c/code\u003e, and \u003ccode\u003epatch\u003c/code\u003e, allowing for comprehensive control over these custom data points.\u003c/p\u003e\n"]]],["CustomMetrics are defined by a name, parameter name, display name, description, measurement unit, scope, and restricted metric type. Measurement units include standard, currency, distance, and time. Metric scopes can be event-based. Restricted metric types include cost and revenue data. Key actions involve creating, retrieving, listing, updating, and archiving custom metrics, utilizing methods for each of these operations, like create, get, list, patch, and archive.\n"],null,["- [Resource: CustomMetric](#CustomMetric)\n - [JSON representation](#CustomMetric.SCHEMA_REPRESENTATION)\n- [MeasurementUnit](#MeasurementUnit)\n- [MetricScope](#MetricScope)\n- [RestrictedMetricType](#RestrictedMetricType)\n- [Methods](#METHODS_SUMMARY)\n\nResource: CustomMetric A definition for a custom metric.\n\n| JSON representation |\n|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| ``` { \"name\": string, \"parameterName\": string, \"displayName\": string, \"description\": string, \"measurementUnit\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#MeasurementUnit), \"scope\": enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#MetricScope), \"restrictedMetricType\": [ enum (/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#RestrictedMetricType) ] } ``` |\n\n| Fields ||\n|--------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `name` | `string` Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric} |\n| `parameterName` | `string` Required. Immutable. Tagging name for this custom metric. If this is an event-scoped metric, then this is the event parameter name. May only contain alphanumeric and underscore charactes, starting with a letter. Max length of 40 characters for event-scoped metrics. |\n| `displayName` | `string` Required. Display name for this custom metric as shown in the Analytics UI. Max length of 82 characters, alphanumeric plus space and underscore starting with a letter. Legacy system-generated display names may contain square brackets, but updates to this field will never permit square brackets. |\n| `description` | `string` Optional. Description for this custom dimension. Max length of 150 characters. |\n| `measurementUnit` | `enum (`[MeasurementUnit](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#MeasurementUnit)`)` Required. The type for the custom metric's value. |\n| `scope` | `enum (`[MetricScope](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#MetricScope)`)` Required. Immutable. The scope of this custom metric. |\n| `restrictedMetricType[]` | `enum (`[RestrictedMetricType](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics#RestrictedMetricType)`)` Optional. Types of restricted data that this metric may contain. Required for metrics with CURRENCY measurement unit. Must be empty for metrics with a non-CURRENCY measurement unit. |\n\nMeasurementUnit Possible types of representing the custom metric's value.\n\nCurrency representation may change in the future, requiring a breaking API change.\n\n| Enums ||\n|--------------------------------|-----------------------------------------|\n| `MEASUREMENT_UNIT_UNSPECIFIED` | MeasurementUnit unspecified or missing. |\n| `STANDARD` | This metric uses default units. |\n| `CURRENCY` | This metric measures a currency. |\n| `FEET` | This metric measures feet. |\n| `METERS` | This metric measures meters. |\n| `KILOMETERS` | This metric measures kilometers. |\n| `MILES` | This metric measures miles. |\n| `MILLISECONDS` | This metric measures milliseconds. |\n| `SECONDS` | This metric measures seconds. |\n| `MINUTES` | This metric measures minutes. |\n| `HOURS` | This metric measures hours. |\n\nMetricScope The scope of this metric.\n\n| Enums ||\n|----------------------------|---------------------------------|\n| `METRIC_SCOPE_UNSPECIFIED` | Scope unknown or not specified. |\n| `EVENT` | Metric scoped to an event. |\n\nRestrictedMetricType Labels that mark the data in this custom metric as data that should be restricted to specific users.\n\n| Enums ||\n|--------------------------------------|------------------------------|\n| `RESTRICTED_METRIC_TYPE_UNSPECIFIED` | Type unknown or unspecified. |\n| `COST_DATA` | Metric reports cost data. |\n| `REVENUE_DATA` | Metric reports revenue data. |\n\n| Methods ||\n|-----------------------------------------------------------------------------------------------|----------------------------------------|\n| [archive](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/archive) | Archives a CustomMetric on a property. |\n| [create](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/create) | Creates a CustomMetric. |\n| [get](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/get) | Lookup for a single CustomMetric. |\n| [list](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/list) | Lists CustomMetrics on a property. |\n| [patch](/analytics/devguides/config/admin/v1/rest/v1alpha/properties.customMetrics/patch) | Updates a CustomMetric on a property. |"]]
