|
|
Enterprise Web Services: Getting Started Guide
The Getting Started Guide provides an overview of Enterprise Web Services (EWS), and the Search Marketing APIs. The Search Marketing APIs are an EWS product. Please read the topics presented here and then, use the navigation bar on the left to continue reading other sections of the guide.
How it Works
EWS and the Search Marketing APIs enable you, as a developer, to build client software that interacts directly with the Yahoo! Search marketplace through a web services interface. It also helps you take advantage of the features and functionality of Sponsored Search. See Concepts.
Access, Licensing, and Authentication
Before you can access EWS, you need to sign up with Yahoo! Search Marketing and obtain an EWS license. Your EWS license includes a license key and defines your command groups and quotas. With the help of your Technical Account Management team you will need to set up a username and password, and create your initial accounts.
Your license key, username, and password are a basic form of authentication that EWS uses to identify you. If you are managing an account on behalf of other advertisers, you will need to include additional account information. See Access and Licensing.
Client Software
To access EWS, you need to write webservices client software in the programming language of your choice. With the client software you can make internet connections to our web service endpoints over a secure HTTP connection.
Your client software sends requests to and handles responses from EWS using the operations available from the Search Marketing APIs. See the Search Marketing API Reference. Each request you make to EWS is subject to authentication as well as the capabilities and quotas defined by your license. See EWS Requests and EWS Responses.
Messaging Technology
EWS webservices use SOAP, an XML-based protocol, as it's underlying messaging technology. See SOAP Basics for more details about the messaging framework. Although you can generate XML requests and parse the XML responses directly in your client application, typically your client software uses a toolkit that supports SOAP and thus manages the details of the connection and response for you.See Sample Code for examples.
Service Descriptions and Details
The Search Marketing APIs includes several services. The following tables organizes the services into logical groups, which makes it easier to understand; provides short descriptions, and includes links to more detailed information.
Accounts
Use these services to create and manage companies, accounts, and users.
| Service | Description | Details | ||
|---|---|---|---|---|
| CompanyService | Retrieve information about a company. | Overview | Operations | WSDL |
| MasterAccountService | Create and manage master accounts. | Overview | Operations | WSDL |
| AccountService | Create and manage the accounts under master accounts. | Overview | Operations | WSDL |
| UserManagementService | Manage users, authorizations, and payment methods. | Overview | Operations | WSDL |
| VaultService | Manage sensitive user and account information. | Overview | Operations | WSDL: Sandbox Production |
| LocationService | Retrieve the URL prefix of the colocation for the master account. | Overview | Operations | WSDL: Sandbox Production |
| UpgradeService | Preview the upgrade of accounts to the new Sponsored Search. | Overview | Operations | WSDL: Sandbox Production |
Campaigns
Use these services to create and manage campaigns, ad groups, ads, and keywords.
| Service | Description | Details | ||
|---|---|---|---|---|
| CampaignService | Create and manage campaigns. | Overview | Operations | WSDL |
| AdGroupService | Create and manage ad groups. | Overview | Operations | WSDL |
| AdService | Create and manage ads. | Overview | Operations | WSDL |
| KeywordService | Create and manage keywords. | Overview | Operations | WSDL |
| ExcludedWordsService | Filter out unwanted user queries. | Overview | Operations | WSDL |
| BulkService | Perform bulk operations on account objects. | Overview | Operations | WSDL |
Research and Forecasting
Use these services to make effective decisions about ads and keywords.
| Service | Description | Details | ||
|---|---|---|---|---|
| BidInformationService | Use marketplace information to determine the best ad position. | Overview | Operations | WSDL |
| ForecastService | Estimate future ad and keyword performance. | Overview | Operations | WSDL |
| KeywordResearchService | Mine existing data to generate keyword recommendations. | Overview | Operations | WSDL |
Budgets and Reporting
Use these services to set budgets and run reports.
| Service | Description | Details | ||
|---|---|---|---|---|
| BudgetingService | Manage account and campaign budgets. | Overview | Operations | WSDL |
| BasicReportService | Create, view, and delete reports. | Overview | Operations | WSDL |
Targeting
Use these services to define and manage your targeting preferences.
| Service | Description | Details | ||
|---|---|---|---|---|
| GeographicalDictionaryService | Retrieve geographical locations to target. | Overview | Operations | WSDL |
| TargetingConverterService | Convert a generic targeting object to a strongly typed targeting object and vice versa. | Overview | Operations | WSDL |
| TargetingDictionaryService | Retrieve the available and supported targeting types and their values. | Overview | Operations | WSDL |
| TargetingService | Manage ad group and campaign targets. | Overview | Operations | WSDL |
Mobile
Use this service to fetch information related to Mobile Sponsored Search advertising.
| Service | Description | Details | ||
|---|---|---|---|---|
| MobileDictionaryService | Retrieve supported markets and list of carriers for Mobile Sponsored Search advertising. | Overview | Operations | WSDL |
Agencies, Resellers, and SEMs
If you are a third-party agency, reseller, or search engine marketer, you may enroll or perform work on behalf of other users. Information that is specific to you is located in these sections:
- VaultService: Add New Customers
- Access and Licensing: On-Behalf-Of Authorizations
- EWS Requests: On-Behalf-Of Requests
Getting Help
If you need help with any aspect of EWS and the Marketing API, please contact your Technical Account Management team at ews-help@yahoo-inc.com, or send us a message through the online Support Form.