Struct google_api_proto::google::analytics::data::v1beta::MetricMetadata

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

Explains a metric.

Fields

api_name: String

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

ui_name: String

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

description: String

Description of how this metric is used and calculated.

deprecated_api_names: 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.

type: i32

The type of this metric.

expression: 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.

custom_definition: bool

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

blocked_reasons: Vec<i32>

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

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

Implementations

impl MetricMetadata

pub fn type(&self) -> MetricType

Returns the enum value of type, or the default if the field is set to an invalid enum value.

pub fn set_type(&mut self, value: MetricType)

Sets type to the provided enum value.

pub fn blocked_reasons( &self, ) -> FilterMap<Cloned<Iter<'_, i32>>, fn(_: i32) -> Option<BlockedReason>>

Returns an iterator which yields the valid enum values contained in blocked_reasons.

pub fn push_blocked_reasons(&mut self, value: BlockedReason)

Appends the provided enum value to blocked_reasons.

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() -> Self

Returns the “default value” for a type.

impl Message for MetricMetadata

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for MetricMetadata

fn eq(&self, other: &MetricMetadata) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MetricMetadata