Sandbox
Bing Ads API provides a sandbox environment where you can test your application before deploying it to the production environment.
-
Sandbox contains the current production release.
-
Sandbox is free to use.
-
Ads that you create in sandbox are not served.
-
Campaign data in sandbox is deleted the first Saturday of every month. Customer shells that you create are not deleted. If you require specific test data in sandbox, consider writing tools that generates the test data and schedule it to run after the first Saturday of every month.
-
Sandbox may be down for maintenance—with or without prior notification. Efforts will be made to notify users before sandbox downtime. Notifications are posted in the Bing Ads Developer Blog.
The following are the sandbox’s limitations.
-
Because sandbox’s capacity is less than that of production, you should not use it to perform stress or capacity testing.
-
Do not use more than one thread.
-
Sandbox supports only the Campaign Management and Customer Management web services. To get the sandbox web service address for these services, see Bing Ads Web Service Addresses.
-
You will not be able to test editorial rejection reason APIs (for example, GetEditorialReasonsByIds).
Getting access
The sandbox and production environments use separate credentials. To get access to sandbox if you are a direct advertiser, tool provider, or agency, go to the sandbox’s Bing Ads web application and click Sign up to get a sandbox account. You will use the same username and password to call the API.
When you sign up for an account, append _sbx to the username that you choose (for example, contosoapi_sbx). In addition, do not specify a payment instrument.
Direct advertisers, tool providers, and agencies will use the following multi-user developer token.
-
BBD37VB98
If you are a direct advertiser, do not call the add, delete, or update Customer Management operations. These calls will succeed in sandbox because your SuperAdmin credentials are paired with a multi-user token; however, the same calls will fail in production when you use your single-user token.
Make sure that when you deploy your application to the production environment, you use the production WSDLs and your production credentials (user name, password, and developer token).
Note
|
|---|
|
To get access to sandbox if you are a reseller, contact your designated account management team. |
Editorial support
Sandbox supports editorial reviews and appeals. If you know of editorial terms that will fail editorial review, you can use them. Otherwise, to test your application’s editorial logic, use the following format to construct a magic term that determines, by country, whether editorial will approve or reject the ad or keyword, or put it in a pending state. These magic terms are supported in sandbox only.
{MatchType}{Language}{FlagArea}{m}{StatusPerCountry}{m1}
You must specify a value for each component of the term.
|
Component |
Description |
|---|---|
|
MatchType |
Determines whether the magic term is the only word in the keyword. The following are the possible match-type values that you can specify. The character is case-insensitive.
|
|
Language |
Determines the editorial guidelines to apply. You should specify the same language that the ad group specifies. The following are the possible language values that you can specify. The string is case insensitive.
|
|
FlagArea |
Determines the area of the editorial guidelines to apply to the term. The following are the possible guideline areas that you can specify.
To specify more than one flag area for a keyword, specify multiple phrase magic terms. For example, pen3m569m1 pen15m569m1. |
|
m |
Literal. Must be m. |
|
StatusPerCountry |
Determines the editorial status to return for each language. The integer is broken down into 2-bit fields. Each 2-bit field represents the editorial status to apply for the country. The following shows each country’s position in the integer for each Language value. The Language value determines the countries that you can include in the integer. For example, for English, United States (US) is in the most significant position and Ireland (IE) is in the least significant position.
You can set each country’s 2-bit value to one of the following values.
For example, to specify that you want the term rejected for US and pending inactive for CA, you would set the integer’s bit fields to 000000100001 (or decimal 33). |
|
m1 |
Literal. Must be m1. |
Where to use the magic term
You can use magic terms in the following locations.
-
A text ad’s Title element.
-
A text ad’s Description element.
-
A keyword’s Text element.
Example magic term
If you specified a term using the following components, the resulting term would be pen3m569m1.
-
Match type: Phrase
-
Language: English
-
Flag area: Alcohol
-
Editorial status per country: 569 (001000111001), which is broken out as follows.
-
Rejected in US
-
Pending inactive in GB
-
Pending active in CA
-
Approved in IN
-
Pending inactive in SG
-
Approved in IE
-
