|
|
Getting Started Guide: AccountService Overview
AccountService provides operations for creating and managing accounts.
About Accounts
An account is a collection of one or more campaigns, and is associated with a master account. A number of account properties cascade to the campaign, ad group, ad, and keyword levels unless they are explicitly set and overridden at a lower level.
The total number of objects you can create for an account - campaigns, ad groups, ads, keywords, continent blocks, domain blocks, and so on, is determined by your license. If you exceed the limit for any object, you will get an error message. If this happens you can do the following:
- First try and delete some of the older objects that are no longer used and then resubmit your request.
- If you still need assistance, contact your Technical Account Management team.
Account Management
AccountService provides operations for creating, updating, reviewing, and checking the status of accounts.
Create Accounts
To create a new account for a master account, use the addAccount or addMobileAccount operation. The ID of the master account is specified in the request header.
The new account will inherit the payment plan in effect for the company and the payment method of the oldest account under the master account. See Enrollment. If the charge amount for this account is less than the market minimum, it will be set to the market minimum.
Update Accounts
To update an account, use the updateAccount operation. When the boolean parameter updateAll is set to true, the system performs a full update i.e., all elements are updated.
Review Accounts
To get information about an account or a list of all accounts for the current master account, use the getAccount and getAccounts operations. To determine whether an account is a Mobile Sponsored Search account, use the isMobileAccount operation.
Account Status
To determine the combined status of an account, use the getAccountStatus operation. The combined status is the combination of account status set by you and the online status set by the system. Note that you can enable an account i.e., set the account status to Active. However, if the system sets the online status to False, for example, due to insufficient funds, the account is disabled until the appropriate action is taken.
To change the status of an account, use the updateStatusForAccount operation. If you disable an account i.e., set the account status to Inactive, all its campaigns and ad groups are also disabled and no ads or keywords are served.
Account Balances
Accounts that store credit card information online for the prepay nonstop, or prepay deposit payment plans have a cash balance associated with them. To determine what the cash balance is, use the getAccountBalance operation.
You can manage account balances two ways:
- By manually adding money to an account, using the active credit card, when the account balance is depleted.
- By specifying a charge amount that is automatically charged against the active credit card and added to the account when the account balance is depleted.
To add money to an account, use the addMoney operation.
To specify or review a charge amount, use the setChargeAmount and getChargeAmount operations.
To set or to review the active credit card, use the setActiveCreditCard and getActiveCreditCard operations.
Note: You can review or update the billing and credit card information for an account using the UserManagementService, and the getPaymentMethods and updateCreditCard operations. Please refer to the UserManagementService Overview.
Continent Block List
A continent block list represents the continents where you do not want your ads to be displayed, and from where you do not want to receive click traffic. The continent block list can include any continent except the continent containing the market of the account.
To create a continent block list, use the setContinentBlockListForAccount operation. To delete the continent block list, use the deleteContinentBlockListForAccount operation. To get the continent block list, use the getContinentBlockListForAccount operation.
Blocked Domain List
A blocked domain list represents the domains, or subsections of domains, where you do not want your ads displayed and from where you do not want to receive click traffic. The blocked domain list can include domains as follows:
- The KR market can block all domains.
- The US market can block all domains except the yahoo.com and overture.com domains.
- The AU and UK markets can block all domains except the yahoo.com domain.
- The DE market can block all domains except the yahoo.com, yahoo.de, and overture.com domains.
- The ES market can block all domains except the yahoo.com, yahoo.es, and overture.com domains.
- The FR market can block all domains except the yahoo.com, yahoo.fr, and overture.com domains.
- The IT market can block all domains except the yahoo.com, yahoo.co.jp, yahoo7.com, and y7.com.au domains.
- Domain blocking is not available in other markets.
To create a domain block list, use the setBlockedDomainListForAccount operation. To delete a domain block list, use the deleteBlockedDomainListForAccount operation. To get the domain block list, use the getBlockedDomainListForAccount operation.
Blocked Domain Rules
The following rules apply for specifying a blocked domain:
- The domain cannot be more than 500 characters long.
- The domain cannot include uppercase characters.
- The domain cannot contain the characters "\", "/", ".", "?", "&", ":", or ";"
- The domain cannot include any arguments or a port designation.
- The domain cannot include a protocol (for example, http://).
- You cannot block a top-level domain, for example, the domain extension .com. The highest level you can block is a root domain, for example, papayadayspa.com.
- The domain cannot include more than one sub-domain.
- The domain cannot include more than two directories.
- You cannot block more than 500 domains at the account level.
Blocked Domain Examples
These examples show you how to block a domain at the domain, sub-domain, and directory levels.
Blocking a Domain
This example blocks a domain. Use this format (without "www." or "wwwn." or any sub-domain or any directory) if you want to block the entire web site.
Example: If you block accountantsforthearts.com
Your ads would not appear on pages under domains such as:
- accountantsforthearts.com - domain
- www.accountantsforthearts.com - domain + sub-domain (www.)
- www1.accountantsforthearts.com - domain + sub-domain (www1.)
- taxes.accountantsforthearts.com - domain + sub-domain (taxes.)
- www.accountantsforthearts.com/news - domain + sub-domain (www.) + directory (/news)
Blocking a Sub-Domain
These examples block specific sub-domains. When blocking sub-domains remember that you cannot have more than one sub-domain in the domain. For example, you can have services.papayadayspa.com, which has one sub-domain, "services", but you cannot have massage.services.papayadayspa.com, which has two sub-domains.
Example 1: If you blocked www.papayadayspa.com
Your ads would not appear on pages under domains such as:
- www.papayadayspa.com
- www.papayadayspa.com/prices
Your ads could appear on pages under domains such as:
- papayadayspa.com
- reservations.papayadayspa.com
Example 2: If you blocked services.papayadayspa.com
Your ads would not appear on pages under domains such as:
- services.papayadayspa.com
- cservices.papayadayspa.com/massage
Your ads could appear on pages under domains such as:
- papayadayspa.com
- www.papayadayspa.com
Blocking a Directory
This example blocks a specific directory. When blocking directories remember that you cannot have more than two directories in the domain. For example, you can have www.accountantsforthearts.com/news/money, which has two directories, "news" and "money", but you cannot have www.accountantsforthearts.com/news/money/rates, which has three directories.
Example: If you blocked www.accountantsforthearts.com/news
Your ads would not appear on pages under domains such as:
- www.accountantsforthearts.com/news
- www.accountantsforthearts.com/news/money
Your ads could appear on pages under domains such as:
- www.accountantsforthearts.com/faqs
- www1.accountantsforthearts.com/tips
- taxes.accountantsforthearts.com/news