Struct googapis::google::ads::googleads::v9::resources::CampaignBudget [−][src]
pub struct CampaignBudget {Show 17 fields
pub resource_name: String,
pub id: Option<i64>,
pub name: Option<String>,
pub amount_micros: Option<i64>,
pub total_amount_micros: Option<i64>,
pub status: i32,
pub delivery_method: i32,
pub explicitly_shared: Option<bool>,
pub reference_count: Option<i64>,
pub has_recommended_budget: Option<bool>,
pub recommended_budget_amount_micros: Option<i64>,
pub period: i32,
pub recommended_budget_estimated_change_weekly_clicks: Option<i64>,
pub recommended_budget_estimated_change_weekly_cost_micros: Option<i64>,
pub recommended_budget_estimated_change_weekly_interactions: Option<i64>,
pub recommended_budget_estimated_change_weekly_views: Option<i64>,
pub type: i32,
}
Expand description
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: Option<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: Option<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: Option<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: Option<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.
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: Option<i64>
Output only. The number of campaigns actively using the budget.
This field is read-only.
has_recommended_budget: Option<bool>
Output only. Indicates whether there is a recommended budget for this campaign budget.
This field is read-only.
recommended_budget_amount_micros: Option<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: Option<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: Option<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: Option<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: Option<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.
Implementations
Returns the enum value of status
, or the default if the field is set to an invalid enum value.
Sets status
to the provided enum value.
Returns the enum value of delivery_method
, or the default if the field is set to an invalid enum value.
Sets delivery_method
to the provided enum value.
Returns the enum value of period
, or the default if the field is set to an invalid enum value.
Sets period
to the provided enum value.
Returns the enum value of type
, or the default if the field is set to an invalid enum value.
Sets type
to the provided enum value.
Returns the value of amount_micros
, or the default value if amount_micros
is unset.
Returns the value of total_amount_micros
, or the default value if total_amount_micros
is unset.
Returns the value of explicitly_shared
, or the default value if explicitly_shared
is unset.
Returns the value of reference_count
, or the default value if reference_count
is unset.
Returns the value of has_recommended_budget
, or the default value if has_recommended_budget
is unset.
Returns the value of recommended_budget_amount_micros
, or the default value if recommended_budget_amount_micros
is unset.
Returns the value of recommended_budget_estimated_change_weekly_clicks
, or the default value if recommended_budget_estimated_change_weekly_clicks
is unset.
Returns the value of recommended_budget_estimated_change_weekly_cost_micros
, or the default value if recommended_budget_estimated_change_weekly_cost_micros
is unset.
Returns the value of recommended_budget_estimated_change_weekly_interactions
, or the default value if recommended_budget_estimated_change_weekly_interactions
is unset.
Returns the value of recommended_budget_estimated_change_weekly_views
, or the default value if recommended_budget_estimated_change_weekly_views
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 RefUnwindSafe for CampaignBudget
impl Send for CampaignBudget
impl Sync for CampaignBudget
impl Unpin for CampaignBudget
impl UnwindSafe for CampaignBudget
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