Struct gapi_grpc::google::ads::googleads::v4::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 (e.g. 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 (e.g. impression).

time_unit: i32

Unit of time the cap is defined at (e.g. 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.

Trait Implementations

impl Clone for FrequencyCapKey

fn clone(&self) -> FrequencyCapKey

Returns a copy of the value.

pub 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() -> FrequencyCapKey

Returns the “default value” for a type.

impl Message for FrequencyCapKey

fn encode_raw<B>(&self, buf: &mut B) where
    B: BufMut, 

fn merge_field<B>(
    &mut self,
    tag: u32,
    wire_type: WireType,
    buf: &mut B,
    ctx: DecodeContext
) -> Result<(), DecodeError> where
    B: Buf, 

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.

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

Encodes the message to a buffer.

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

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

pub fn decode<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

Decodes an instance of the message from a buffer.

pub fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
    Self: Default,
    B: Buf, 

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

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

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

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

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

impl PartialEq<FrequencyCapKey> 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: &FrequencyCapKey) -> bool

This method tests for !=.

impl StructuralPartialEq for FrequencyCapKey