|
|
Sample Code: Java Client Application
To access Enterprise Web Services (EWS) using the sample Java client application, follow these instructions.
Environment
To set up your Java environment, install the following packages according to the directions on their respective web sites:
We recommend that you use Java 1.5. We also recommend that you use Axis 1.4 to ensure that the sample client application compiles correctly.
Note: Contact your system administrator if you need help setting up your Java environment.
Source Code
For Java, the sample code includes API specific code and use cases. While API specific sample code helps you understand the usage of individual API, the use cases demonstrate a workflow or typical system usage.
Please refer to the Build and Run section
below to know how to use these sample codes
Prerequisites
The Java sample source code below makes use of the following EWS utility files. These files abstract out the configuration and service management used in the sample source code.
- Helper Classes : EWSConfigurator.java, EWSUtil.java, ServiceLocator.java
- Property file : ewsconfig.properties
Note : These files must be included in the classpath when executing the sample source code.
API Specific Sample Code
The following sample codes are available for EWS APIs :
- AddAdGroup.java - Java client sample for addAdGroup AdGroupService API
- AddAds.java - Java client sample for addAds AdService API
- AddCampaign.java - Java client sample for addCampaign CampaignService API
- AddExcludedWordsToAdGroup.java - Java client sample for addExcludedWordsToAdGroup ExcludedWordsService API
- AddKeywords.java - Java client sample for addKeywords KeywordService API
- DownloadAccount.java - Java client sample for downloadAccount BulkService API
- GetBidsForBestRankForCarriers.java - Java client sample for getBidsForBestRankForCarriers BidInformationService API
- GetBidsForBestRankForNetwork.java - Java client sample for getBidsForBestRankForNetwork BidInformationService API
- DeleteTargetingByTargetingAttributeDescriptorsForCampaign.java - Java client sample for deleteTargetingByTargetingAttributeDescriptorsForCampaign TargetingService API
- UpdatePremiumByTargetingAttributesForCampaign.java - Java client sample for updatePremiumByTargetingAttributesForCampaign TargetingService API
- GetForecastByAdGroup.java - Java client sample for getForecastByAdGroup with network ForecastService API
- GetForecastByAdGroup_Mobile.java - Java client sample for getForecastByAdGroup with mobile ForecastService API
- GetForecastForKeyword.java - Java client sample for GetForecastForKeyword ForecastService API
- GetHistoricalDataForKeywords.java - Java client sample for GetHistoricalDataForKeywords ForecastService API
Use Cases / Workflows
The following use cases are available:
- MinBidCode.java - Java client application demonstrating the use of APIs for Variable Minimum Bids.
- AddTargetsToCampaign.java - Java client application demonstrating the use of targeting APIs using the generic TargetingAttribute design.
- AddTargetsToCampaignUsingTargetingProfile.java - Java client application demonstrating the use of targeting APIs using the easy to code TargetingProfile design.
- AddGeographicTargetsToCampaign.java - Java client application demonstrating searching and adding geographic targets to a campaign.
- UpdatePremiumUsingTargetingProfile.java - Java client application demonstrating updating premium using TargetingProfile design.
- UpdatePremiumUsingTargetingAttributes.java - Java client application demonstrating updating premium using generic TargetingAttribute design.
- AddNetworkDistributionToCampaign.java - Java client application demonstrating how to add Network Distribution to a campaign
Download All Source Files
You can download all the above sources and utility source files: .jar, .zip, .tar.gz, .tar.bz2.
You can download all the EWS Java Axis Stub classes and sources as well: .jar (classes only), .zip, .tar.gz, .tar.bz2.
Build and Run
To build and run the Java client application, follow the
steps given below:
Quick Start
You can get started quickly by downloading the EWS sample code
sources, required libraries, and Ant build file.
- Ensure you have Apache Ant 1.6.5
or higher in your PATH.
- Download the EWS API SDK archive: .zip, .tar.gz, .tar.bz2.
- Extract the SDK to your local directory.
- Modify the ewsconfig.properties file in the properties folder in
the extracted directory. Make sure that you fill in the credentials and
market information correctly.
- Compile the sample code using Ant:
prompt> ant -f build.xml
- After compiling, you can run a specific sample
code using the following command:
prompt> ant -f build.xml -Dclass=<CLASS TO RUN> [-Dargs=<ARGUMENTS TO PASS TO CLASS>]
For example:
prompt> ant -f build.xml -Dclass=com.yahoo.sm.ws.client.AddAds -Dargs="123456"
Manual Do-It-Yourself
You can get the sample code up and running by manually getting the
dependencies in place and compiling the sample code against them. Follow the steps listed below:
| Sr. No. | Description | |
|---|---|---|
| Step 1a. |
You need the Axis Java client stub classes to comiple
and run the sample code. You can download the pre-compiled stubs with sources: .jar (classes only), .zip, .tar.gz, .tar.bz2. Alternately, you can generate the stubs on your own by following the steps below. Download the WSDLs for these Marketing API services to your local directory:
You may want to download all the WSDLs if you plan to expand the sample client application to use more services or to execute the use cases. |
|
| Step 1b. |
Skip this step if you have downloaded the stubs listed above. Create the Axis client stub classes for all the WSDLs using Axis' wsdl2java with these arguments:
|
|
| Step 2. |
Download the sample data properties files and save them to your local directory. You can download |
|
| Step 3. | Download
|
|
| Step 4. |
Make sure that the following are in your classpath:
|
|
| Step 5. |
Modify the ewsconfig.properties file and add your acount details to the file :
|
|
| Step 6. |
Compile Java sample source code (includeing helpers) and the generated stubs. |
|
| Step 7. |
Run the sample code : For example :
|
|
Known Issues
There are no known issues at this time.