Examples of com.ebay.sdk.call.GetCategorySpecificsCall

com.ebay.sdk.call.GetCategorySpecificsCall
Wrapper class of the GetCategorySpecifics call of eBay SOAP API.

Title: SOAP API wrapper library.

Description: Contains wrapper classes for eBay SOAP APIs.

Copyright: Copyright (c) 2009

Company: eBay Inc.

Input property: CategoryID - An eBay category ID. This call retrieves recommended Item Specifics (if any) for each category you specify. To determine which categories support listing with custom Item Specifics, use GetCategoryFeatures.

Note: This call may return recommendations for categories that don't support listing with custom Item Specifics. That is, the presence of recommendations for a category does not necessarily mean that AddItem supports custom Item Specifics for that category and site.

The request requires either CategoryID, CategorySpecfics.CategoryID, or CategorySpecificsFileInfo (or the call returns an error). CategoryID and CategorySpecific.CategoryID can both be used in the same request. (CategorySpecific offers more options to control the response.) Some input fields, such as IncludeConfidence, only work when CategoryID or CategorySpecfics.CategoryID is specified.

You can specify multiple categories, but more categories can result in longer response times. If your request times out, specify fewer IDs. If you specify the same ID twice, we use the first instance.
Input property: LastUpdateTime - Causes the recommendation engine to check whether the list of popular Item Specifics for each specified category has changed since this date and time. If specified, this call returns no Item Specifics; it only returns whether the data has changed for any of the requested categories.

