Struct google_api_proto::google::ads::googleads::v17::resources::BiddingSeasonalityAdjustment

pub struct BiddingSeasonalityAdjustment {
    pub resource_name: String,
    pub seasonality_adjustment_id: i64,
    pub scope: i32,
    pub status: i32,
    pub start_date_time: String,
    pub end_date_time: String,
    pub name: String,
    pub description: String,
    pub devices: Vec<i32>,
    pub conversion_rate_modifier: f64,
    pub campaigns: Vec<String>,
    pub advertising_channel_types: Vec<i32>,
}

Represents a bidding seasonality adjustment.

See “About seasonality adjustments” at https://support.google.com/google-ads/answer/10369906.

Fields

resource_name: String

Immutable. The resource name of the seasonality adjustment. Seasonality adjustment resource names have the form:

customers/{customer_id}/biddingSeasonalityAdjustments/{seasonality_adjustment_id}

seasonality_adjustment_id: i64

Output only. The ID of the seasonality adjustment.

scope: i32

The scope of the seasonality adjustment.

status: i32

Output only. The status of the seasonality adjustment.

start_date_time: String

Required. The inclusive start time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format.

A seasonality adjustment is forward looking and should be used for events that start and end in the future.

end_date_time: String

Required. The exclusive end time of the seasonality adjustment in yyyy-MM-dd HH:mm:ss format.

The length of [start_date_time, end_date_time) interval must be within (0, 14 days].

name: String

The name of the seasonality adjustment. The name can be at most 255 characters.

description: String

The description of the seasonality adjustment. The description can be at most 2048 characters.

devices: Vec<i32>

If not specified, all devices will be included in this adjustment. Otherwise, only the specified targeted devices will be included in this adjustment.

conversion_rate_modifier: f64

Conversion rate modifier estimated based on expected conversion rate changes. When this field is unset or set to 1.0 no adjustment will be applied to traffic. The allowed range is 0.1 to 10.0.

campaigns: Vec<String>

The seasonality adjustment will apply to the campaigns listed when the scope of this adjustment is CAMPAIGN. The maximum number of campaigns per event is 2000. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.

advertising_channel_types: Vec<i32>

The seasonality adjustment will apply to all the campaigns under the listed channels retroactively as well as going forward when the scope of this adjustment is CHANNEL. The supported advertising channel types are DISPLAY, SEARCH and SHOPPING. Note: a seasonality adjustment with both advertising_channel_types and campaign_ids is not supported.

Implementations

impl BiddingSeasonalityAdjustment

pub fn scope(&self) -> SeasonalityEventScope

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

pub fn set_scope(&mut self, value: SeasonalityEventScope)

Sets scope to the provided enum value.

pub fn status(&self) -> SeasonalityEventStatus

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

pub fn set_status(&mut self, value: SeasonalityEventStatus)

Sets status to the provided enum value.

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

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

pub fn push_devices(&mut self, value: Device)

Appends the provided enum value to devices.

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

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

pub fn push_advertising_channel_types(&mut self, value: AdvertisingChannelType)

Appends the provided enum value to advertising_channel_types.

Trait Implementations

impl Clone for BiddingSeasonalityAdjustment

fn clone(&self) -> BiddingSeasonalityAdjustment

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BiddingSeasonalityAdjustment

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

Formats the value using the given formatter.

impl Default for BiddingSeasonalityAdjustment

fn default() -> Self

Returns the “default value” for a type.

impl Message for BiddingSeasonalityAdjustment

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 BiddingSeasonalityAdjustment

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