Struct google_api_proto::google::ads::admanager::v1::Goal

pub struct Goal {
    pub goal_type: i32,
    pub unit_type: i32,
    pub units: i64,
}

Defines the criteria a [LineItem][google.ads.admanager.v1.LineItem] needs to satisfy to meet its delivery goal.

Fields

goal_type: i32

The type of the goal for the LineItem. It defines the period over which the goal should be reached.

unit_type: i32

The type of the goal unit for the LineItem.

units: i64

If this is a primary goal, it represents the number or percentage of impressions or clicks that will be reserved. If the line item is of type [LineItemTypeEnum.LineItemType.SPONSORSHIP][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.SPONSORSHIP], it represents the percentage of available impressions reserved. If the line item is of type [LineItemTypeEnum.LineItemType.BULK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.BULK] or [LineItemTypeEnum.LineItemType.PRICE_PRIORITY][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.PRICE_PRIORITY], it represents the number of remaining impressions reserved. If the line item is of type [LineItemTypeEnum.LineItemType.NETWORK][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.NETWORK] or [LineItemTypeEnum.LineItemType.HOUSE][google.ads.admanager.v1.LineItemTypeEnum.LineItemType.HOUSE], it represents the percentage of remaining impressions reserved.

If this is an impression cap goal, it represents the number of impressions or conversions that the line item will stop serving at if reached. For valid line item types, see [LineItem.impressions_cap][].

Implementations

impl Goal

pub fn goal_type(&self) -> GoalType

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

pub fn set_goal_type(&mut self, value: GoalType)

Sets goal_type to the provided enum value.

pub fn unit_type(&self) -> UnitType

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

pub fn set_unit_type(&mut self, value: UnitType)

Sets unit_type to the provided enum value.

Trait Implementations

impl Clone for Goal

fn clone(&self) -> Goal

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Goal

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

Formats the value using the given formatter.

impl Default for Goal

fn default() -> Self

Returns the “default value” for a type.

impl Message for Goal

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Goal

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