The FeedV1SDK project is a Java-based application that interacts with eBay's Feed API. It uses Maven as a build and dependency management tool. The
project includes functionalities to download, unzip, and search through eBay's feed files.
Key functionalities include:
-
downloadLatestFile: This method downloads the latest file from the eBay feed. It takes parameters such as range value, queue size, feed type, category ID, marketplace ID, and the output filename for the zipped file. -
unzip: This method unzips the downloaded file. It takes the zipped output filename and the unzipped output filename as parameters. -
findItem: This method searches for a specific item in the unzipped feed file. It takes the item ID, unzipped output filename, and filtered output filename as parameters.
The project also includes a configuration file ebay-config-sample.yaml which contains OAuth access tokens and other necessary credentials for
interacting with eBay's API.
Additionally, there's a Contributing.md file that provides guidelines for contributing to the project, including bug reporting, submitting changes,
and code style.
There are individual methods as well:
- CallGetFeedTypes : To get the list of feed types
- CallGetFiles : To get the list of files for a given feed type
- CallGetFile : To the file metadata
- CallGetAccess : To get the access configuration
- CallDownloadFile : To download the feed file
For more details on Feed V1 API, please refer to the documentation.
The SDK can be added as a maven dependency or the entire repository can be cloned/forked and changes can be made.
You are most welcome to collaborate and enhance the existing code base.
<!-- https://mvnrepository.com/artifact/com.ebay.api/feed-sdk -->
<dependency>
<groupId>com.ebay.developer</groupId>
<artifactId>feedv1-api-sdk</artifactId>
<version>1.0.0-RELEASE</version>
</dependency>
For setting up the project in your local environment
- Clone the repository
- Run mvn clean install. This should generate an uber jar with the following naming convention
feed-sdk-{version}-uber.jar
You might need to add the below in VM options --add-exports=java.base/sun.nio.ch=ALL-UNNAMED --add-opens=java.base/java.lang=ALL-UNNAMED --add-opens=java.base/java.lang.reflect=ALL-UNNAMED --add-opens=java.base/java.io=ALL-UNNAMED --add-opens=java.base/java.util=ALL-UNNAMED --add-opens java.desktop/java.awt.font=ALL-UNNAMED --add-opens java.base/java.text=ALL-UNNAMED --add-exports=jdk.unsupported/sun.misc=ALL-UNNAMED
Since the feed API supports feed files which may be as big as 5 GB, there is a capability which was built into the system to download the file in chunks of 100 MB.
The SDK abstracts the complexity involved in calculating the request header 'range' based on the response header 'content-range'.
To download a feed file of a particular cateogry and marketplace, the following code can be used -
CredentialUtil.load(new FileInputStream(path));
feedV1SDK.filterByItem(rangeValue, queueSize, "CURATED_ITEM_FEED", categoryId, marketplaceId, "1234567890", zippedOutputFilename, unzippedOutputFilename, filteredOutputFilename);
The GetFeedResponse.filePath denotes the location where the file was downloaded.
The default download location is the current working directory. The download location can be changed by specifying the optional 'downloadDirectory' parameter in the feed method. For example, to download to the location /tmp/feed -
feed.get(builder.build(), "/tmp/feed");
Since the feed file is gzipped, it needs to be unzipped before post processing tasks can be run on it.
To unzip a downloaded feed file -
Feed feed = new FeedImpl();
String unzippedFilePath = feed.unzip(filePath)
Logging is configured using slf4j and rolling log files are created in the current directory.
The following sections describe the different ways in which the SDK can be used
All the examples are located here
- Ensure there is enough storage for unzipped files
- Ensure that the log and file storage directories have appropriate write permissions
- In case of failure in downloading due to network issues, the process needs to start again. There is no capability at the moment, to resume.
Copyright 2024 eBay Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
https://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.