Yahoo! Search Marketing

Enterprise Web Services: Sandbox

The EWS sandbox is a test environment that allows you to experiment with the Yahoo! search marketplace by creating and running Enterprise Web Services (EWS) client applications.
The sandbox also serves as a test environment for customers who want to migrate their existing applications from DTC-XML to EWS.

Introduction

The EWS sandbox provides a modified version of the production system, and currently focuses on the Marketing API. While all services and operations are designed to function the same in the sandbox as in the production system, the actual result sets you observe in the sandbox may vary.

Access

To obtain a license key for the sandbox, contact your account manager. You will be issued a test master account (MasterAccountID), a test account (AccountID), and a new username and password for accessing these test accounts.

We reserve the right to delete, reset, or otherwise alter your test accounts, username, or password at any time. We will try to provide advance notice if such changes are necessary.

Quota

Quota for the sandbox is set at 500 operations per day per license. All quota is assigned to the Marketing command group (the only command group available in the sandbox).

Availability

We strive to keep the sandbox up and running at all times. However, because the sandbox is a test environment, short, periodic outages may occur. The sandbox is not available during the daily maintenance window scheduled form 9:00 to 11:00 p.m. PST/PDT.

Sandbox URL

The URL prefix for the sandbox is: https://sandbox.marketing.ews.yahooapis.com. Use the URL prefix to form complete, local URLs (see EWS Locations).

Confidential Information

The sandbox is a test environment and is not intended for use with production data or confidential financial information. Please do not use an actual credit card number or other confidential information when testing the Marketing API services in the sandbox as Yahoo! Search Marketing will not be held liable for information you input into the sandbox.

If you need assistance obtaining a test credit card number that can be used in the sandbox, please contact your Yahoo! Search Marketing Account Team or send an email to ews-help@yahoo-inc.com.

Supported Services

The sandbox supports all of the Marketing API services, except the UpgradeService. Differences between the sandbox and the production system are noted in this table and in the sections below.

Service Sandbox Status
AccountService Available.
AdGroupService Available.
AdService Available. Editorial review is simulated.
BasicReportService Available. Results are simulated and will not correspond to the campaign data in your test account. Report elements may not correspond to actual report elements (see Report Details).
BidInformationService Available. Results are simulated and may not be current.
BudgetingService Available.
CampaignService Available.
CompanyService Available.
ExcludedWordsService Available.
ForecastService Available. Results are based on a static snapshot of the data and will not change on a daily basis.
KeywordResearchService Available. Results are based on a static snapshot of the data and will not change on a daily basis.
KeywordService Available. Editorial review is simulated.
LocationService Available. Returns the URL prefix for the sandbox.
MasterAccountService Available. Customer accounts created in the sandbox with the addNewCustomer operation are not accessible via the sandbox Marketing API. Also, users will not receive an email to set their initial password as they do in the production environment.
UpgradeService Not available.
UserManagementService Available. Users created with the addUser operation will not receive an email to set their initial password as they do in the production environment. However, the new user can be granted roles with the addAuthorizationForUser and addAuthorizationsForUser operations.

Test Accounts

All campaigns, ad groups, ads, and keywords are created under your test accounts. These test accounts are completely separate from your production accounts. There is no possibility that the ads you create in the sandbox will be accidentally served, nor will your production accounts be charged for any bids that are placed.

Result Sets and Data

Many of the results you will see in the sandbox are simulated or based on static snapshots of the data. Because the ads you create in the sandbox are not served and the bids you make are not processed, budgets, quality indices (quality scores), performance metrics, forecasted data, report data, and so on are not updated. Also, we make no attempt to protect the data in the sandbox. If you add, update, or delete the information under your test accounts, we cannot guarantee that these changes will be preserved.

Note: Do not use the results from the sandbox to perform any type of campaign management for your production accounts.

System Emails

For those services that include operations that issue emails, the emails will not be sent in the sandbox environment.

Editorial Reviews

In the sandbox, the editorial review process for ads and keywords is simulated based on a set of pre-selected terms (see Sandbox Editorial Reviews).

Client Applications

To help you get started building EWS client applications and/or to ease the process of migrating your existing applications to EWS, we provide sample client applications in four languages: Java, .NET, Perl, and PHP (see Sample Code).

Use the sandbox to build and run these client sample applications. Then, continue using the sandbox to build and test your own client applications before moving them to our production system.