Struct google_api_proto::google::analytics::admin::v1alpha::KeyEvent

pub struct KeyEvent {
    pub name: String,
    pub event_name: String,
    pub create_time: Option<Timestamp>,
    pub deletable: bool,
    pub custom: bool,
    pub counting_method: i32,
    pub default_value: Option<DefaultValue>,
}

A key event in a Google Analytics property.

Fields

name: String

Output only. Resource name of this key event. Format: properties/{property}/keyEvents/{key_event}

event_name: String

Immutable. The event name for this key event. Examples: ‘click’, ‘purchase’

create_time: Option<Timestamp>

Output only. Time when this key event was created in the property.

deletable: bool

Output only. If set to true, this event can be deleted.

custom: bool

Output only. If set to true, this key event refers to a custom event. If set to false, this key event refers to a default event in GA. Default events typically have special meaning in GA. Default events are usually created for you by the GA system, but in some cases can be created by property admins. Custom events count towards the maximum number of custom key events that may be created per property.

counting_method: i32

Required. The method by which Key Events will be counted across multiple events within a session.

default_value: Option<DefaultValue>

Optional. Defines a default value/currency for a key event.

Implementations

impl KeyEvent

pub fn counting_method(&self) -> CountingMethod

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

pub fn set_counting_method(&mut self, value: CountingMethod)

Sets counting_method to the provided enum value.

Trait Implementations

impl Clone for KeyEvent

fn clone(&self) -> KeyEvent

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for KeyEvent

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

Formats the value using the given formatter.

impl Default for KeyEvent

fn default() -> Self

Returns the “default value” for a type.

impl Message for KeyEvent

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 KeyEvent

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