Struct MetricMetadata

pub struct MetricMetadata {
    pub api_name: Option<String>,
    pub blocked_reasons: Option<Vec<String>>,
    pub category: Option<String>,
    pub custom_definition: Option<bool>,
    pub deprecated_api_names: Option<Vec<String>>,
    pub description: Option<String>,
    pub expression: Option<String>,
    pub type_: Option<String>,
    pub ui_name: Option<String>,
}

Explains a metric.

This type is not used in any activity, and only used as part of another schema.

Fields

api_name: Option<String>

A metric name. Useable in Metric’s name. For example, eventCount.

blocked_reasons: Option<Vec<String>>

If reasons are specified, your access is blocked to this metric for this property. API requests from you to this property for this metric will succeed; however, the report will contain only zeros for this metric. API requests with metric filters on blocked metrics will fail. If reasons are empty, you have access to this metric. To learn more, see Access and data-restriction management.

category: Option<String>

The display name of the category that this metrics belongs to. Similar dimensions and metrics are categorized together.

custom_definition: Option<bool>

True if the metric is a custom metric for this property.

deprecated_api_names: Option<Vec<String>>

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: Option<String>

Description of how this metric is used and calculated.

expression: Option<String>

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_: Option<String>

The type of this metric.

ui_name: Option<String>

This metric’s name within the Google Analytics user interface. For example, Event count.

Trait Implementations

impl Clone for MetricMetadata

fn clone(&self) -> MetricMetadata

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MetricMetadata

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for MetricMetadata

fn default() -> MetricMetadata

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for MetricMetadata

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for MetricMetadata

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Part for MetricMetadata