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

NAME
eBay::API::XML::DataType::ExpressHistogramDomainDetailsType

DESCRIPTION
Identifies a domain and provides statistics for items and catalog products found in that domain.

SYNOPSIS

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

Subroutines:

  setBreadCrumb()
The fully qualified display name of the domain, as it would appear in the Express Web site user interface. For example, a fully qualified aisle breadcrumb would include the department's display name and the aisle's display name. The names can contain spaces, and a greater-than character (">") is used as the delimiter; for example: Consumer Electronics > Cell Phones & PDAs > PDA Accessories. As with all string data types, reserved characters like ">" are escaped in the raw response.<br> <br> Note: The potential max length will be documented in a future release.

# Argument: 'xs:string'

  getBreadCrumb()
# Returns: 'xs:string'

  setImageURL()
The image associated with the department, aisle, or product, if any. All domains should be associated with an image. However, there may be rare cases when an image is not available.

# Argument: 'xs:anyURI'

  getImageURL()
# Returns: 'xs:anyURI'

  setItemCount()
The number of matching items that were found in the specified department, aisle, or product type at the moment when your request was processed. An item can belong to multiple departments, aisles, or product types at any given time. (So you should not expect the sum of the item counts in aisles and product types to equal the item count in a parent department.) Also, this value will not necessarily match the number of items returned in the response (even if you retrieve all pages), because ItemArray returns deduped items.<br> <br> If HistogramDetails==Coarse and you don't specify DepartmentName, AisleName, or ProductTypeName in the request, Express only counts items found in matching departments. In this particular case, ItemCount could be 0 in all domain histogram results when the only matching items are in stand-alone product types or aisles (because they aren't grouped into departments).

# Argument: 'xs:int'

  getItemCount()
# Returns: 'xs:int'

  setName()
The domain name, with no spaces. Use this to determine DepartmentName, AisleName, and/or ProductTypeName values to pass in the request.

# Argument: 'xs:string'

  getName()
# Returns: 'xs:string'

  setProductCount()
The number of matching eBay catalog products that were found in the specified department, aisle, or product type at the moment when your request was processed.<br> <br> If HistogramDetails==Coarse and you don't specify DepartmentName, AisleName, or ProductTypeName in the request, Express only counts catalog products found in matching departments. In this particular case, ProductCount could be 0 in all domain histogram results when the only matching catalog products are in stand-alone product types or aisles (because they aren't grouped into departments).

# Argument: 'xs:int'

  getProductCount()
# Returns: 'xs:int'