Trading_GetCategorySpecificsRequestType Class Reference
Inherits from | Trading_AbstractRequestType : NSObject |
Declared in | Trading_GetCategorySpecificsRequestType.h Trading_GetCategorySpecificsRequestType.m |
Overview
Returns the most popular custom Item Specific names and values for each
leaf category you request.
@ingroup EBayAPIInterface
Tasks
-
categoryID
A leaf-level eBay category ID. This call retrieves recommended
property
Item Specifics (if any) for each leaf category you specify.
(The call returns no results for a parent category.)
To determine which leaf 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 leaf 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. -
lastUpdateTime
Causes the recommendation engine to check whether the list of
property
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.) -
maxNames
Maximum number of Item Specifics to return
property
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. -
maxValuesPerName
Maximum number of values to retrieve per item specific.
property
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. -
name
The name of one Item Specific name to find values for.
property
Use this if you want to find out whether a name
that the seller provided has recommended values.
If you specify multiple leaf 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.) -
categorySpecific
Applicable with request version 609 and higher. (This
property
does not retrieve data at all if your request version is lower
than 609.)
Contains a leaf 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.) -
excludeRelationships
If true, the Relationship node is not returned for any
property
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. -
includeConfidence
If true, returns eBay’s level of confidence in the popularity of
property
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 withoutCategoryID, the request fails and no
TaskReferenceID or FileReferenceID is returned. -
categorySpecificsFileInfo
If true, the response includes FileReferenceID and
property
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.
Properties
categoryID
A leaf-level eBay category ID. This call retrieves recommended
Item Specifics (if any) for each leaf category you specify.
(The call returns no results for a parent category.)
To determine which leaf 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 leaf 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.
@property (nonatomic, retain) NSMutableArray *categoryID
Discussion
A leaf-level eBay category ID. This call retrieves recommended
Item Specifics (if any) for each leaf category you specify.
(The call returns no results for a parent category.)
To determine which leaf 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 leaf 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.
entry type : NSString, wrapper for primitive string
Declared In
Trading_GetCategorySpecificsRequestType.h
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 leaf 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.)
@property (nonatomic, retain) NSMutableArray *categorySpecific
Discussion
Applicable with request version 609 and higher. (This
does not retrieve data at all if your request version is lower
than 609.)
Contains a leaf 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.)
entry type : class Trading_CategoryItemSpecificsType
Declared In
Trading_GetCategorySpecificsRequestType.h
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.
@property (nonatomic, retain) NSNumber *categorySpecificsFileInfo
Discussion
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetCategorySpecificsRequestType.h
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.
@property (nonatomic, retain) NSNumber *excludeRelationships
Discussion
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.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetCategorySpecificsRequestType.h
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 withoutCategoryID, the request fails and no
TaskReferenceID or FileReferenceID is returned.
@property (nonatomic, retain) NSNumber *includeConfidence
Discussion
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 withoutCategoryID, the request fails and no
TaskReferenceID or FileReferenceID is returned.
type : NSNumber, wrapper for primitive bool
Declared In
Trading_GetCategorySpecificsRequestType.h
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.)
@property (nonatomic, retain) NSDate *lastUpdateTime
Discussion
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.)
type : NSDate, wrapper for primitive date
Declared In
Trading_GetCategorySpecificsRequestType.h
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.
@property (nonatomic, retain) NSNumber *maxNames
Discussion
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetCategorySpecificsRequestType.h
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.
@property (nonatomic, retain) NSNumber *maxValuesPerName
Discussion
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.
type : NSNumber, wrapper for primitive int
Declared In
Trading_GetCategorySpecificsRequestType.h
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 leaf 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.)
@property (nonatomic, retain) NSString *name
Discussion
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 leaf 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.)
type : NSString, wrapper for primitive string
Declared In
Trading_GetCategorySpecificsRequestType.h