Typically, you pass in the Timestamp that was returned the last time you refreshed the list of names and values for the same categories. If the Updated flag returns true for any categories in the response, call GetCategorySpecifics again for those categories to get the latest names and values. (As downloading all the data may affect your application's performance, it may help to only download Item Specifics for a category if they have changed since you last checked.)
Input property: MaxNames - Maximum number of Item Specifics to return per category (where each Item Specific is identified by a unique name within the category). Use this to retrieve fewer results per category. For example, if you only want up to 2 per category (the top 2 most popular names), specify 2.
Input property: MaxValuesPerName - Maximum number of values to retrieve per item specific. The best practice for using this field depends on your use case. For example, if you want all possible values (such as all brands and sizes in a clothing category), then specify a very large number. (This is recommended in most cases.) If you only want the most popular value (like the most popular color), then specify a small number.
Input property: Name - The name of one Item Specific name to find values for. Use this if you want to find out whether a name that the seller provided has recommended values. If you specify multiple categories in the request, the recommendation engine returns all matching names and values it finds for each of those categories. At the time of this writing, this value is case-sensitive. (Wildcards are not supported.)

Name and CategorySpecific.ItemSpecific can be used in the request. (If you plan to only use one or the other in your application, you should use ItemSpecific, as it may offer more options in the future.)
Input property: CategorySpecific - Applicable with request version 609 and higher. (This does not retrieve data at all if your request version is lower than 609.) Contains a category for which you want recommended Item Specifics, and (optionally) names and values to help you refine the recommendations. You can specify multiple categories (but more categories can result in longer response times). If you specify the same category twice, we use the first instance.

Depending on how many recommendations are found, your request may time out if you specify too many categories. (Typically, you can download recommendations for about 275 categories at a time.)

CategoryID and CategorySpecific.CategoryID can be used in the request. (If you plan to only use one or the other in your application, you should use CategorySpecific, as it may offer more options in the future.)
Input property: ExcludeRelationships - If true, the Relationship node is not returned for any recommendations. Relationship recommendations tell you whether an Item Specific value has a logical dependency another Item Specific.

For example, in a clothing category, Size Type could be recommended as a parent of Size, because Size=Small would mean something different to buyers depending on whether Size Type=Petite or Size Type=Plus.

In general, it is a good idea to retrieve and use relationship recommendations, as this data can help buyers find the items they want more easily.
Input property: IncludeConfidence - If true, returns eBay's level of confidence in the popularity of each name and value for the specified category. Some sellers may find this useful when choosing whether to use eBay's recommendation or their own name or value.

Requires CategoryID to also be passed in.

If you try to use this with CategorySpecificsFileInfo but without CategoryID, the request fails and no TaskReferenceID or FileReferenceID is returned.
Input property: CategorySpecificsFileInfo - If true, the response includes FileReferenceID and TaskReferenceID. Use these IDs as inputs to the downloadFile call in the eBay File Transfer API. That API lets you retrieve a single (bulk) GetCategorySpecifics response with all the Item Specifics recommendations available for the requested site ID. (The downloadFile call downloads a .zip file as an attachment.)

Either CategorySpecificsFileInfo or a CategoryID is required (or you can specify both).

Note: You can use the File Transfer API without using or learning about the Bulk Data Exchange API or other Large Merchant Services APIs.

Output property: ReturnedRecommendations - Contains the most popular Item Specifics, if any, for a category specified in the request, or contains information about whether the recommendations have changed for that category since the LastUpdateTime you requested.

The most relevant Item Specifics (as determined by eBay) are returned first. In many cases, the values are returned in alphabetical order.

This node returns empty (or it's not returned) for a category if there is no applicable data (such as when you request a parent category, a category that has no popular Item Specifics yet, or a duplicate category that was already returned). If you pass in the CategoryID and Name fields together, but no matching values are found for the name, eBay returns the name with no values (even if the name is not recommended).

If GetCategoryFeatures indicates that custom Item Specifics are enabled for a category, but GetCategorySpecifics doesn't return any recommendations for that category, the seller can still specify their own custom Item Specifics in that category.
Output property: ReturnedTaskReferenceID - Use TaskReferenceID and FileReferenceID as inputs to the downloadFile call in the eBay File Transfer API. That API lets you retrieve a single (bulk) GetCategorySpecifics response with all the Item Specifics recommendations available for the requested site ID. (The downloadFile call downloads a .zip file as an attachment.)

Only returned when CategorySpecificsFileInfo is passed in the request.
Output property: ReturnedFileReferenceID - Use TaskReferenceID and FileReferenceID as inputs to the downloadFile call in the eBay File Transfer API. That API lets you retrieve a single (bulk) GetCategorySpecifics response with all the Item Specifics recommendations available for the requested site ID. (The downloadFile call downloads a .zip file as an attachment.)

Only returned when CategorySpecificsFileInfo is passed in the request. @author Ron Murphy @version 1.0

        AttributeSet[] joinedAttrSets = attrMaster.joinItemSpecificAndSiteWideAttributeSets(itemSpecAttrSets, siteWideAttrSets);
        this.joinedAttrSets = joinedAttrSets;
    }


    private void syncNameRecommendationTypes() throws ApiException, SdkException, Exception {
        GetCategorySpecificsCall getCatSpe = new GetCategorySpecificsCall(apiContext);
        getCatSpe.setCategoryID(new String[]{this.catId});
        DetailLevelCodeType[] detailLevels = new DetailLevelCodeType[] {DetailLevelCodeType.RETURN_ALL};
        getCatSpe.setDetailLevel(detailLevels);
        RecommendationsType[] recommendationsArray = getCatSpe.getCategorySpecifics();
        if (recommendationsArray == null || recommendationsArray.length == 0)
            return;
        RecommendationsType recommendations = recommendationsArray[0];
        this.nameRecommendationTypes = recommendations.getNameRecommendation();
    }

View Full Code Here

        Locale locale = UtilHttp.getLocale(request);
        String productStoreId = (String) requestParams.get("productStoreId");
        
        try {
            ApiContext apiContext = EbayStoreHelper.getApiContext(productStoreId, locale, delegator);
            GetCategorySpecificsCall categorySpecifics = new GetCategorySpecificsCall(apiContext);
            String[] categoryIds = {categoryId};
            categorySpecifics.setCategoryID(categoryIds);
            DetailLevelCodeType[] detailLevel = new DetailLevelCodeType[] {
                    DetailLevelCodeType.RETURN_ALL,
                    DetailLevelCodeType.ITEM_RETURN_ATTRIBUTES,
                    DetailLevelCodeType.ITEM_RETURN_DESCRIPTION
            };
            categorySpecifics.setDetailLevel(detailLevel);
            RecommendationsType[] recommend =  categorySpecifics.getCategorySpecifics();
            
            for (int i = 0; i < recommend.length; i++) {
                NameRecommendationType[] nameRecommend = recommend[i].getNameRecommendation();
                Map<String, List<String>> nameRecommendationMap = FastMap.newInstance();
                for (int j = 0; j < nameRecommend.length; j++) {

View Full Code Here

        AttributeSet[] joinedAttrSets = attrMaster.joinItemSpecificAndSiteWideAttributeSets(itemSpecAttrSets, siteWideAttrSets);
        this.joinedAttrSets = joinedAttrSets;
    }


    private void syncNameRecommendationTypes() throws ApiException, SdkException, Exception {
        GetCategorySpecificsCall getCatSpe = new GetCategorySpecificsCall(apiContext);
        getCatSpe.setCategoryID(new String[]{this.catId});
        DetailLevelCodeType[] detailLevels = new DetailLevelCodeType[] {DetailLevelCodeType.RETURN_ALL};
        getCatSpe.setDetailLevel(detailLevels);
        RecommendationsType[] recommendationsArray = getCatSpe.getCategorySpecifics();
        if (recommendationsArray == null || recommendationsArray.length == 0)
            return;
        RecommendationsType recommendations = recommendationsArray[0];
        this.nameRecommendationTypes = recommendations.getNameRecommendation();
    }

View Full Code Here

        Locale locale = UtilHttp.getLocale(request);
        String productStoreId = (String) requestParams.get("productStoreId");
        
        try {
            ApiContext apiContext = EbayStoreHelper.getApiContext(productStoreId, locale, delegator);
            GetCategorySpecificsCall categorySpecifics = new GetCategorySpecificsCall(apiContext);
            String[] categoryIds = {categoryId};
            categorySpecifics.setCategoryID(categoryIds);
            DetailLevelCodeType[] detailLevel = new DetailLevelCodeType[] {
                    DetailLevelCodeType.RETURN_ALL,
                    DetailLevelCodeType.ITEM_RETURN_ATTRIBUTES,
                    DetailLevelCodeType.ITEM_RETURN_DESCRIPTION
            };
            categorySpecifics.setDetailLevel(detailLevel);
            RecommendationsType[] recommend =  categorySpecifics.getCategorySpecifics();
            
            for (int i = 0; i < recommend.length; i++) {
                NameRecommendationType[] nameRecommend = recommend[i].getNameRecommendation();
                Map<String, List<String>> nameRecommendationMap = FastMap.newInstance();
                for (int j = 0; j < nameRecommend.length; j++) {

View Full Code Here

        AttributeSet[] joinedAttrSets = attrMaster.joinItemSpecificAndSiteWideAttributeSets(itemSpecAttrSets, siteWideAttrSets);
        this.joinedAttrSets = joinedAttrSets;
    }


    private void syncNameRecommendationTypes() throws ApiException, SdkException, Exception {
        GetCategorySpecificsCall getCatSpe = new GetCategorySpecificsCall(apiContext);
        getCatSpe.setCategoryID(new String[]{this.catId});
        DetailLevelCodeType[] detailLevels = new DetailLevelCodeType[] {DetailLevelCodeType.RETURN_ALL};
        getCatSpe.setDetailLevel(detailLevels);
        RecommendationsType[] recommendationsArray = getCatSpe.getCategorySpecifics();
        if (recommendationsArray == null || recommendationsArray.length == 0)
            return;
        RecommendationsType recommendations = recommendationsArray[0];
        this.nameRecommendationTypes = recommendations.getNameRecommendation();
    }

View Full Code Here

        AttributeSet[] joinedAttrSets = attrMaster.joinItemSpecificAndSiteWideAttributeSets(itemSpecAttrSets, siteWideAttrSets);
        this.joinedAttrSets = joinedAttrSets;
    }


    private void syncNameRecommendationTypes() throws ApiException, SdkException, Exception {
        GetCategorySpecificsCall getCatSpe = new GetCategorySpecificsCall(apiContext);
        getCatSpe.setCategoryID(new String[]{this.catId});
        DetailLevelCodeType[] detailLevels = new DetailLevelCodeType[] {DetailLevelCodeType.RETURN_ALL};
        getCatSpe.setDetailLevel(detailLevels);
        RecommendationsType[] recommendationsArray = getCatSpe.getCategorySpecifics();
        if (recommendationsArray == null || recommendationsArray.length == 0)
            return;
        RecommendationsType recommendations = recommendationsArray[0];
        this.nameRecommendationTypes = recommendations.getNameRecommendation();
    }

View Full Code Here

TOP

Related Classes of com.ebay.sdk.call.GetCategorySpecificsCall

org.ofbiz.ebaystore.EbayEvents

org.ofbiz.ebaystore.EbayStoreCategoryFacade

All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.