Trading_RecommendationValidationRulesType Class Reference
Inherits from | NSObject |
Conforms to | PicoBindable |
Declared in | Trading_RecommendationValidationRulesType.h Trading_RecommendationValidationRulesType.m |
Overview
Defines rules for recommended Item Specifics. The rules apply when
the Item Specific is subsequently used in AddItem and related calls.
@ingroup EBayAPIInterface
Tasks
-
valueType
The data type (e.g., decimal) that eBay expects the value to
property
adhere to in listing requests.
Only returned if the data type is not Text.
In some cases, more details about the data type are returned
in the ValueFormat field.
As buyers may search on the value you specify in AddItem,
the ISBN, UPC, or EAN should match the value that was specified by
the publisher or manufacturer. -
minValues
Minimum number of values that you can specify for this Item Specific
property
in listing requests. Not returned if zero (0).
If 1 or more, it means this Item Specfic is required
in listing requests (in the specified category). (Your listing
request will return errors if the Item Specific is not present.)
If Relationship is also present, it means this Item Specific is
required when you specify its parent value in listing requests. -
maxValues
Maximum number of values that you can specify for this Item Specific
property
in listing requests (like AddItem) in the specified
category.
Most Item Specifics can only have one value. When this is
greater than 1, your application can present the value
recommendations (if any) as a multi-select list to the seller.
(See SelectionMode to determine whether the seller needs to
choose from eBay’s recommendations or not.) -
selectionMode
Controls whether you can specify your own name and value
property
in listing requests, or if you need to use a name and/or value
that eBay has defined. -
confidence
Indicates eBay’s confidence that this is the right name or value,
property
given the data you specified your request. The confidence is based
on historical items in the same category, with similar titles
(if specified).
For example, in GetItemRecommendations, if your request includes a
title with words like “Blue T-Shirt”, then Color=Blue is likely to
have a higher confidence score than Color=Red in the response.
If the title does not include a recognized color value,
then Color may still have a high confidence score
(based on historical item data in the category), but the scores for
Blue and Red may have a more even distribution.
Only returned when IncludeConfidence is true in the request.
Not returned when SelectionMode is Prefilled. -
relationship
Indicates the Item Specific’s logical dependency on another
property
Item Specific, if any.
For example, in a clothing category, Size Type could be
recommended as a parent of Size, because Size=XL would
mean something different to buyers when
Size Type=Juniors or Size Type=Regular.
Or in the US (in the future), a list of cities can vary depending
on the state, so State could be recommended as a parent of City.
Currently, categories only recommend a maximum of one parent
for an Item Specific.
For example, Size=XL could have a Size Type=Juniors
parent in a Juniors clothing category.
In the future, some categories may recommend multiple parents.
For example, City=Mountain View could have parents like
State=California, State=New York, and State=North Carolina.
If an Item Specific has value dependencies (i.e., if it has value recommendations that contain Relationship), then
all of its value recommendations are returned (regardless of the
number you specified in MaxValuesPerName). -
variationPicture
Indicates whether the name (e.g., Color) can (or must) be used to
property
classify the variation pictures. -
variationSpecifics
Indicates whether the recommended name/value pair can be used in
property
Item.Variations in AddFixedPriceItem and related calls.
For example, a given category could disable a name like Brand
in variation specifics (if Brand is only allowed in the item specifics at the Item level). The same category could
enable a name like Size for variation specifics
(in addition to recommending it for item specifics).
If not returned, then the name/value can be used for
both variation specifics and item specifics. -
valueFormat
The format of the data type (e.g., date format) that eBay
property
expects the item specific’s value to adhere to in listing requests.
A data type identified by the ValueType field may have different
representations, and ValueFormat specifies the precise format
that is required. -
any
(public property)
property
Properties
any
(public property)
@property (nonatomic, retain) NSMutableArray *any
Discussion
(public property)
entry type : PicoAnyElement, wrapper for primitive anyelement
Declared In
Trading_RecommendationValidationRulesType.h
confidence
Indicates eBay’s confidence that this is the right name or value,
given the data you specified your request. The confidence is based
on historical items in the same category, with similar titles
(if specified).
For example, in GetItemRecommendations, if your request includes a
title with words like “Blue T-Shirt”, then Color=Blue is likely to
have a higher confidence score than Color=Red in the response.
If the title does not include a recognized color value,
then Color may still have a high confidence score
(based on historical item data in the category), but the scores for
Blue and Red may have a more even distribution.
Only returned when IncludeConfidence is true in the request.
Not returned when SelectionMode is Prefilled.
@property (nonatomic, retain) NSNumber *confidence
Discussion
Indicates eBay’s confidence that this is the right name or value,
given the data you specified your request. The confidence is based
on historical items in the same category, with similar titles
(if specified).
For example, in GetItemRecommendations, if your request includes a
title with words like “Blue T-Shirt”, then Color=Blue is likely to
have a higher confidence score than Color=Red in the response.
If the title does not include a recognized color value,
then Color may still have a high confidence score
(based on historical item data in the category), but the scores for
Blue and Red may have a more even distribution.
Only returned when IncludeConfidence is true in the request.
Not returned when SelectionMode is Prefilled.
type : NSNumber, wrapper for primitive int
Declared In
Trading_RecommendationValidationRulesType.h
maxValues
Maximum number of values that you can specify for this Item Specific
in listing requests (like AddItem) in the specified
category.
Most Item Specifics can only have one value. When this is
greater than 1, your application can present the value
recommendations (if any) as a multi-select list to the seller.
(See SelectionMode to determine whether the seller needs to
choose from eBay’s recommendations or not.)
@property (nonatomic, retain) NSNumber *maxValues
Discussion
Maximum number of values that you can specify for this Item Specific
in listing requests (like AddItem) in the specified
category.
Most Item Specifics can only have one value. When this is
greater than 1, your application can present the value
recommendations (if any) as a multi-select list to the seller.
(See SelectionMode to determine whether the seller needs to
choose from eBay’s recommendations or not.)
type : NSNumber, wrapper for primitive int
Declared In
Trading_RecommendationValidationRulesType.h
minValues
Minimum number of values that you can specify for this Item Specific
in listing requests. Not returned if zero (0).
If 1 or more, it means this Item Specfic is required
in listing requests (in the specified category). (Your listing
request will return errors if the Item Specific is not present.)
If Relationship is also present, it means this Item Specific is
required when you specify its parent value in listing requests.
@property (nonatomic, retain) NSNumber *minValues
Discussion
Minimum number of values that you can specify for this Item Specific
in listing requests. Not returned if zero (0).
If 1 or more, it means this Item Specfic is required
in listing requests (in the specified category). (Your listing
request will return errors if the Item Specific is not present.)
If Relationship is also present, it means this Item Specific is
required when you specify its parent value in listing requests.
type : NSNumber, wrapper for primitive int
Declared In
Trading_RecommendationValidationRulesType.h
relationship
Indicates the Item Specific’s logical dependency on another
Item Specific, if any.
For example, in a clothing category, Size Type could be
recommended as a parent of Size, because Size=XL would
mean something different to buyers when
Size Type=Juniors or Size Type=Regular.
Or in the US (in the future), a list of cities can vary depending
on the state, so State could be recommended as a parent of City.
Currently, categories only recommend a maximum of one parent
for an Item Specific.
For example, Size=XL could have a Size Type=Juniors
parent in a Juniors clothing category.
In the future, some categories may recommend multiple parents.
For example, City=Mountain View could have parents like
State=California, State=New York, and State=North Carolina.
If an Item Specific has value dependencies (i.e., if it has value recommendations that contain Relationship), then
all of its value recommendations are returned (regardless of the
number you specified in MaxValuesPerName).
@property (nonatomic, retain) NSMutableArray *relationship
Discussion
Indicates the Item Specific’s logical dependency on another
Item Specific, if any.
For example, in a clothing category, Size Type could be
recommended as a parent of Size, because Size=XL would
mean something different to buyers when
Size Type=Juniors or Size Type=Regular.
Or in the US (in the future), a list of cities can vary depending
on the state, so State could be recommended as a parent of City.
Currently, categories only recommend a maximum of one parent
for an Item Specific.
For example, Size=XL could have a Size Type=Juniors
parent in a Juniors clothing category.
In the future, some categories may recommend multiple parents.
For example, City=Mountain View could have parents like
State=California, State=New York, and State=North Carolina.
If an Item Specific has value dependencies (i.e., if it has value recommendations that contain Relationship), then
all of its value recommendations are returned (regardless of the
number you specified in MaxValuesPerName).
entry type : class Trading_NameValueRelationshipType
Declared In
Trading_RecommendationValidationRulesType.h
selectionMode
Controls whether you can specify your own name and value
in listing requests, or if you need to use a name and/or value
that eBay has defined.
@property (nonatomic, retain) NSString *selectionMode
Discussion
Controls whether you can specify your own name and value
in listing requests, or if you need to use a name and/or value
that eBay has defined.
type: string constant in Trading_SelectionModeCodeType.h
Declared In
Trading_RecommendationValidationRulesType.h
valueFormat
The format of the data type (e.g., date format) that eBay
expects the item specific’s value to adhere to in listing requests.
A data type identified by the ValueType field may have different
representations, and ValueFormat specifies the precise format
that is required.
@property (nonatomic, retain) NSString *valueFormat
Discussion
The format of the data type (e.g., date format) that eBay
expects the item specific’s value to adhere to in listing requests.
A data type identified by the ValueType field may have different
representations, and ValueFormat specifies the precise format
that is required.
type: string constant in Trading_ValueFormatCodeType.h
Declared In
Trading_RecommendationValidationRulesType.h
valueType
The data type (e.g., decimal) that eBay expects the value to
adhere to in listing requests.
Only returned if the data type is not Text.
In some cases, more details about the data type are returned
in the ValueFormat field.
As buyers may search on the value you specify in AddItem,
the ISBN, UPC, or EAN should match the value that was specified by
the publisher or manufacturer.
@property (nonatomic, retain) NSString *valueType
Discussion
The data type (e.g., decimal) that eBay expects the value to
adhere to in listing requests.
Only returned if the data type is not Text.
In some cases, more details about the data type are returned
in the ValueFormat field.
As buyers may search on the value you specify in AddItem,
the ISBN, UPC, or EAN should match the value that was specified by
the publisher or manufacturer.
type: string constant in Trading_ValueTypeCodeType.h
Declared In
Trading_RecommendationValidationRulesType.h
variationPicture
Indicates whether the name (e.g., Color) can (or must) be used to
classify the variation pictures.
@property (nonatomic, retain) NSString *variationPicture
Discussion
Indicates whether the name (e.g., Color) can (or must) be used to
classify the variation pictures.
type: string constant in Trading_VariationPictureRuleCodeType.h
Declared In
Trading_RecommendationValidationRulesType.h
variationSpecifics
Indicates whether the recommended name/value pair can be used in
Item.Variations in AddFixedPriceItem and related calls.
For example, a given category could disable a name like Brand
in variation specifics (if Brand is only allowed in the item specifics at the Item level). The same category could
enable a name like Size for variation specifics
(in addition to recommending it for item specifics).
If not returned, then the name/value can be used for
both variation specifics and item specifics.
@property (nonatomic, retain) NSString *variationSpecifics
Discussion
Indicates whether the recommended name/value pair can be used in
Item.Variations in AddFixedPriceItem and related calls.
For example, a given category could disable a name like Brand
in variation specifics (if Brand is only allowed in the item specifics at the Item level). The same category could
enable a name like Size for variation specifics
(in addition to recommending it for item specifics).
If not returned, then the name/value can be used for
both variation specifics and item specifics.
type: string constant in Trading_VariationSpecificsRuleCodeType.h
Declared In
Trading_RecommendationValidationRulesType.h