Caution: You are viewing documentation for the API's REST interface. Most of our official client libraries use gRPC. See the REST Introduction for details.

REST Resource: customers.campaignBudgets

Resource: CampaignBudget

A campaign budget.

JSON representation
{
  "resourceName": string,
  "status": enum (BudgetStatus),
  "deliveryMethod": enum (BudgetDeliveryMethod),
  "period": enum (BudgetPeriod),
  "type": enum (BudgetType),
  "id": string,
  "name": string,
  "amountMicros": string,
  "totalAmountMicros": string,
  "explicitlyShared": boolean,
  "referenceCount": string,
  "hasRecommendedBudget": boolean,
  "recommendedBudgetAmountMicros": string,
  "recommendedBudgetEstimatedChangeWeeklyClicks": string,
  "recommendedBudgetEstimatedChangeWeeklyCostMicros": string,
  "recommendedBudgetEstimatedChangeWeeklyInteractions": string,
  "recommendedBudgetEstimatedChangeWeeklyViews": string
}
Fields
resourceName

string

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

customers/{customerId}/campaignBudgets/{campaign_budget_id}

status

enum (BudgetStatus)

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

deliveryMethod

enum (BudgetDeliveryMethod)

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

Defaults to STANDARD if unspecified in a create operation.

period

enum (BudgetPeriod)

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

type

enum (BudgetType)

Immutable. The type of the campaign budget.

id

string (int64 format)

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).

amountMicros

string (int64 format)

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.

totalAmountMicros

string (int64 format)

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.

explicitlyShared

boolean

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.

referenceCount

string (int64 format)

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

This field is read-only.

recommendedBudgetAmountMicros

string (int64 format)

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.

recommendedBudgetEstimatedChangeWeeklyClicks

string (int64 format)

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

This field is read-only.

recommendedBudgetEstimatedChangeWeeklyCostMicros

string (int64 format)

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.

recommendedBudgetEstimatedChangeWeeklyInteractions

string (int64 format)

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

This field is read-only.

recommendedBudgetEstimatedChangeWeeklyViews

string (int64 format)

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

This field is read-only.

BudgetStatus

Possible statuses of a Budget.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
ENABLED Budget is enabled.
REMOVED Budget is removed.

BudgetDeliveryMethod

Possible delivery methods of a Budget.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
STANDARD The budget server will throttle serving evenly across the entire time period.
ACCELERATED The budget server will not throttle serving, and ads will serve as fast as possible.

BudgetPeriod

Possible period of a Budget.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
DAILY Daily budget.
CUSTOM_PERIOD Custom budget, added back in V5. Custom bugdet can be used with total_amount to specify lifetime budget limit. See: https://support.google.com/google-ads/answer/6385083 for more info.

BudgetType

Possible Budget types.

Enums
UNSPECIFIED Not specified.
UNKNOWN Used for return value only. Represents value unknown in this version.
STANDARD Budget type for standard Google Ads usage. Caps daily spend at two times the specified budget amount. Full details: https://support.google.com/google-ads/answer/6385083
HOTEL_ADS_COMMISSION

Budget type for Hotels Ads commission program. Full details: https://support.google.com/google-ads/answer/9243945

This type is only supported by campaigns with AdvertisingChannelType.HOTEL, BiddingStrategyType.COMMISSION and PaymentMode.CONVERSION_VALUE.

FIXED_CPA

Budget type with a fixed cost-per-acquisition (conversion). Full details: https://support.google.com/google-ads/answer/7528254

This type is only supported by campaigns with AdvertisingChannelType.DISPLAY (excluding AdvertisingChannelSubType.DISPLAY_GMAIL), BiddingStrategyType.TARGET_CPA and PaymentMode.CONVERSIONS.

SMART_CAMPAIGN

Budget type for Smart Campaign. Full details: https://support.google.com/google-ads/answer/7653509

This type is only supported by campaigns with AdvertisingChannelType.SMART and AdvertisingChannelSubType.SMART_CAMPAIGN.

Methods

get

Returns the requested Campaign Budget in full detail.

mutate

Creates, updates, or removes campaign budgets.