Struct CampaignBudget

pub struct CampaignBudget {

    pub resource_name: String,
    pub id: i64,
    pub name: String,
    pub amount_micros: i64,
    pub total_amount_micros: i64,
    pub status: i32,
    pub delivery_method: i32,
    pub explicitly_shared: bool,
    pub reference_count: i64,
    pub has_recommended_budget: bool,
    pub recommended_budget_amount_micros: i64,
    pub period: i32,
    pub recommended_budget_estimated_change_weekly_clicks: i64,
    pub recommended_budget_estimated_change_weekly_cost_micros: i64,
    pub recommended_budget_estimated_change_weekly_interactions: i64,
    pub recommended_budget_estimated_change_weekly_views: i64,
    pub type: i32,
    pub aligned_bidding_strategy_id: i64,
}

A campaign budget.

Fields

resource_name: String

Immutable. The resource name of the campaign budget. Campaign budget resource names have the form:

customers/{customer_id}/campaignBudgets/{campaign_budget_id}

id: i64

Output only. The ID of the campaign budget.

A campaign budget is created using the CampaignBudgetService create operation and is assigned a budget ID. A budget ID can be shared across different campaigns; the system will then allocate the campaign budget among different campaigns to get optimum results.

name: String

The name of the campaign budget.

When creating a campaign budget through CampaignBudgetService, every explicitly shared campaign budget must have a non-null, non-empty name. Campaign budgets that are not explicitly shared derive their name from the attached campaign’s name.

The length of this string must be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).

amount_micros: i64

The amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit. Monthly spend is capped at 30.4 times this amount.

total_amount_micros: i64

The lifetime amount of the budget, in the local currency for the account. Amount is specified in micros, where one million is equivalent to one currency unit.

status: i32

Output only. The status of this campaign budget. This field is read-only.

delivery_method: i32

The delivery method that determines the rate at which the campaign budget is spent.

Defaults to STANDARD if unspecified in a create operation.

explicitly_shared: bool

Specifies whether the budget is explicitly shared. Defaults to true if unspecified in a create operation.

If true, the budget was created with the purpose of sharing across one or more campaigns.

If false, the budget was created with the intention of only being used with a single campaign. The budget’s name and status will stay in sync with the campaign’s name and status. Attempting to share the budget with a second campaign will result in an error.

A non-shared budget can become an explicitly shared. The same operation must also assign the budget a name.

A shared campaign budget can never become non-shared.

reference_count: i64

Output only. The number of campaigns actively using the budget.

This field is read-only.

has_recommended_budget: bool

Output only. Indicates whether there is a recommended budget for this campaign budget.

This field is read-only.

recommended_budget_amount_micros: i64

Output only. The recommended budget amount. If no recommendation is available, this will be set to the budget amount. Amount is specified in micros, where one million is equivalent to one currency unit.

This field is read-only.

period: i32

Immutable. Period over which to spend the budget. Defaults to DAILY if not specified.

recommended_budget_estimated_change_weekly_clicks: i64

Output only. The estimated change in weekly clicks if the recommended budget is applied.

This field is read-only.

recommended_budget_estimated_change_weekly_cost_micros: i64

Output only. The estimated change in weekly cost in micros if the recommended budget is applied. One million is equivalent to one currency unit.

This field is read-only.

recommended_budget_estimated_change_weekly_interactions: i64

Output only. The estimated change in weekly interactions if the recommended budget is applied.

This field is read-only.

recommended_budget_estimated_change_weekly_views: i64

Output only. The estimated change in weekly views if the recommended budget is applied.

This field is read-only.

type: i32

Immutable. The type of the campaign budget.

aligned_bidding_strategy_id: i64

ID of the portfolio bidding strategy that this shared campaign budget is aligned with. When a bidding strategy and a campaign budget are aligned, they are attached to the same set of campaigns. After a campaign budget is aligned with a bidding strategy, campaigns that are added to the campaign budget must also use the aligned bidding strategy.

Implementations

impl CampaignBudget

pub fn status(&self) -> BudgetStatus

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

pub fn set_status(&mut self, value: BudgetStatus)

Sets status to the provided enum value.

pub fn delivery_method(&self) -> BudgetDeliveryMethod

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

pub fn set_delivery_method(&mut self, value: BudgetDeliveryMethod)

Sets delivery_method to the provided enum value.

pub fn period(&self) -> BudgetPeriod

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

pub fn set_period(&mut self, value: BudgetPeriod)

Sets period to the provided enum value.

pub fn type(&self) -> BudgetType

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

pub fn set_type(&mut self, value: BudgetType)

Sets type to the provided enum value.

Trait Implementations

impl Clone for CampaignBudget

fn clone(&self) -> CampaignBudget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CampaignBudget

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

Formats the value using the given formatter.

impl Default for CampaignBudget

fn default() -> Self

Returns the “default value” for a type.

impl Message for CampaignBudget

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 CampaignBudget

fn eq(&self, other: &CampaignBudget) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CampaignBudget