GoogleApi.AnalyticsData.V1alpha.Model.MetricMetadata (google_api_analytics_data v0.10.1) View Source

Explains a metric.


  • apiName (type: String.t, default: nil) - A metric name. Useable in Metric's name. For example, eventCount.
  • customDefinition (type: boolean(), default: nil) - True if the metric is a custom metric for this property.
  • deprecatedApiNames (type: list(String.t), default: nil) - Still usable but deprecated names for this metric. If populated, this metric is available by either apiName or one of deprecatedApiNames for a period of time. After the deprecation period, the metric will be available only by apiName.
  • description (type: String.t, default: nil) - Description of how this metric is used and calculated.
  • expression (type: String.t, default: nil) - The mathematical expression for this derived metric. Can be used in Metric's expression field for equivalent reports. Most metrics are not expressions, and for non-expressions, this field is empty.
  • type (type: String.t, default: nil) - The type of this metric.
  • uiName (type: String.t, default: nil) - This metric's name within the Google Analytics user interface. For example, Event count.

Link to this section Summary


Unwrap a decoded JSON object into its complex fields.

Link to this section Types


t() :: %GoogleApi.AnalyticsData.V1alpha.Model.MetricMetadata{
  apiName: String.t() | nil,
  customDefinition: boolean() | nil,
  deprecatedApiNames: [String.t()] | nil,
  description: String.t() | nil,
  expression: String.t() | nil,
  type: String.t() | nil,
  uiName: String.t() | nil

Link to this section Functions


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

Unwrap a decoded JSON object into its complex fields.