BudgetOrderService (v201806)

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/v201806/BudgetOrderService?wsdl
Namespace
https://adwords.google.com/api/adwords/billing/v201806
Operations
Errors

get

Gets a list of BudgetOrders using the generic selector.

Parameters

Field Type Description
serviceSelector cm:Selector specifies which BudgetOrder to return.

Response

Field Type Description
rval BudgetOrderPage 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 BillingAccount[] 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 BudgetOrderOperation[] A list of operations, however currently we only support one operation per mutate call.

Response

Field Type Description
rval BudgetOrderReturnValue BudgetOrders affected by the mutate operation.

Errors

Error Reasons
AuthenticationError Errors returned when Authentication failed.
Enumerations
AUTHENTICATION_FAILED
Authentication of the request failed.
CLIENT_CUSTOMER_ID_IS_REQUIRED
Client Customer Id is required if CustomerIdMode is set to CLIENT_EXTERNAL_CUSTOMER_ID. Starting version V201409 ClientCustomerId will be required for all requests except for CustomerService.get
CLIENT_EMAIL_REQUIRED
Client Email is required if CustomerIdMode is set to CLIENT_EXTERNAL_EMAIL_FIELD.
CLIENT_CUSTOMER_ID_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_INVALID
Client customer Id is not a number.
CLIENT_EMAIL_FAILED_TO_AUTHENTICATE
Client email is not a valid customer email.
CUSTOMER_NOT_FOUND
No customer found for the customer id provided in the header.
GOOGLE_ACCOUNT_DELETED
Client's Google Account is deleted.
GOOGLE_ACCOUNT_COOKIE_INVALID
Google account login token in the cookie is invalid.
FAILED_TO_AUTHENTICATE_GOOGLE_ACCOUNT
problem occurred during Google account authentication.
GOOGLE_ACCOUNT_USER_AND_ADS_USER_MISMATCH
The user in the google account login token does not match the UserId in the cookie.
LOGIN_COOKIE_REQUIRED
Login cookie is required for authentication.
NOT_ADS_USER
User in the cookie is not a valid Ads user.
OAUTH_TOKEN_INVALID
Oauth token in the header is not valid.
OAUTH_TOKEN_EXPIRED
Oauth token in the header has expired.
OAUTH_TOKEN_DISABLED
Oauth token in the header has been disabled.
OAUTH_TOKEN_REVOKED
Oauth token in the header has been revoked.
OAUTH_TOKEN_HEADER_INVALID
Oauth token HTTP header is malformed.
LOGIN_COOKIE_INVALID
Login cookie is not valid.
FAILED_TO_RETRIEVE_LOGIN_COOKIE
Failed to decrypt the login cookie.
USER_ID_INVALID
User Id in the header is not a valid id.
AuthorizationError Errors encountered when trying to authorize a user.
Enumerations
UNABLE_TO_AUTHORIZE
Could not complete authorization due to an internal problem.
NO_ADWORDS_ACCOUNT_FOR_CUSTOMER
Customer has no AdWords account.
USER_PERMISSION_DENIED
User doesn't have permission to access customer.
EFFECTIVE_USER_PERMISSION_DENIED
Effective user doesn't have permission to access this customer.
CUSTOMER_NOT_ACTIVE
Access denied since the customer is not active.
USER_HAS_READONLY_PERMISSION
User has read-only permission cannot mutate.
NO_CUSTOMER_FOUND
No customer found.
SERVICE_ACCESS_DENIED
Developer doesn't have permission to access service.
TWO_STEP_VERIFICATION_NOT_ENROLLED
The customer has a policy to enforce 2-Step Verification, but the user is not enrolled.
ADVANCED_PROTECTION_NOT_ENROLLED
The customer has a policy to enforce enrollment in the Advanced Protection Program, but the user is not enrolled.
BudgetOrderError Error information for BudgetOrderService.
Enumerations
BUDGET_APPROVAL_IN_PROGRESS
Existing pending request is being approved.
SERVICE_UNAVAILABLE
A server backend was not available.
INVALID_BILLING_ACCOUNT
The billing account was invalid.
GENERIC_BILLING_ERROR
Unspecified billing service error.
INVALID_BILLING_ACCOUNT_ID_FORMAT
The billing account ID format was invalid.
INVALID_BUDGET_DATE_RANGE
Budget date range was invalid.
BUDGET_UPDATE_DENIED
User does not have permission to update this budget.
BUDGET_ALREADY_STARTED
User attempted to cancel a started budget.
BUDGET_ALREADY_ENDED
User attempted to change an ended budget.
INVALID_CONSTRAINT
Invalid amount, start date or end date specified.
INVALID_BID_TOO_LARGE
The bid is too high.
NO_SUCH_BUDGET_FOUND
Budget was not found.
INVALID_BUDGET_ALREADY_SPENT
The budget cannot be lowered below the amount which has already been spent.
INVALID_TIMEZONE_IN_DATE
Time zone from user input is different from user's account time zone.
ACCOUNT_BUDGET_ID_SET_IN_ADD
The BudgetOrder's ID was set in an add operation.
MORE_THAN_ONE_OPERATIONS
We don't support more than one operation per mutate call.
INVALID_MANAGER_ACCOUNT
Manager account not found.
UNKNOWN
ClientTermsError Error due to user not accepting the AdWords terms of service.
Enumerations
INCOMPLETE_SIGNUP_CURRENT_ADWORDS_TNC_NOT_AGREED
Customer has not agreed to the latest AdWords Terms & Conditions
CustomerOrderLineError Error information returned for CustomerOrderLineService.
Enumerations
INVALID_ORDER_LINE_ID
Order Line Id does not exist.
END_DATE_BEFORE_START_DATE
End date must be later than start date
CREATE_IN_PAST
Cannot create order line with start date in the past
ALREADY_STARTED
Cannot change start date after the order line has started
ALREADY_SPENT
Cannot set spending limit below what has already been spent
FINISHED_IN_THE_PAST
Cannot move end date into the past
OVERLAP_DATE_RANGE
Cannot make overlapping order lines.
END_DATE_PAST_MAX
Cannot set contract start date to be after actual start date
PARENT_IS_SELF
only cancelled order lines may have themselves as parent
CANNOT_CANCEL_STARTED
Cannot cancel started order line
ORDERLINE_BEING_MODIFIED_IS_NOT_NORMAL_OR_PENDING
Only Order lines in normal or pending state can be modified.
MORE_THAN_ONE_OPERATION_NOT_PERMITTED
More than one operation not permitted per call.
INVALID_TIMEZONE_IN_DATE_RANGES
StartDate and EndDate should pass in the customer's account timeZone.
UNKNOWN
DatabaseError Errors that are thrown due to a database access problem.
Enumerations
CONCURRENT_MODIFICATION
A concurrency problem occurred as two threads were attempting to modify same object.
PERMISSION_DENIED
The permission was denied to access an object.
ACCESS_PROHIBITED
The user's access to an object has been prohibited.
CAMPAIGN_PRODUCT_NOT_SUPPORTED
Requested campaign belongs to a product that is not supported by the api.
DUPLICATE_KEY
a duplicate key was detected upon insertion
DATABASE_ERROR
a database error has occurred
UNKNOWN
an unknown error has occurred
DateError Errors associated with invalid dates and date ranges.
Enumerations
INVALID_FIELD_VALUES_IN_DATE
Given field values do not correspond to a valid date.
INVALID_FIELD_VALUES_IN_DATE_TIME
Given field values do not correspond to a valid date time.
INVALID_STRING_DATE
The string date's format should be yyyymmdd.
INVALID_STRING_DATE_RANGE
The string date range's format should be yyyymmdd yyyymmdd.
INVALID_STRING_DATE_TIME
The string date time's format should be yyyymmdd hhmmss [tz].
EARLIER_THAN_MINIMUM_DATE
Date is before allowed minimum.
LATER_THAN_MAXIMUM_DATE
Date is after allowed maximum.
DATE_RANGE_MINIMUM_DATE_LATER_THAN_MAXIMUM_DATE
Date range bounds are not in order.
DATE_RANGE_MINIMUM_AND_MAXIMUM_DATES_BOTH_NULL
Both dates in range are null.
DistinctError Errors related to distinct ids or content.
Enumerations
DUPLICATE_ELEMENT
DUPLICATE_TYPE
EntityNotFound An id did not correspond to an entity, or it referred to an entity which does not belong to the customer.
Enumerations
INVALID_ID
The specified id refered to an entity which either doesn't exist or is not accessible to the customer. e.g. campaign belongs to another customer.
IdError Errors associated with the ids.
Enumerations
NOT_FOUND
Id not found
InternalApiError Indicates that a server-side error has occured. InternalApiErrors are generally not the result of an invalid request or message sent by the client.
Enumerations
UNEXPECTED_INTERNAL_API_ERROR
API encountered an unexpected internal error.
TRANSIENT_ERROR
A temporary error occurred during the request. Please retry.
UNKNOWN
The cause of the error is not known or only defined in newer versions.
DOWNTIME
The API is currently unavailable for a planned downtime.
ERROR_GENERATING_RESPONSE
Mutate succeeded but server was unable to build response. Client should not retry mutate.
NewEntityCreationError Error associated with creation of new entities.
Enumerations
CANNOT_SET_ID_FOR_ADD
Do not set the id field while creating new entities.
DUPLICATE_TEMP_IDS
Creating more than one entity with the same temp ID is not allowed.
TEMP_ID_ENTITY_HAD_ERRORS
Parent object with specified temp id failed validation, so no deep validation will be done for this child entity.
NotEmptyError Errors corresponding with violation of a NOT EMPTY check.
Enumerations
EMPTY_LIST
NotWhitelistedError Indicates that the customer is not whitelisted for accessing the API.
Enumerations
CUSTOMER_NOT_WHITELISTED_FOR_API
Customer is not whitelisted for accessing the API.
NullError Errors associated with violation of a NOT NULL check.
Enumerations
NULL_CONTENT
Specified list/container must not contain any null elements
OperationAccessDenied Operation not permitted due to the invoked service's access policy.
Enumerations
ACTION_NOT_PERMITTED
Unauthorized invocation of a service's method (get, mutate, etc.)
ADD_OPERATION_NOT_PERMITTED
Unauthorized ADD operation in invoking a service's mutate method.
REMOVE_OPERATION_NOT_PERMITTED
Unauthorized REMOVE operation in invoking a service's mutate method.
SET_OPERATION_NOT_PERMITTED
Unauthorized SET operation in invoking a service's mutate method.
MUTATE_ACTION_NOT_PERMITTED_FOR_CLIENT
A mutate action is not allowed on this campaign, from this client.
OPERATION_NOT_PERMITTED_FOR_CAMPAIGN_TYPE
This operation is not permitted on this campaign type
ADD_AS_REMOVED_NOT_PERMITTED
An ADD operation may not set status to REMOVED.
OPERATION_NOT_PERMITTED_FOR_REMOVED_ENTITY
This operation is not allowed because the campaign or adgroup is removed.
OPERATION_NOT_PERMITTED_FOR_AD_GROUP_TYPE
This operation is not permitted on this ad group type.
UNKNOWN
The reason the invoked method or operation is prohibited is not known (the client may be of an older version than the server).
OperatorError Errors due to the use of unsupported operations.
Enumerations
OPERATOR_NOT_SUPPORTED
PagingError Error codes for pagination.
Enumerations
START_INDEX_CANNOT_BE_NEGATIVE
The start index value cannot be a negative number.
NUMBER_OF_RESULTS_CANNOT_BE_NEGATIVE
The number of results cannot be a negative number.
UNKNOWN
QuotaCheckError Encapsulates the errors thrown during developer quota checks.
Enumerations
INVALID_TOKEN_HEADER
Customer passed in an invalid token in the header.
ACCOUNT_DELINQUENT
Customer is marked delinquent.
ACCOUNT_INACCESSIBLE
Customer is a fraudulent.
ACCOUNT_INACTIVE
Inactive Account.
INCOMPLETE_SIGNUP
Signup not complete
DEVELOPER_TOKEN_NOT_APPROVED
Developer token is not approved for production access, and the customer is attempting to access a production account.
TERMS_AND_CONDITIONS_NOT_SIGNED
Terms and conditions are not signed.
MONTHLY_BUDGET_REACHED
Monthly budget quota reached.
QUOTA_EXCEEDED
Monthly budget quota exceeded.
RangeError A list of all errors associated with the Range constraint.
Enumerations
TOO_LOW
TOO_HIGH
RateExceededError Signals that a call failed because a measured rate exceeded.
Enumerations
RATE_EXCEEDED
Rate exceeded.
ReadOnlyError Errors from attempting to write to read-only fields.
Enumerations
READ_ONLY
RejectedError Indicates that a field was rejected due to compatibility issues.
Enumerations
UNKNOWN_VALUE
Unknown value encountered
RequestError Encapsulates the generic errors thrown when there's an error with user request.
Enumerations
UNKNOWN
Error reason is unknown.
INVALID_INPUT
Invalid input.
UNSUPPORTED_VERSION
The api version in the request has been discontinued. Please update to the new AdWords API version.
RequiredError Errors due to missing required field.
Enumerations
REQUIRED
Missing required field.
SelectorError Represents possible error codes for Selector.
Enumerations
INVALID_FIELD_NAME
The field name is not valid.
MISSING_FIELDS
The list of fields is null or empty.
MISSING_PREDICATES
The list of predicates is null or empty.
OPERATOR_DOES_NOT_SUPPORT_MULTIPLE_VALUES
Predicate operator does not support multiple values. Multiple values are supported only for Predicate.Operator.IN and Predicate.Operator.NOT_IN.
INVALID_PREDICATE_ENUM_VALUE
The predicate enum value is not valid.
MISSING_PREDICATE_OPERATOR
The predicate operator is empty.
MISSING_PREDICATE_VALUES
The predicate values are empty.
INVALID_PREDICATE_FIELD_NAME
The predicate field name is not valid.
INVALID_PREDICATE_OPERATOR
The predicate operator is not valid.
INVALID_FIELD_SELECTION
Invalid selection of fields.
INVALID_PREDICATE_VALUE
The predicate value is not valid.
INVALID_SORT_FIELD_NAME
The sort field name is not valid or the field is not sortable.
SELECTOR_ERROR
Standard error.
FILTER_BY_DATE_RANGE_NOT_SUPPORTED
Filtering by date range is not supported.
START_INDEX_IS_TOO_HIGH
Selector paging start index is too high.
TOO_MANY_PREDICATE_VALUES
The values list in a predicate was too long.
UNKNOWN_ERROR
SizeLimitError Indicates that the number of entries in the request or response exceeds the system limit.
Enumerations
REQUEST_SIZE_LIMIT_EXCEEDED
The number of entries in the request exceeds the system limit.
RESPONSE_SIZE_LIMIT_EXCEEDED
The number of entries in the response exceeds the system limit.
INTERNAL_STORAGE_ERROR
The account is too large to load.
UNKNOWN
StatsQueryError Represents possible error codes when querying for stats.
Enumerations
DATE_NOT_IN_VALID_RANGE
Date is outside of allowed range.
StringFormatError A list of error code for reporting invalid content of input strings.
Enumerations
UNKNOWN
ILLEGAL_CHARS
The input string value contains disallowed characters.
INVALID_FORMAT
The input string value is invalid for the associated field.
StringLengthError Errors associated with the length of the given string being out of bounds.
Enumerations
TOO_SHORT
TOO_LONG

Send feedback about...

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