Struct google_api_proto::google::ads::googleads::v16::services::GenerateReachForecastRequest

pub struct GenerateReachForecastRequest {
    pub customer_id: String,
    pub currency_code: Option<String>,
    pub campaign_duration: Option<CampaignDuration>,
    pub cookie_frequency_cap: Option<i32>,
    pub cookie_frequency_cap_setting: Option<FrequencyCap>,
    pub min_effective_frequency: Option<i32>,
    pub effective_frequency_limit: Option<EffectiveFrequencyLimit>,
    pub targeting: Option<Targeting>,
    pub planned_products: Vec<PlannedProduct>,
    pub forecast_metric_options: Option<ForecastMetricOptions>,
    pub customer_reach_group: Option<String>,
}

Request message for [ReachPlanService.GenerateReachForecast][google.ads.googleads.v16.services.ReachPlanService.GenerateReachForecast].

Fields

customer_id: String

Required. The ID of the customer.

currency_code: Option<String>

The currency code. Three-character ISO 4217 currency code.

campaign_duration: Option<CampaignDuration>

Required. Campaign duration.

cookie_frequency_cap: Option<i32>

Chosen cookie frequency cap to be applied to each planned product. This is equivalent to the frequency cap exposed in Google Ads when creating a campaign, it represents the maximum number of times an ad can be shown to the same user. If not specified, no cap is applied.

This field is deprecated in v4 and will eventually be removed. Use cookie_frequency_cap_setting instead.

cookie_frequency_cap_setting: Option<FrequencyCap>

Chosen cookie frequency cap to be applied to each planned product. This is equivalent to the frequency cap exposed in Google Ads when creating a campaign, it represents the maximum number of times an ad can be shown to the same user during a specified time interval. If not specified, a default of 0 (no cap) is applied.

This field replaces the deprecated cookie_frequency_cap field.

min_effective_frequency: Option<i32>

Chosen minimum effective frequency (the number of times a person was exposed to the ad) for the reported reach metrics [1-10]. This won’t affect the targeting, but just the reporting. If not specified, a default of 1 is applied.

This field cannot be combined with the effective_frequency_limit field.

effective_frequency_limit: Option<EffectiveFrequencyLimit>

The highest minimum effective frequency (the number of times a person was exposed to the ad) value [1-10] to include in Forecast.effective_frequency_breakdowns. If not specified, Forecast.effective_frequency_breakdowns will not be provided.

The effective frequency value provided here will also be used as the minimum effective frequency for the reported reach metrics.

This field cannot be combined with the min_effective_frequency field.

targeting: Option<Targeting>

The targeting to be applied to all products selected in the product mix.

This is planned targeting: execution details might vary based on the advertising product, consult an implementation specialist.

See specific metrics for details on how targeting affects them.

planned_products: Vec<PlannedProduct>

Required. The products to be forecast. The max number of allowed planned products is 15.

forecast_metric_options: Option<ForecastMetricOptions>

Controls the forecast metrics returned in the response.

customer_reach_group: Option<String>

The name of the customer being planned for. This is a user-defined value.

Implementations

impl GenerateReachForecastRequest

pub fn currency_code(&self) -> &str

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

pub fn cookie_frequency_cap(&self) -> i32

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

pub fn min_effective_frequency(&self) -> i32

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

pub fn customer_reach_group(&self) -> &str

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

Trait Implementations

impl Clone for GenerateReachForecastRequest

fn clone(&self) -> GenerateReachForecastRequest

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for GenerateReachForecastRequest

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

Formats the value using the given formatter.

impl Default for GenerateReachForecastRequest

fn default() -> Self

Returns the “default value” for a type.

impl Message for GenerateReachForecastRequest

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 GenerateReachForecastRequest

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