Struct gapi_grpc::google::ads::googleads::v6::services::GenerateReachForecastRequest

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

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

Fields

customer_id: String

Required. The ID of the customer.

currency_code: String

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

campaign_duration: Option<CampaignDuration>

Required. Campaign duration.

cookie_frequency_cap: i32

Desired cookie frequency cap that will 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. Please use cookie_frequency_cap_setting instead.

cookie_frequency_cap_setting: Option<FrequencyCap>

Desired cookie frequency cap that will 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, no cap is applied.

This field replaces the deprecated cookie_frequency_cap field.

min_effective_frequency: i32

Desired 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.

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, please consult an implementation specialist.

See specific metrics for details on how targeting affects them.

In some cases, targeting may be overridden using the PlannedProduct.advanced_product_targeting field.

planned_products: Vec<PlannedProduct>

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

Trait Implementations

impl Clone for GenerateReachForecastRequest

fn clone(&self) -> GenerateReachForecastRequest

Returns a copy of the value.

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

Returns the “default value” for a type.

impl Message for GenerateReachForecastRequest

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<GenerateReachForecastRequest> 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: &GenerateReachForecastRequest) -> bool

This method tests for !=.

impl StructuralPartialEq for GenerateReachForecastRequest