Struct google_api_proto::google::ads::googleads::v17::common::FrequencyCapKey

pub struct FrequencyCapKey {
    pub level: i32,
    pub event_type: i32,
    pub time_unit: i32,
    pub time_length: Option<i32>,
}

A group of fields used as keys for a frequency cap. There can be no more than one frequency cap with the same key.

Fields

level: i32

The level on which the cap is to be applied (for example, ad group ad, ad group). The cap is applied to all the entities of this level.

event_type: i32

The type of event that the cap applies to (for example, impression).

time_unit: i32

Unit of time the cap is defined at (for example, day, week).

time_length: Option<i32>

Number of time units the cap lasts.

Implementations

impl FrequencyCapKey

pub fn level(&self) -> FrequencyCapLevel

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

pub fn set_level(&mut self, value: FrequencyCapLevel)

Sets level to the provided enum value.

pub fn time_unit(&self) -> FrequencyCapTimeUnit

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

pub fn set_time_unit(&mut self, value: FrequencyCapTimeUnit)

Sets time_unit to the provided enum value.

pub fn event_type(&self) -> FrequencyCapEventType

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

pub fn set_event_type(&mut self, value: FrequencyCapEventType)

Sets event_type to the provided enum value.

pub fn time_length(&self) -> i32

Returns the value of time_length, or the default value if time_length is unset.

Trait Implementations

impl Clone for FrequencyCapKey

fn clone(&self) -> FrequencyCapKey

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FrequencyCapKey

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

Formats the value using the given formatter.

impl Default for FrequencyCapKey

fn default() -> Self

Returns the “default value” for a type.

impl Message for FrequencyCapKey

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 FrequencyCapKey

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

impl StructuralPartialEq for FrequencyCapKey