CampaignBudget

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/{budget_id}

id

Int64Value

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

StringValue

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

Int64Value

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

Int64Value

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

BudgetStatus

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

delivery_method

BudgetDeliveryMethod

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

BoolValue

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

Int64Value

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

This field is read-only.

Int64Value

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

BudgetPeriod

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

Int64Value

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

This field is read-only.

Int64Value

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.

Int64Value

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

This field is read-only.

Int64Value

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

This field is read-only.

type

BudgetType

Immutable. The type of the campaign budget.