eBay Shopping Web Service

Method: FindPopularSearches

Description

Finds the keywords that users are searching on for listings.

Action

Style

Document

Input (Literal)

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

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

Output (Literal)

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

Element  Type  Occurs  Description 
    1..1   
ns:Timestamp  xs:dateTime  0..1  This value represents the date and time when eBay processed the request.
ns:Ack  ns:AckCodeType  0..1  Indicates whether the call was successfully processed by eBay.
ns:Errors  ns:ErrorType  0..*  A list of application-level errors or warnings (if any) that were raised when eBay processed the request.
ns:Build  xs:string  0..1  This refers to the particular software build that eBay used when processing the request and generating the response.
ns:Version  xs:string  0..1  The release version that eBay used to process the request.
ns:CorrelationID  xs:string  0..1  If you pass a value in MessageID in a request, we will return the same value in CorrelationID in the response.
any    0..*   
ns:PopularSearchResult  ns:PopularSearchesType  0..*  Returns most popular search words by category.
ns:PageNumber  xs:int  0..1  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  0..1  Indicates the total number of pages of data that could be returned by repeated requests.