Struct gapi_grpc::google::ads::googleads::v5::resources::AccountBudget

pub struct AccountBudget {
    pub resource_name: String,
    pub id: i64,
    pub billing_setup: String,
    pub status: i32,
    pub name: String,
    pub proposed_start_date_time: String,
    pub approved_start_date_time: String,
    pub total_adjustments_micros: i64,
    pub amount_served_micros: i64,
    pub purchase_order_number: String,
    pub notes: String,
    pub pending_proposal: Option<PendingAccountBudgetProposal>,
    pub proposed_end_time: Option<ProposedEndTime>,
    pub approved_end_time: Option<ApprovedEndTime>,
    pub proposed_spending_limit: Option<ProposedSpendingLimit>,
    pub approved_spending_limit: Option<ApprovedSpendingLimit>,
    pub adjusted_spending_limit: Option<AdjustedSpendingLimit>,
}

An account-level budget. It contains information about the budget itself, as well as the most recently approved changes to the budget and proposed changes that are pending approval. The proposed changes that are pending approval, if any, are found in ‘pending_proposal’. Effective details about the budget are found in fields prefixed ‘approved_’, ‘adjusted_’ and those without a prefix. Since some effective details may differ from what the user had originally requested (e.g. spending limit), these differences are juxtaposed via ‘proposed_’, ‘approved_’, and possibly ‘adjusted_’ fields.

This resource is mutated using AccountBudgetProposal and cannot be mutated directly. A budget may have at most one pending proposal at any given time. It is read through pending_proposal.

Once approved, a budget may be subject to adjustments, such as credit adjustments. Adjustments create differences between the ‘approved’ and ‘adjusted’ fields, which would otherwise be identical.

Fields

resource_name: String

Output only. The resource name of the account-level budget. AccountBudget resource names have the form:

customers/{customer_id}/accountBudgets/{account_budget_id}

id: i64

Output only. The ID of the account-level budget.

billing_setup: String

Output only. The resource name of the billing setup associated with this account-level budget. BillingSetup resource names have the form:

customers/{customer_id}/billingSetups/{billing_setup_id}

status: i32

Output only. The status of this account-level budget.

name: String

Output only. The name of the account-level budget.

proposed_start_date_time: String

Output only. The proposed start time of the account-level budget in yyyy-MM-dd HH:mm:ss format. If a start time type of NOW was proposed, this is the time of request.

approved_start_date_time: String

Output only. The approved start time of the account-level budget in yyyy-MM-dd HH:mm:ss format.

For example, if a new budget is approved after the proposed start time, the approved start time is the time of approval.

total_adjustments_micros: i64

Output only. The total adjustments amount.

An example of an adjustment is courtesy credits.

amount_served_micros: i64

Output only. The value of Ads that have been served, in micros.

This includes overdelivery costs, in which case a credit might be automatically applied to the budget (see total_adjustments_micros).

purchase_order_number: String

Output only. A purchase order number is a value that helps users reference this budget in their monthly invoices.

notes: String

Output only. Notes associated with the budget.

pending_proposal: Option<PendingAccountBudgetProposal>

Output only. The pending proposal to modify this budget, if applicable.

proposed_end_time: Option<ProposedEndTime>

The proposed end time of the account-level budget.

approved_end_time: Option<ApprovedEndTime>

The approved end time of the account-level budget.

For example, if a budget’s end time is updated and the proposal is approved after the proposed end time, the approved end time is the time of approval.

proposed_spending_limit: Option<ProposedSpendingLimit>

The proposed spending limit.

approved_spending_limit: Option<ApprovedSpendingLimit>

The approved spending limit.

For example, if the amount already spent by the account exceeds the proposed spending limit at the time the proposal is approved, the approved spending limit is set to the amount already spent.

adjusted_spending_limit: Option<AdjustedSpendingLimit>

The spending limit after adjustments have been applied. Adjustments are stored in total_adjustments_micros.

This value has the final say on how much the account is allowed to spend.

Implementations

impl AccountBudget

pub fn status(&self) -> AccountBudgetStatus

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: AccountBudgetStatus)

Sets status to the provided enum value.

Trait Implementations

impl Clone for AccountBudget

fn clone(&self) -> AccountBudget

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for AccountBudget

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

Formats the value using the given formatter.

impl Default for AccountBudget

fn default() -> AccountBudget

Returns the “default value” for a type.

impl Message for AccountBudget

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<AccountBudget> for AccountBudget

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl StructuralPartialEq for AccountBudget