Class FindPopularSearchesRequestType

Extends AbstractRequestType

class FindPopularSearchesRequestType
Retrieves the words most frequently used by eBay users when searching for listings. These keywords are generated weekly by eBay. Thus, calls retrieve static data. FindPopularSearches is not available for the following sites: FR, HK, MY, PH, PL, SG, SE. Summary: Finds the words more frequently used by eBay users when searching for listings. If you use keywords, this call returns available alternative keywords in addition to popular related keywords. RelatedCalls: FindPopularItems

Defined in com/ebay/shoppingservice/FindPopularSearchesRequestType.js

Property Summary
Array categoryID
Specify CategoryID to restrict your query to a specific category.
If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories.
Number maxKeywords
The maximum number of keywords to be retrieved per category for this call.
Specifies the maximum number of PopularSearchResults per page in the returned list.
Number pageNumber
Specifies the number of the page of data to return in the current call.
A query that specifies a string for searching titles of items on eBay.

Properties inherited from AbstractRequestType
messageID

Constructor Summary

Property Details

property Array categoryID

Specify CategoryID to restrict your query to a specific category. Up to 10 categories may be specified If you are using a URL, and you want to specify multiple values, use a comma. For example, if you want to specify Fiction Books and Children's Books, specify CategoryID=377,279.

If the specified category ID doesn't match an existing category for the site, an invalid-category error message is returned. To determine valid categories:
Use the FindItemsAdvanced CategoryHistogram value in the IncludeSelector field to retrieve matching categories. Then make another FindItemsAdvanced call with the ID of a matching category.

CategoryID can be used in combination with QueryKeywords and IncludeChildCategories. When IncludeChildCategories is true and used in conjunction with CategoryID, one and only one CategoryID is allowed. Otherwise, up to 10 CategoryIDs are allowed. To retrieve the most popular keywords for a root category, set one of the CategoryIDs to -1 or do not include CategoryID in the Request.


property Boolean includeChildCategories

If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories. When IncludeChildCategories is true and used in conjunction with CategoryID, one and only one CategoryID is allowed.

If false, keywords are returned only for the categories identified by CategoryID. The default is false.


property Number maxKeywords

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


property Number maxResultsPerPage

Specifies the maximum number of PopularSearchResults per page in the returned list. If not specified, the default returns 20 results per page.


property Number pageNumber

Specifies the number of the page of data to return in the current call. Specify a positive value equal to or lower than the number of pages available (which you determine by examining the results of your initial request).


property Array queryKeywords

A query that specifies a string for searching titles of items on eBay. If you are using a URL, then to search for multiple words, use "%20". For example, use Harry%20Potter to search for items containing those words in any order. You can incorporate wildcards into a multi-word search, as in the following: ap*%20ip*. The words "and" and "or" are treated like any other word. Only use "and", "or", or "the" if you are searching for listings containing these words.

QueryKeywords can be used in combination with CategoryID and IncludeChildCategories.


Constructor Details

constructor FindPopularSearchesRequestType

FindPopularSearchesRequestType(Object props)

Parameters:
props