The AdWords API will sunset on April 27, 2022. Migrate to the Google Ads API to take advantage of the latest Google Ads features.

type BudgetOrder (v201809)

Service
BudgetOrderService
Dependencies
BudgetOrderOperation BudgetOrderPage BudgetOrderReturnValue
▼
BudgetOrder
▼
cm:Money

A budget order links an account-wide budget with a BillingAccount.

Namespace
https://adwords.google.com/api/adwords/billing/v201809

Field

billingAccountId

xsd:string

This must be passed as a string with dashes, e.g. "1234-5678-9012-3456".

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

id

xsd:long

This field can be selected using the value "Id".
This field can be filtered on.
This field is required and should not be null when it is contained within Operators : SET, REMOVE.

billingAccountName

xsd:string

Enables user to specify meaningful name for a billing account to aid in reconciling monthly invoices. This name will be printed in the monthly invoices.

This field can be selected using the value "BillingAccountName".
This field can be filtered on.
The length of this string should be between 0 and 80, inclusive, (trimmed).

poNumber

xsd:string

Enables user to enter a value that helps them reference this budget order in their monthly invoices. This number will be printed in the monthly invoices.

This field can be selected using the value "PoNumber".
This field can be filtered on.
The length of this string should be between 0 and 80, inclusive, (trimmed).

budgetOrderName

xsd:string

Enables user to specify meaningful name for referencing this budget order. A default name will be provided if none is specified. This name will be printed in the monthly invoices.

This field can be selected using the value "BudgetOrderName".
This field can be filtered on.
The length of this string should be between 0 and 150, inclusive, (trimmed).

primaryBillingId

xsd:string

A 12 digit billing ID assigned to the user by Google. This must be passed in as a string with dashes, e.g. "1234-5678-9012".

This field is required in an ADD operation if billingAccountId is not specified.

Note:Starting with v201708, this field is required in any ADD operation that sets or changes the billing account of a client account.

This field can be selected using the value "PrimaryBillingId".
This field can be filtered on.
The length of this string should be between 0 and 14, inclusive, (trimmed).

secondaryBillingId

xsd:string

For certain users, a secondary billing ID will be required on mutate.add. If this requirement was not communicated to the user, the user may ignore this parameter. If specified, this must be passed in as a string with dashes, e.g. "1234-5678-9012".

This field can be selected using the value "SecondaryBillingId".
This field can be filtered on.
The length of this string should be between 0 and 14, inclusive, (trimmed).

spendingLimit

cm:Money

The spending limit in micros. To specify an unlimited budget, set spendingLimit to -1, otherwise spendingLimit must be greater than 0. Note that for get requests, the spending limit includes any adjustments that have been applied to the budget order. For mutate, the spending limit represents the maximum allowed spend prior to considering any adjustments. When making mutate requests, make sure to account for any adjustments that may be reported in the get value of the spending limit.

This field can be selected using the value "SpendingLimit".
This field can be filtered on.
This field is required and should not be null when it is contained within Operators : ADD.

totalAdjustments

cm:Money

The adjustments amount in micros. Adjustments from Google come in the form of credits or debits to your budget order. This amount is the net sum of adjustments since the creation of the budget order. You can use the adjustments amount to compute your current base spendingLimit by subtracting your adjustments from the value returned from spendingLimit in get requests.

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

startDateTime

xsd:string

StartDateTime cannot be in the past, it must be on or before "20361231 235959 America/Los_Angeles". StartDateTime and EndDateTime must use the same time zone.

This field can be selected using the value "StartDateTime".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: REMOVE.
This field is required and should not be null when it is contained within Operators : ADD.

endDateTime

xsd:string

EndDateTime must be on or before "20361231 235959 America/Los_Angeles" or must set the same instant as "20371230 235959 America/Los_Angeles" to indicate infinite end date. StartDateTime and EndDateTime must use the same time zone.

This field can be selected using the value "EndDateTime".
This field can be filtered on.
This field is read only and will be ignored when sent to the API for the following Operators: REMOVE.
This field is required and should not be null when it is contained within Operators : ADD.

lastRequest

BudgetOrderRequest

Contains fields that provide information on the last set of values that were passed in through the parent BudgetOrder for mutate.add and mutate.set.

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