eBay::API::XML::DataType::RequestCategoriesType(3)

NAME
eBay::API::XML::DataType::RequestCategoriesType

DESCRIPTION
A set of parameters that control the retrieval of categories (not items) that match a search query. In GetSearchResults, at least one child element must be specified in order to retrieve matching categories. If empty or not present, no matching category information is returned.

SYNOPSIS

INHERITANCE
eBay::API::XML::DataType::RequestCategoriesType inherits from the eBay::API::XML::BaseDataType class

Subroutines:

  setCategoriesOnly()
Filter to retrieve matching categories but not matching items or buying guides. If true, only matching categories are returned (with no item or buying guide details). If false or not present, matching items and matching categories are both returned, along with buying guide details (if any). If TotalOnly and Categories.CategoriesOnly are both specified in the request and their values are inconsistent with each other, TotalOnly overrides Categories.CategoriesOnly. That is, if TotalOnly is true and Categories.CategoriesOnly is false, the results include matching categories but no item data or buying guides. If TotalOnly is false and Categories.CategoriesOnly is true, the results include matching categories, item data, and buying guides.

  Calls: GetSearchResults
  RequiredInput: No

# Argument: 'xs:boolean'

  isCategoriesOnly()
# Returns: 'xs:boolean'

  setDemandData()
If you specify that DemandData is true, then the categories returned will be sorted based on Best Match. The most relevant categories will be returned first.

  Calls: GetSearchResults
  RequiredInput: No

# Argument: 'xs:boolean'

  isDemandData()
# Returns: 'xs:boolean'

  setLevels()
Filter to control the deepest matching category level to return. If you specify 0, no category data is returned. If you specify a negative number, the results are unpredictable.

Default: 2 Min: 1

  Calls: GetSearchResults
  RequiredInput: No

# Argument: 'xs:int'

  getLevels()
# Returns: 'xs:int'

  setMaxCategories()
Maximum quantity of matching categories to return at the first level of the category hierarchy (CategoryLevel 1).

Default: 3

  Calls: GetSearchResults
  RequiredInput: No

# Argument: 'xs:int'

  getMaxCategories()
# Returns: 'xs:int'

  setMaxSubcategories()
Maximum quantity of matching subcategories to return at each lower level of the hierarchy.

Default: 3

  Calls: GetSearchResults
  RequiredInput: No

# Argument: 'xs:int'

  getMaxSubcategories()
# Returns: 'xs:int'