View Source GoogleApi.AnalyticsAdmin.V1alpha.Model.GoogleAnalyticsAdminV1alphaCustomMetric (google_api_analytics_admin v0.14.0)

A definition for a custom metric.


  • description (type: String.t, default: nil) - Optional. Description for this custom dimension. Max length of 150 characters.
  • displayName (type: String.t, default: nil) - 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.
  • measurementUnit (type: String.t, default: nil) - Required. The type for the custom metric's value.
  • name (type: String.t, default: nil) - Output only. Resource name for this CustomMetric resource. Format: properties/{property}/customMetrics/{customMetric}
  • parameterName (type: String.t, default: nil) - 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.
  • restrictedMetricType (type: list(String.t), default: nil) - 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 (type: String.t, default: nil) - Required. Immutable. The scope of this custom metric.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() ::
    description: String.t() | nil,
    displayName: String.t() | nil,
    measurementUnit: String.t() | nil,
    name: String.t() | nil,
    parameterName: String.t() | nil,
    restrictedMetricType: [String.t()] | nil,
    scope: String.t() | nil

Link to this section Functions


decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.