Operations

• addAccount
• addMoney
• deleteBlockedDomainListForAccount
• deleteContinentBlockListFromAccount
• getAccount
• getAccountBalance
• getAccounts
• getAccountStatus
• getActiveCreditCard
• getBlockedDomainListForAccount
• getChargeAmount
• getContinentBlockListForAccount
• setActiveCreditCard
• setBlockedDomainListForAccount
• setChargeAmount
• setContinentBlockListForAccount
• updateAccount
• updateStatusForAccount

addAccount

Create a new account under the master account specified in the SOAP header of the request.

Capability required: MasterAccountWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
account	Account	The new account.
accountDailySpendLimit	double	The daily spend limit for the new account.

Response

Account - The new account.

addMoney

Add the indicated amount of money to the balance of the account (specified by accountID).

Capability required: AccountWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.
amount	double	The amount of money to add to the account.

Response

none

deleteBlockedDomainListForAccount

Delete the blocked domains for the account (specified by accountID).

Capability required: AccountWrite
License command group: AdvancedTools

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

none

deleteContinentBlockListFromAccount

Delete the blocked continents for the account (specified by accountID).

Capability required: AccountWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

none

getAccount

Return the account (specified by accountID).

Capability required: AccountRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

Account - The requested account.

getAccountBalance

Return the current balance for the account (specified by accountID).

Capability required: AccountRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

double - The account balance.

getAccounts

Return all accounts under the master account specified in the SOAP header of the request.

Capability required: AccountRead
License command group: Marketing

Parameters

none

Response

Account[] - A list of accounts.

getAccountStatus

Return the combined status of the account (specified by accountID).

Capability required: AccountRead
License command group: AdvancedTools

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

CombinedAccountStatus - The status of the account.

getActiveCreditCard

Return the active credit card ID for the account (specified by accountID). If no active credit card is associated with this account, -1 is returned.

Capability required: AccountRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

long - The payment method id.

getBlockedDomainListForAccount

Get the blocked domains for the account (specified by accountID).

Capability required: AccountRead
License command group: AdvancedTools

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

string[] - The list of blocked domains.

getChargeAmount

Return the charge amount for the account (specified by accountID). This amount is automatically added to the account balance when the account balance is depleted.

Capability required: AccountRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

int - The charge amount in the currency of the master account.

getContinentBlockListForAccount

Return the blocked continents for the account (specified by accountID).

Capability required: AccountRead
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.

Response

Continent[] - A list of block continents for the account.

setActiveCreditCard

Set the active credit card for the account (specified by accountID).

Capability required: AccountWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.
paymentMethodID	long	The unique identifier for this payment method (credit card) in the system.

Response

none

setBlockedDomainListForAccount

Set the blocked domains for the account (specified by accountID).

Capability required: AccountWrite
License command group: AdvancedTools

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.
blockedDomainList	string[]	The list of blocked domains (URL).

Response

none

setChargeAmount

Set the charge amount for the account (specified by accountID). This amount is automatically added to the account balance when the account balance is depleted.

Capability required: AccountWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.
chargeAmount	int	The amount to add when the account is depleted.

Response

none

setContinentBlockListForAccount

Set the continents to be included in the continent block list for the account (specified by accountID).

The continent block list represents the continents where you do not want your ads displayed and from which you do not want to receive click traffic. For example, an advertiser with an account in the North American market who does not sell or ship to the Asian market (and who, therefore, does not want to pay for the click traffic from Asia) would list Asia in the continent block list.

The continent block list may not include the continent containing the market of the account. For example, US accounts cannot block traffic from North America. If no continents are specified, your ads are displayed on all continents.

Capability required: AccountWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.
continents	Continent[]	A list of continents.

Response

none

updateAccount

Update an account.

Capability required: AccountWrite
License command group: Marketing

Parameters

Parameter	Data Type	Description
account	Account	The account to be updated.
updateAll	boolean	If true, the system performs a full update. All elements are updated. If you pass in the null value or omit an element, the current value is cleared. If False, the system performs a partial update. Only those elements you specify are updated. If you pass in the null value or omit an element, the current value is not changed.

Response

none

updateStatusForAccount

Update the status of the account (specified by accountID).

Capability required: AccountWrite
License command group: AdvancedTools

Parameters

Parameter	Data Type	Description
accountID	string	The account ID.
accountStatus	AccountStatus	The status of the account.

Response

none