CustomMetric

A definition for a custom metric.

AnalyticsDataGoogleMetricsReportingWeb AnalyticsMachine LearningAttribution

Properties

Name	Type	Description
description	string	Optional. Description for this custom dimension. Max length of 150 characters.
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
measurementUnit	string	Required. The type for the custom metric's value.
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 wit
restrictedMetricType	array	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.
scope	string	Required. Immutable. The scope of this custom metric.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/google-analytics/refs/heads/main/json-schema/admin-api-custom-metric-schema.json",
  "title": "CustomMetric",
  "description": "A definition for a custom metric.",
  "type": "object",
  "properties": {
    "description": {
      "description": "Optional. Description for this custom dimension. Max length of 150 characters.",
      "type": "string"
    },
    "displayName": {
      "description": "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.",
      "type": "string"
    },
    "measurementUnit": {
      "description": "Required. The type for the custom metric's value.",
      "enum": [
        "MEASUREMENT_UNIT_UNSPECIFIED",
        "STANDARD",
        "CURRENCY",
        "FEET",
        "METERS",
        "KILOMETERS",
        "MILES",
        "MILLISECONDS",
        "SECONDS",
        "MINUTES",
        "HOURS"
      ],
      "type": "string"
    },
    "name": {
      "description": "Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}",
      "readOnly": true,
      "type": "string"
    },
    "parameterName": {
      "description": "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.",
      "type": "string"
    },
    "restrictedMetricType": {
      "description": "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.",
      "items": {
        "enum": [
          "RESTRICTED_METRIC_TYPE_UNSPECIFIED",
          "COST_DATA",
          "REVENUE_DATA"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "scope": {
      "description": "Required. Immutable. The scope of this custom metric.",
      "enum": [
        "METRIC_SCOPE_UNSPECIFIED",
        "EVENT"
      ],
      "type": "string"
    }
  }
}