Inherits from Shopping_AbstractRequestType : NSObject
Declared in Shopping_FindPopularSearchesRequestType.h
Shopping_FindPopularSearchesRequestType.m

Overview

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.

@ingroup ShoppingInterface

Tasks

  •   categoryID

    Specify CategoryID to restrict your query to a specific category.
    Up to 10 categories may be specified.
    If you are using URL parameters, 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 findItemsAdvanced from the Finding API with CategoryHistogram value in the OutputSelector 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
  •   queryKeywords

    This field allows the user to specify one or more search terms, and then
    retrieve up to five related search terms and up to five alternative search
    terms. If you are using URL parameters, use the “%20” URL encoding to represent
    a space. For example, use
    Harry%20Potter to search for items containing these words in any order.




    QueryKeywords can be used in combination with CategoryID and IncludeChildCategories.

         property
  •   maxKeywords

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

         property
  •   maxResultsPerPage

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

         property
  •   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
  •   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

Properties

categoryID

Specify CategoryID to restrict your query to a specific category.
Up to 10 categories may be specified.
If you are using URL parameters, 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 findItemsAdvanced from the Finding API with CategoryHistogram value in the OutputSelector 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 (nonatomic, retain) NSMutableArray *categoryID

Discussion

Specify CategoryID to restrict your query to a specific category.
Up to 10 categories may be specified.
If you are using URL parameters, 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 findItemsAdvanced from the Finding API with CategoryHistogram value in the OutputSelector 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.

entry type : NSString, wrapper for primitive string

Declared In

Shopping_FindPopularSearchesRequestType.h

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 (nonatomic, retain) NSNumber *includeChildCategories

Discussion

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.

type : NSNumber, wrapper for primitive bool

Declared In

Shopping_FindPopularSearchesRequestType.h

maxKeywords

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

@property (nonatomic, retain) NSNumber *maxKeywords

Discussion

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

type : NSNumber, wrapper for primitive int

Declared In

Shopping_FindPopularSearchesRequestType.h

maxResultsPerPage

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

@property (nonatomic, retain) NSNumber *maxResultsPerPage

Discussion

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

type : NSNumber, wrapper for primitive int

Declared In

Shopping_FindPopularSearchesRequestType.h

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 (nonatomic, retain) NSNumber *pageNumber

Discussion

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).

type : NSNumber, wrapper for primitive int

Declared In

Shopping_FindPopularSearchesRequestType.h

queryKeywords

This field allows the user to specify one or more search terms, and then
retrieve up to five related search terms and up to five alternative search
terms. If you are using URL parameters, use the “%20” URL encoding to represent
a space. For example, use
Harry%20Potter to search for items containing these words in any order.




QueryKeywords can be used in combination with CategoryID and IncludeChildCategories.

@property (nonatomic, retain) NSMutableArray *queryKeywords

Discussion

This field allows the user to specify one or more search terms, and then
retrieve up to five related search terms and up to five alternative search
terms. If you are using URL parameters, use the “%20” URL encoding to represent
a space. For example, use
Harry%20Potter to search for items containing these words in any order.




QueryKeywords can be used in combination with CategoryID and IncludeChildCategories.

entry type : NSString, wrapper for primitive string

Declared In

Shopping_FindPopularSearchesRequestType.h