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

NAME

eBay::API::XML::DataType::BuyingGuideType

DESCRIPTION

Information that identifies a buying guide. A buying guide provides content about particular product areas, categories, or subjects to help buyers decide which type of item to purchase based on their particular interests. Buying guides are useful to buyers who do not have a specific product in mind. For example, a digital camera buying guide could help a buyer determine what kind of digital camera is right for them.

SYNOPSIS

INHERITANCE

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

Subroutines:

setCategoryID()

Identifies the category (if any) that is associated with the buying guide. For GetSearchResults, this can be a category that is higher or lower in the hierarchy than the category specified in the request. For a matching categories search, you can use this information to determine the order that the buying guides are returned in when multiple guides are found. Optionally, you can use this information to determine where to present the buying guide link in your application. Not returned for product finder searches.

MaxLength: 10

# Argument: 'xs:string'

getCategoryID()

Calls: GetCategoryListings
Returned: Conditionally

Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
         GranularityLevel: Coarse


Calls: GetProducts
Returned: Conditionally

# Returns: 'xs:string'

setCreationTime()

The time and date when the guide was posted.

# Argument: 'xs:dateTime'

getCreationTime()

Calls: GetProducts
Returned: Conditionally

# Returns: 'xs:dateTime'

setName()

Display name of the buying guide. <br> <br> GetProducts only returns 20 characters, followed by "..." if the name is longer than 20 characters. For the full title, see BuyingGuide.Title instead.

# Argument: 'xs:string'

getName()

Calls: GetCategoryListings
Returned: Conditionally

Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
         GranularityLevel: Coarse


Calls: GetProducts
Returned: Conditionally
MaxLength: 23

# Returns: 'xs:string'

setProductFinderID()

Identifies the product finder (if any) that is associated with the buying guide. Only returned for product finder searches.

# Argument: 'xs:int'

getProductFinderID()

Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll

# Returns: 'xs:int'

setText()

The text of the guide. If the guide is longer than 2000 characters, the text is cut off and it ends with "...". See BuyingGuide.URL for a link to the full text of the review.

# Argument: 'xs:string'

getText()

Calls: GetProducts
Returned: Conditionally

# Returns: 'xs:string'

setTitle()

The title of the buying guide.

# Argument: 'xs:string'

getTitle()

Calls: GetProducts
Returned: Conditionally
MaxLength: 55

# Returns: 'xs:string'

setURL()

URL for the buying guide. Your application can present this as a link. Use the value of Name as the link's display name.

# Argument: 'xs:anyURI'

getURL()

Calls: GetCategoryListings
Returned: Conditionally

Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: ItemReturnAttributes, ItemReturnCategories, none, ReturnAll
         GranularityLevel: Coarse


Calls: GetProducts
Returned: Conditionally

# Returns: 'xs:anyURI'

setUserID()

The author's eBay user ID.

# Argument: 'ns:UserIDType'

getUserID()

Calls: GetProducts
Returned: Conditionally

# Returns: 'ns:UserIDType'