Struct google_api_proto::google::ads::googleads::v17::services::Forecast

pub struct Forecast {
    pub on_target_reach: Option<i64>,
    pub total_reach: Option<i64>,
    pub on_target_impressions: Option<i64>,
    pub total_impressions: Option<i64>,
    pub viewable_impressions: Option<i64>,
    pub effective_frequency_breakdowns: Vec<EffectiveFrequencyBreakdown>,
    pub on_target_coview_reach: Option<i64>,
    pub total_coview_reach: Option<i64>,
    pub on_target_coview_impressions: Option<i64>,
    pub total_coview_impressions: Option<i64>,
    pub views: Option<i64>,
}

Forecasted traffic metrics for the planned products and targeting.

Fields

on_target_reach: Option<i64>

Number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times that exactly matches the Targeting.

Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the on_target_reach value will be rounded to 0.

total_reach: Option<i64>

Total number of unique people reached at least GenerateReachForecastRequest.min_effective_frequency or GenerateReachForecastRequest.effective_frequency_limit times. This includes people that may fall outside the specified Targeting.

Note that a minimum number of unique people must be reached in order for data to be reported. If the minimum number is not met, the total_reach value will be rounded to 0.

on_target_impressions: Option<i64>

Number of ad impressions that exactly matches the Targeting.

total_impressions: Option<i64>

Total number of ad impressions. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.

viewable_impressions: Option<i64>

Number of times the ad’s impressions were considered viewable. See https://support.google.com/google-ads/answer/7029393 for more information about what makes an ad viewable and how viewability is measured.

effective_frequency_breakdowns: Vec<EffectiveFrequencyBreakdown>

A list of effective frequency forecasts. The list is ordered starting with 1+ and ending with the value set in GenerateReachForecastRequest.effective_frequency_limit. If no effective_frequency_limit was set, this list will be empty.

on_target_coview_reach: Option<i64>

Number of unique people reached that exactly matches the Targeting including co-viewers.

total_coview_reach: Option<i64>

Number of unique people reached including co-viewers. This includes people that may fall outside the specified Targeting.

on_target_coview_impressions: Option<i64>

Number of ad impressions that exactly matches the Targeting including co-viewers.

total_coview_impressions: Option<i64>

Total number of ad impressions including co-viewers. This includes impressions that may fall outside the specified Targeting, due to insufficient information on signed-in users.

views: Option<i64>

Number of ad views forecasted for the specified product and targeting. A view is counted when a viewer views a larger portion or the entirety of an ad beyond an impression.

See https://support.google.com/google-ads/answer/2375431 for more information on views.

Implementations

impl Forecast

pub fn on_target_reach(&self) -> i64

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

pub fn total_reach(&self) -> i64

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

pub fn on_target_impressions(&self) -> i64

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

pub fn total_impressions(&self) -> i64

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

pub fn viewable_impressions(&self) -> i64

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

pub fn on_target_coview_reach(&self) -> i64

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

pub fn total_coview_reach(&self) -> i64

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

pub fn on_target_coview_impressions(&self) -> i64

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

pub fn total_coview_impressions(&self) -> i64

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

pub fn views(&self) -> i64

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

Trait Implementations

impl Clone for Forecast

fn clone(&self) -> Forecast

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Forecast

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

Formats the value using the given formatter.

impl Default for Forecast

fn default() -> Self

Returns the “default value” for a type.

impl Message for Forecast

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 Forecast

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