Struct google_api_proto::google::analytics::admin::v1alpha::CalculatedMetric

pub struct CalculatedMetric {
    pub name: String,
    pub description: String,
    pub display_name: String,
    pub calculated_metric_id: String,
    pub metric_unit: i32,
    pub restricted_metric_type: Vec<i32>,
    pub formula: String,
    pub invalid_metric_reference: bool,
}

A definition for a calculated metric.

Fields

name: String

Output only. Resource name for this CalculatedMetric. Format: ‘properties/{property_id}/calculatedMetrics/{calculated_metric_id}’

description: String

Optional. Description for this calculated metric. Max length of 4096 characters.

display_name: String

Required. Display name for this calculated metric as shown in the Google Analytics UI. Max length 82 characters.

calculated_metric_id: String

Output only. The ID to use for the calculated metric. In the UI, this is referred to as the “API name.”

The calculated_metric_id is used when referencing this calculated metric from external APIs. For example, “calcMetric:{calculated_metric_id}”.

metric_unit: i32

Required. The type for the calculated metric’s value.

restricted_metric_type: Vec<i32>

Output only. Types of restricted data that this metric contains.

formula: String

Required. The calculated metric’s definition. Maximum number of unique referenced custom metrics is 5. Formulas supports the following operations:

• (addition), - (subtraction), - (negative), * (multiplication), / (division), () (parenthesis). Any valid real numbers are acceptable that fit in a Long (64bit integer) or a Double (64 bit floating point number). Example formula: “( customEvent:parameter_name + cartPurchaseQuantity ) / 2.0”

invalid_metric_reference: bool

Output only. If true, this calculated metric has a invalid metric reference. Anything using a calculated metric with invalid_metric_reference set to true may fail, produce warnings, or produce unexpected results.

Implementations

impl CalculatedMetric

pub fn metric_unit(&self) -> MetricUnit

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

pub fn set_metric_unit(&mut self, value: MetricUnit)

Sets metric_unit to the provided enum value.

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

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

pub fn push_restricted_metric_type(&mut self, value: RestrictedMetricType)

Appends the provided enum value to restricted_metric_type.

Trait Implementations

impl Clone for CalculatedMetric

fn clone(&self) -> CalculatedMetric

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CalculatedMetric

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

Formats the value using the given formatter.

impl Default for CalculatedMetric

fn default() -> Self

Returns the “default value” for a type.

impl Message for CalculatedMetric

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 CalculatedMetric

fn eq(&self, other: &CalculatedMetric) -> 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 CalculatedMetric