Service for managing BudgetOrders.
Note: The mutate
action in this service is available only
on a whitelist basis.
Warning: The BudgetOrderService
is limited to one operation per mutate request. Any attempt to make
more than one operation will result in an ApiException
.
- Production WSDL
-
https://adwords.google.com/api/adwords/billing/v201809/BudgetOrderService?wsdl
- Namespace
-
https://adwords.google.com/api/adwords/billing/v201809
- Operations
- Errors
-
- AuthenticationError
- AuthorizationError
- BudgetOrderError
- ClientTermsError
- CustomerOrderLineError
- DatabaseError
- DateError
- DistinctError
- EntityNotFound
- IdError
- InternalApiError
- NewEntityCreationError
- NotEmptyError
- NotWhitelistedError
- NullError
- OperationAccessDenied
- OperatorError
- PagingError
- QuotaCheckError
- RangeError
- RateExceededError
- ReadOnlyError
- RejectedError
- RequestError
- RequiredError
- SelectorError
- SizeLimitError
- StatsQueryError
- StringFormatError
- StringLengthError
get
Gets a list of BudgetOrders using the generic selector.
Parameters
Field | Type | Description |
---|---|---|
serviceSelector
|
|
specifies which BudgetOrder to return. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
A BudgetOrderPage of BudgetOrders of the client customer. All BudgetOrder fields are returned. Stats are not yet supported. |
getBillingAccounts
Returns all the open/active BillingAccounts associated with the current manager.
Parameters
Field | Type | Description |
---|
Response
Field | Type | Description |
---|---|---|
rval
|
|
A list of BillingAccounts. |
mutate
Adds, updates, or removes budget orders. Supported operations are:
ADD
: Adds a BudgetOrder to the billing account
specified by the billing account ID.
SET
: Sets the start/end date and amount of the
BudgetOrder.
REMOVE
: Cancels the BudgetOrder (status change).
Warning: The BudgetOrderService
is limited to one operation per mutate request. Any attempt to make more
than one operation will result in an ApiException
.
Note: This action is available only on a whitelist basis.
Parameters
Field | Type | Description |
---|---|---|
operations
|
|
A list of operations, however currently we only support one operation per mutate call. |
Response
Field | Type | Description |
---|---|---|
rval
|
|
BudgetOrders affected by the mutate operation. |
Errors
Error | Reasons |
---|---|
AuthenticationError
|
Errors returned when Authentication failed.
Enumerations
|
AuthorizationError
|
Errors encountered when trying to authorize a user.
Enumerations
|
BudgetOrderError
|
Error information for BudgetOrderService.
Enumerations
|
ClientTermsError
|
Error due to user not accepting the AdWords terms of service.
Enumerations
|
CustomerOrderLineError
|
Error information returned for CustomerOrderLineService.
Enumerations
|
DatabaseError
|
Errors that are thrown due to a database access problem.
Enumerations
|
DateError
|
Errors associated with invalid dates and date ranges.
Enumerations
|
DistinctError
|
Errors related to distinct ids or content.
Enumerations
|
EntityNotFound
|
An id did not correspond to an entity, or it referred to an entity which does not belong to the
customer.
Enumerations
|
IdError
|
Errors associated with the ids.
Enumerations
|
InternalApiError
|
Indicates that a server-side error has occured. InternalApiError s
are generally not the result of an invalid request or message sent by the
client.
Enumerations
|
NewEntityCreationError
|
Error associated with creation of new entities.
Enumerations
|
NotEmptyError
|
Errors corresponding with violation of a NOT EMPTY check.
Enumerations
|
NotWhitelistedError
|
Indicates that the customer is not whitelisted for accessing the API.
Enumerations
|
NullError
|
Errors associated with violation of a NOT NULL check.
Enumerations
|
OperationAccessDenied
|
Operation not permitted due to the invoked service's access policy.
Enumerations
|
OperatorError
|
Errors due to the use of unsupported operations.
Enumerations
|
PagingError
|
Error codes for pagination.
Enumerations
|
QuotaCheckError
|
Encapsulates the errors thrown during developer quota checks.
Enumerations
|
RangeError
|
A list of all errors associated with the Range constraint.
Enumerations
|
RateExceededError
|
Signals that a call failed because a measured rate exceeded.
Enumerations
|
ReadOnlyError
|
Errors from attempting to write to read-only fields.
Enumerations
|
RejectedError
|
Indicates that a field was rejected due to compatibility issues.
Enumerations
|
RequestError
|
Encapsulates the generic errors thrown when there's an error with user
request.
Enumerations
|
RequiredError
|
Errors due to missing required field.
Enumerations
|
SelectorError
|
Represents possible error codes for Selector.
Enumerations
|
SizeLimitError
|
Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
|
StatsQueryError
|
Represents possible error codes when querying for stats.
Enumerations
|
StringFormatError
|
A list of error code for reporting invalid content of input strings.
Enumerations
|
StringLengthError
|
Errors associated with the length of the given string being
out of bounds.
Enumerations
|