|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.ebay.sdk.ApiCall
com.ebay.sdk.call.GetCategorySpecificsCall
public class 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.
CategoryID
- A unique identifer for an eBay leaf-level category. Recommended Item Specifics names and values will be retrieved for each eBay category that is specified. Up to 100 CategoryID values may be specified in one call.
true
. CategoryID values and
CategorySpecific.CategoryID values can both be used in the same request.
LastUpdateTime
- This dateTime filter can be included and used if the user only wants to check for recently-added Item Specifics names and values for one or more categories. If this filter is used, the Item Specifics recommendation engine will only check for Item Specifics names and values that have been added/changed since the date that was passed in to this field. If this field is used, the call will not return any Item Specifics data; it will only return the Recommendations.Updated boolean field for each specified eBay category. A true
value in this field will indicate that the recommended Item Specifics names/values for the eBay category have changed since the timestamp passed in the LastUpdateTime field, and a false
value in this field will indicate that the recommended Item Specifics names/values for the eBay category have not changed since the timestamp passed in the LastUpdateTime field.
true
for any eBay categories in the response, you will want to call GetCategorySpecifics again for those eBay 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 data for an eBay category if the data has changed since you last checked.
MaxNames
- This field can be used if you want to control the number of Item Specifics that are returned for each specified eBay category. If you only wanted to retrieve the 10 most popular Item Specifics per category, you would include this field and set its value to 10
. Note that mandatory Item Specifics are always returned first in the response. If this field is omitted, its value defaults to 30.
MaxValuesPerName
- This field can be used if you want to control the number of values that are returned for each returned Item Specific in each specified eBay category. If you only wanted to retrieve the 10 most popular values/options for each returned Item Specific in each category, you would include this field and set its value to 10
. If this field is omitted, its value defaults to 25. Many Item Specifics will have more values than 25, so the user may want to experiment with this, including this field and setting its value quite a bit higher than 25.
Name
- This field can be used if you already have an Item Specific name in mind, and you only want the recommended values for this Item Specifics name.
If you specify multiple eBay categories in the request, the recommendation engine may find a matching Item Specifics name for some categories, but not for others. For eBay categories where the Item Specifics name is not found, recommended Item Specifics names and values will be returned. The Item Specifics name passed in this field is case-sensitive, and wildcards are not supported.
CategorySpecific
- This container can be used instead of, or in conjunction with CategoryID values specified at the call request root level. The CategorySpecific container can actually be more powerful since you can pass in multiple Category ID and Item Specifics name combinations, and if you specify CategoryID values at the root level, only one (Item Specifics) Name value can be used.
true
. CategoryID values and
CategorySpecific.CategoryID values can both be used in the same request.
ExcludeRelationships
- If this boolean field is included and set to true
, the Relationship container will not be returned for any Item Specifics name or value recommendations. Relationship recommendations tell you whether an Item Specific has a logical dependency another Item Specific.
IncludeConfidence
- If this boolean field is included and set to true
, eBay's level of confidence in the popularity of each Item Specific name and value for the specified category is returned in the response. Some sellers may find this useful when choosing whether to use eBay's recommendation or their own Item Specifics names or values.
CategorySpecificsFileInfo
- If this boolean field is included and set to true
, the response includes a FileReferenceID and
TaskReferenceID value. Use these identifiers 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.)ReturnedRecommendations
- This container provide details about relevant Item Specifics for the specified category. Required Item Specifics are generally returned at the top of the response payload, followed by the other most common/popular Item Specifics for the category. If an Item Specific is required, a MinValues field will be returned with a value of 1
, and the corresponding UsageConstraint field will show a value of Required
. Optional Item Specifics are returned after required and recommended Item Specifics, but sellers should still provide any optional Item Specific name-value pairs if known and relevant for the product.
ReturnedTaskReferenceID
- A TaskReferenceID and a FileReferenceID value are returned if the CategorySpecificsFileInfo field is included in the call request and set to true
. These values will be used as inputs in the downloadFile call of the 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.)
ReturnedFileReferenceID
- A TaskReferenceID and a FileReferenceID value are returned if the CategorySpecificsFileInfo field is included in the call request and set to true
. These values will be used as inputs in the downloadFile call of the 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.)
Field Summary |
---|
Fields inherited from class com.ebay.sdk.ApiCall |
---|
apiException, sendReqListeners |
Constructor Summary | |
---|---|
GetCategorySpecificsCall()
Constructor. |
|
GetCategorySpecificsCall(ApiContext apiContext)
Constructor. |
Method Summary | |
---|---|
java.lang.String[] |
getCategoryID()
Gets the GetCategorySpecificsRequestType.categoryID. |
CategoryItemSpecificsType[] |
getCategorySpecific()
Gets the GetCategorySpecificsRequestType.categorySpecific. |
RecommendationsType[] |
getCategorySpecifics()
This is the base request type for the GetCategorySpecifics call. |
java.lang.Boolean |
getCategorySpecificsFileInfo()
Gets the GetCategorySpecificsRequestType.categorySpecificsFileInfo. |
java.lang.Boolean |
getExcludeRelationships()
Gets the GetCategorySpecificsRequestType.excludeRelationships. |
java.lang.Boolean |
getIncludeConfidence()
Gets the GetCategorySpecificsRequestType.includeConfidence. |
java.util.Calendar |
getLastUpdateTime()
Gets the GetCategorySpecificsRequestType.lastUpdateTime. |
java.lang.Integer |
getMaxNames()
Gets the GetCategorySpecificsRequestType.maxNames. |
java.lang.Integer |
getMaxValuesPerName()
Gets the GetCategorySpecificsRequestType.maxValuesPerName. |
java.lang.String |
getName()
Gets the GetCategorySpecificsRequestType.name. |
java.lang.String |
getReturnedFileReferenceID()
Valid after executing the API. |
RecommendationsType[] |
getReturnedRecommendations()
Valid after executing the API. |
java.lang.String |
getReturnedTaskReferenceID()
Valid after executing the API. |
void |
setCategoryID(java.lang.String[] categoryID)
Sets the GetCategorySpecificsRequestType.categoryID. |
void |
setCategorySpecific(CategoryItemSpecificsType[] categorySpecific)
Sets the GetCategorySpecificsRequestType.categorySpecific. |
void |
setCategorySpecificsFileInfo(java.lang.Boolean categorySpecificsFileInfo)
Sets the GetCategorySpecificsRequestType.categorySpecificsFileInfo. |
void |
setExcludeRelationships(java.lang.Boolean excludeRelationships)
Sets the GetCategorySpecificsRequestType.excludeRelationships. |
void |
setIncludeConfidence(java.lang.Boolean includeConfidence)
Sets the GetCategorySpecificsRequestType.includeConfidence. |
void |
setLastUpdateTime(java.util.Calendar lastUpdateTime)
Sets the GetCategorySpecificsRequestType.lastUpdateTime. |
void |
setMaxNames(java.lang.Integer maxNames)
Sets the GetCategorySpecificsRequestType.maxNames. |
void |
setMaxValuesPerName(java.lang.Integer maxValuesPerName)
Sets the GetCategorySpecificsRequestType.maxValuesPerName. |
void |
setName(java.lang.String name)
Sets the GetCategorySpecificsRequestType.name. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public GetCategorySpecificsCall()
public GetCategorySpecificsCall(ApiContext apiContext)
apiContext
- The ApiContext object to be used to make the call.Method Detail |
---|
public RecommendationsType[] getCategorySpecifics() throws ApiException, SdkException, java.lang.Exception
ApiException
SdkException
java.lang.Exception
public java.lang.String[] getCategoryID()
public void setCategoryID(java.lang.String[] categoryID)
categoryID
- String[]public CategoryItemSpecificsType[] getCategorySpecific()
public void setCategorySpecific(CategoryItemSpecificsType[] categorySpecific)
categorySpecific
- CategoryItemSpecificsType[]public java.lang.Boolean getCategorySpecificsFileInfo()
public void setCategorySpecificsFileInfo(java.lang.Boolean categorySpecificsFileInfo)
categorySpecificsFileInfo
- Booleanpublic java.lang.Boolean getExcludeRelationships()
public void setExcludeRelationships(java.lang.Boolean excludeRelationships)
excludeRelationships
- Booleanpublic java.lang.Boolean getIncludeConfidence()
public void setIncludeConfidence(java.lang.Boolean includeConfidence)
includeConfidence
- Booleanpublic java.util.Calendar getLastUpdateTime()
public void setLastUpdateTime(java.util.Calendar lastUpdateTime)
lastUpdateTime
- Calendarpublic java.lang.Integer getMaxNames()
public void setMaxNames(java.lang.Integer maxNames)
maxNames
- Integerpublic java.lang.Integer getMaxValuesPerName()
public void setMaxValuesPerName(java.lang.Integer maxValuesPerName)
maxValuesPerName
- Integerpublic java.lang.String getName()
public void setName(java.lang.String name)
name
- Stringpublic java.lang.String getReturnedFileReferenceID()
public RecommendationsType[] getReturnedRecommendations()
public java.lang.String getReturnedTaskReferenceID()
|
Changes since the last release |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
The information contained in this document is proprietary and confidential.
Use of this information and the eBay API requires a Non-Disclosure Agreement (NDA) between the user and eBay Inc.
For information regarding a qualifying NDA, contact Developer Relations:
developer-relations@ebay.com
© 2004-2009 eBay Inc. All rights reserved.