eBay Shopping Web Service

Method: FindPopularSearches

Description

Finds the keywords that users are searching on for listings.

Input

The input of this method is the document element ns:FindPopularSearchesRequest of type having the structure defined by the following table.

Element  Type  Description 
ns:MessageID  xs:string  If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response.
any     
ns:CategoryID  xs:string  Specify CategoryID to restrict your query to a specific category.
ns:QueryKeywords  xs:string  A query that specifies a string for searching titles of items on eBay.
ns:MaxKeywords  xs:int  The maximum number of keywords to be retrieved per category for this call.
ns:MaxResultsPerPage  xs:int  Specifies the maximum number of PopularSearchResults per page in the returned list.
ns:PageNumber  xs:int  Specifies the number of the page of data to return in the current call.
ns:IncludeChildCategories  xs:boolean  If true, only one CategoryID can be specified, and keywords are returned for that category and its subcategories.

Output

The output of this method is the document element ns:FindPopularSearchesResponse of type having the structure defined by the following table.

Element  Type  Description 
ns:Timestamp  xs:dateTime  This value represents the date and time when eBay processed the request.
ns:Ack  ns:AckCodeType  Indicates whether the call was successfully processed by eBay.
ns:Errors  ns:ErrorType  A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build  xs:string  This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version  xs:string  The release version that eBay used to process the request.
ns:CorrelationID  xs:string  If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any     
ns:PopularSearchResult  ns:PopularSearchesType  Returns most popular search words by category.
ns:PageNumber  xs:int  Indicates the page of data returned by the current call. For instance, for the first set of items can be returned, this field has a value of one.
ns:TotalPages  xs:int  Indicates the total number of pages of data that could be returned by repeated requests.