Export (0) Print
Expand All

Sandbox

Bing Ads provides an API sandbox environment where you can test your application before deploying it to the production environment. Ads that you create in sandbox are not served.

Supported services in sandbox vary from production. To get the web service addresses for supported services, see Bing Ads Web Service Addresses.

System_CLiX_note Note

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.

Getting Access

The sandbox and production environments use separate credentials. To get access to sandbox, 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.

All Bing Ads customers may use the following multi-user developer token in sandbox.

  • BBD37VB98

System_CLiX_note Note

Authentication with a Microsoft Account is not supported in sandbox. You can test your sandbox application with the UserName and Password legacy header elements, and then with the AuthenticationToken element verify authentication of a Microsoft account via OAuth in production. For more information, see Managing User Authentication with OAuth.

Sandbox Best Practices

Sandbox should not be used in the same capacity as production.

  • 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.

  • Sandbox contains the current production release, and will be updated with feature previews with or without prior notification.

  • Capacity of the sandbox is less than that of production, and you should not use it to perform stress or capacity testing.

  • Please do not use more than one thread.

  • Campaign and reporting data in sandbox are deleted the first Saturday of every month. 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.

    System_CLiX_note Note

    While every effort will be made to synchronize data cleanup, deletion of campaign and reporting data may occur during different hours or days.

Ad Intelligence Service

Supported Keywords

Sandbox supports a limited set of keywords for testing Ad Intelligence service operations. You should not use the test data to infer or expect similar estimates for your keywords in production. You may use the following set of keywords to test your application.

Supported Keywords for Ad Intelligence Sandbox

air

auto

best deals

booking

car information

care

deal of the day

discounts

entertainment

finances

games

hotel reviews

insurance comparison

sport

the hotel

Service Operations

Ad Intelligence service operations differ from production, and limitations are described in the following table.

Service Operation

Sandbox Limitations

GetBidLandscapeByKeywordIds

Not supported. You can call the operation with existing keyword identifiers, but no data is returned.

GetEstimatedBidByKeywordIds

A limited set of keywords are supported. For more information, see Supported Keywords.

GetEstimatedBidByKeywords

A limited set of keywords are supported. For more information, see Supported Keywords.

GetEstimatedPositionByKeywordIds

A limited set of keywords are supported. For more information, see Supported Keywords.

To increase chance of getting an estimate, the MaxBid element should be more than or equal to 5 US Dollar, or the equivalent in other currencies.

GetEstimatedPositionByKeywords

A limited set of keywords are supported. For more information, see Supported Keywords.

To increase chance of getting an estimate, the MaxBid element should be more than or equal to 5 US Dollar, or the equivalent in other currencies.

GetHistoricalKeywordPerformance

A limited set of keywords are supported. For more information, see Supported Keywords.

The MatchType and AdPosition elements must be set to Aggregate.

The Devices element must be set to Computers or left nil.

GetHistoricalSearchCount

A limited set of keywords are supported. For more information, see Supported Keywords.

The EndMonthAndYear element must be set to the previous month. For example if today's date is June 10, 2013, the end month should be May 2013.

The Devices element must be set to Computers or left nil.

GetKeywordCategories

There should be no difference in sandbox versus production.

GetKeywordDemographics

A limited set of keywords are supported. For more information, see Supported Keywords.

The Devices element must be set to Computers or left nil.

GetKeywordLocations

A limited set of keywords are supported. For more information, see Supported Keywords.

The Devices element must be set to Computers or left nil.

SuggestKeywordsForUrl

There should be no difference in sandbox versus production.

SuggestKeywordsFromExistingKeywords

If the SuggestionType is set to 1, there should be no difference in behavior compared to production.

For suggestion type values 2, 3, and 4, the results are limited to the set of keywords provided in sandbox. For more information, see Supported Keywords.

Bulk Service

The file size limit for upload in production is 100MB or 2.5 million rows. For sandbox the limit is 20K rows. For more information, see Downloading and Uploading Campaigns.

Campaign Management Service

Editorial Support

Sandbox supports limited editorial reviews and appeals.

System_CLiX_note Note

Sandbox does not support testing of editorial rejections reason operations, for example GetEditorialReasonsByIds Service Operation.

Magic Terms

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.

  • e – Exact. The keyword must contain only the magic term.

  • p – Phrase. The keyword can contain other words in addition to the magic term.

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.

  • EN - English

  • FR - French

  • DE - German

FlagArea

Determines the area of the editorial guidelines to apply to the term. The following are the possible guideline areas that you can specify.

  • 3 - Alcohol

  • 15 - Gambling

  • 97 – Adult Erotica

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.

  • EN - IESGINCAGBUS

  • FR - FRCA

  • DE - DECHAT

You can set each country’s 2-bit value to one of the following values.

  • 00 - Approved

  • 01 - Rejected

  • 10 - Pending inactive

  • 11 - Pending active

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.

  1. A text ad’s Title element.

  2. A text ad’s Description element.

  3. 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

Product Ads

Product ads are supported in sandbox in the United States. To be auto-approved you must create a catalog and a Bing Merchant Center store that ends with "sandbox" as follows.

  1. In the Bing Ads web application click on Tools.

  2. Under Management Tools, click on Bing Merchant Center.

  3. Click Create store, and enter a store name that ends with "sandbox" (case-insensitive).

  4. Add your store info, select Product Ads under Catalog settings, and click Finish.

  5. In your new store, click Catalog management, and then click Create catalog.

  6. Add your catalog name, select Manually upload file later under Catalog feed file, and click Save.

Customer Billing Service

The Customer Billing service is not supported in sandbox.

Customer Management Service

Most customer management service operations are supported in sandbox. Unsupported features include AddClientLinks and UpdateClientLinks.

Optimizer Service

Opportunities are updated daily in sandbox for existing campaigns, ad groups, and keywords to test the end to end coding workflow. You may get test opportunities for up to 1,000 keywords across all accounts per Bing Ads customer. You should not use the test data to infer or expect similar performance for your campaigns, ad groups, or keywords in production.

System_CLiX_note Note

Sandbox opportunity data is refreshed and updated each weekend, and is available by Monday.

Reporting Service

When you create a keyword, test performance data should be generated within a few hours. The data is provided to test generating, retrieving, and parsing reports in the sandbox. For a given keyword identifier, the test data is not updated over time. The data will show example performance for one month prior to the creation of your keyword by design. You should not use the test data to infer or expect similar performance for your keywords in production. Reporting data in sandbox is deleted the first Saturday of every month.

The following reports can return performance data in sandbox.

System_CLiX_note Note

All other report types can be submitted successfully, and the sandbox service will return an empty report.

Community Additions

ADD
Show:
© 2014 Microsoft