type Budget (v201802)

Budgets are used for managing the amount of money spent on AdWords.


Namespace
https://adwords.google.com/api/adwords/cm/v201802

Field

budgetId

xsd:long

A Budget is created using the BudgetService ADD operation and is assigned a BudgetId. The BudgetId is used when modifying the Budget with BudgetService, or associating the Budget to a Campaign with CampaignService. A BudgetId can be shared across different campaigns--the system will then allocate the Budget among the Campaigns to get the optimum result.

This field can be selected using the value "BudgetId".
This field can be filtered on.

name

xsd:string

Name of the Budget. When creating a Budget through BudgetService, every explicitly shared Budget must have a non-null non-empty name. In addition, all explicitly shared Budget names owned by an account must be distinct. Budgets that are not explicitly shared derive their name from the attached Campaign's name.

This field can be selected using the value "BudgetName".
This field is read only and will be ignored when sent to the API for the following Operators: REMOVE.
The length of this string should be between 1 and 255, inclusive, in UTF-8 bytes, (trimmed).

amount

Money

Amount of budget in the local currency for the account. This value represents an average daily budget amount; the actual daily costs might vary. See Charges and your daily budget.

This field can be selected using the value "Amount".
This field can be filtered on.
This field must be greater than or equal to 1.
This field is read only and will be ignored when sent to the API for the following Operators: REMOVE.

deliveryMethod

Budget.BudgetDeliveryMethod

Delivery method for the Budget which determines the rate at which the Budget is spent. Defaults to STANDARD and can be changed through BudgetService ADD or SET operations.


Enumerations
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.
UNKNOWN

This field can be selected using the value "DeliveryMethod".
This field is read only and will be ignored when sent to the API for the following Operators: REMOVE.

referenceCount

xsd:int

Number of campaigns actively using this budget. This field is only populated for Get operations.

This field can be selected using the value "BudgetReferenceCount".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

isExplicitlyShared

xsd:boolean

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

If false, this budget was created with the intention to be dedicatedly used with a single campaign, and the Budget's name and status will stay in the sync with the associated Campaign's name and status. Attempting to share this budget with a second Campaign will result in an error.

This field can be selected using the value "IsBudgetExplicitlyShared".
This field is read only and will be ignored when sent to the API for the following Operators: REMOVE.

status

Budget.BudgetStatus


Enumerations
ENABLED
REMOVED
UNKNOWN

This field can be selected using the value "BudgetStatus".
This field can be filtered on.
This field is read only and will be ignored when sent to the API.

Send feedback about...

AdWords API
AdWords API
Need help? Visit our support page.