NAME

eBay::API::XML::Call::GetPopularKeywords::GetPopularKeywordsRequestType

DESCRIPTION

Retrieves the words more frequently used by eBay users when searching for listings. These keywords are generated weekly by eBay. Thus, calls retrieve static data. GetPopularKeywords is not available for the following sites: FR, HK, MY, PH, PL, SG, SE.

SYNOPSIS

INHERITANCE

eBay::API::XML::Call::GetPopularKeywords::GetPopularKeywordsRequestType inherits from the eBay::API::XML::RequestDataType class

Subroutines:

setCategoryID()

A category ID for which you want keywords returned. When IncludeChildCategories is true, one and only one CategoryID is allowed. Otherwise, up to 100 CategoryIds are allowed. To retrieve the keywords for root category, set one of the CategoryIDs to -1 or submit no CategoryIDs at all.

MaxLength: 10

  RequiredInput: No
#    Argument: reference to an array  
                      of 'xs:string'

getCategoryID()

# Returns: reference to an array of 'xs:string'

setIncludeChildCategories()

If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories. If false, keywords are returned only for the categories identified by CategoryID. Default is false.

  RequiredInput: No
#    Argument: 'xs:boolean'

isIncludeChildCategories()

# Returns: 'xs:boolean'

setMaxKeywordsRetrieved()

The maximum number of keywords to be retrieved per category for this call.

Max: 1000 Default: 20 Min: 1

  RequiredInput: No
#    Argument: 'xs:int'

getMaxKeywordsRetrieved()

# Returns: 'xs:int'

setPagination()

Details about how many categories to return per page and which page to view.

  RequiredInput: No
#    Argument: 'ns:PaginationType'

getPagination()

# Returns: 'ns:PaginationType'