Struct googapis::google::ads::googleads::v9::services::GenerateReachForecastRequest [−][src]
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>,
}
Expand description
Request message for [ReachPlanService.GenerateReachForecast][google.ads.googleads.v9.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.
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.
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, a default of 0 (no cap) is applied.
This field replaces the deprecated cookie_frequency_cap field.
min_effective_frequency: Option<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.
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, please 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.
Implementations
Returns the value of currency_code
, or the default value if currency_code
is unset.
Returns the value of cookie_frequency_cap
, or the default value if cookie_frequency_cap
is unset.
Returns the value of min_effective_frequency
, or the default value if min_effective_frequency
is unset.
Trait Implementations
fn merge_field<B>(
&mut self,
tag: u32,
wire_type: WireType,
buf: &mut B,
ctx: DecodeContext
) -> Result<(), DecodeError> where
B: Buf,
Returns the encoded length of the message without a length delimiter.
Encodes the message to a buffer. Read more
Encodes the message to a newly allocated buffer.
Encodes the message with a length-delimiter to a buffer. Read more
Encodes the message with a length-delimiter to a newly allocated buffer.
Decodes an instance of the message from a buffer. Read more
fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError> where
Self: Default,
B: Buf,
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.
Decodes an instance of the message from a buffer, and merges it into self
. Read more
Decodes a length-delimited instance of the message from buffer, and
merges it into self
. Read more
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
This method tests for !=
.
Auto Trait Implementations
impl Send for GenerateReachForecastRequest
impl Sync for GenerateReachForecastRequest
impl Unpin for GenerateReachForecastRequest
impl UnwindSafe for GenerateReachForecastRequest
Blanket Implementations
Mutably borrows from an owned value. Read more
Wrap the input message T
in a tonic::Request
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more