/ 
eBay-API-0.25
River stage zero No dependents
/ eBay::API::XML::DataType::LabelType

NAME

eBay::API::XML::DataType::LabelType

DESCRIPTION

Applicable when working with Pre-filled Item Information (Catalogs) functionality. The label to display when presenting the attribute to a user. Not necessarily the same as the attribute's label as defined in the characteristic set (i.e., the label could be overridden by the catalog).

SYNOPSIS

INHERITANCE

eBay::API::XML::DataType::LabelType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

setName()

The label to display when presenting the attribute to a user (e.g., "Title" or "Manufacturer"). <br> <br> The label is defined for the product, and is therefore not necessarily the same as the label that is defined in the characteristic set returned by another call like GetAttributesCS.<br> <br> <b>For GetProductSearchPage</b>: If the attribute's label is "Keyword", it means you can enter the attribute's ID and a string value in the SearchAttributes node of GetProductSearchResults, and then eBay will search for the string against one or more attributes in the catalog. For example, for strollers, GetProductSearchPage only returns a Keyword attribute instead of separate Brand, Product Type, and Model attributes (for the US site). So, you can use the single Keyword attribute to search against all of those attributes.<br> <br>

# Argument: 'xs:string'

getName()

Calls: GetProductFamilyMembers
       GetProductSearchPage
       GetProductSearchResults
Returned: Always
Details: DetailLevel: ReturnAll

Calls: GetProducts
Returned: Conditionally

# Returns: 'xs:string'

setVisible()

If true, the label name is visible on the eBay site. If false, the label is not visible. Usage of this information is optional. You are not required to display labels in the same manner as eBay.

# Argument: 'xs:boolean'

isVisible()

Calls: GetProductFamilyMembers
       GetProductSearchPage
       GetProductSearchResults
Returned: Always
Details: DetailLevel: ReturnAll

# Returns: 'xs:boolean'