| Class | Description |
|---|---|
| Ad |
A class that contains attribute information for an ad.
|
| AdConversionReport |
Report for ads.
|
| AdConversionReport.Section |
Sub class for AdConversionReport.
|
| AdList |
Report for ads containing all ad attributes together with click through rate and conversion rate.
|
| AdList.Section |
Sub class for AdList report.
|
| AdOrderValueReport |
Report for ads.
|
| AdOrderValueReport.Section |
Sub class for AdOrderValueReport.
|
| AdPlacementReport |
Report for ads.
|
| AdPlacementReport.Section |
Sub class for AdPlacementReport.
|
| ArgMap |
Convenience class for passing arguments to a panel request.
|
| AttributeValidationUtils |
Simple validation rules for eSales identifiers
|
| Authorization | Deprecated.
Please use
CustomerKeyAuthentication instead. |
| CalendarDate |
A date on the form YYYY-MM-DD according to the Gregorian calendar.
|
| CloudConnector |
Connector for Apptus eSales when hosted in the cloud.
|
| Cluster | Deprecated. |
| ClusterUnavailableException |
Signals that a cluster operation gave up since no units seem to be able to process the request.
|
| Connector |
Abstract super type for CloudConnector and OnPremConnector.
|
| Connector.ConnectorKey | |
| ControllerConfigurationException | Deprecated.
Not used as of eSales 3.3.
|
| CssClass |
Class used to generate the css classes that are required to use automatic notifications or site overlay for web pages.
|
| CustomerKeyAuthentication |
A class that should be used for creating personal customer keys when using eSales Web-API.
|
| DuplicateSubpanelException | |
| Duration |
A duration on the form P[yY][mM][dD][T[hH][mM][sS]] or P[wW], that specifies the length of a time interval.
|
| DynamicPage |
A dynamic page consists of a page name and a number of subpanels.
|
| EventDataJobResult |
Used to represent the responses from customer data related methods (e.g.
|
| EventDataJobResult.Status | |
| Facets |
Class for creating a facets argument, used for check-box navigation.
|
| FetchClusterException |
Exception for errors during cluster configuration loading
|
| Filter |
A convenience class for filters used as argument to selected functions in the eSales service.
|
| FilterBuilder |
A set of static methods for building a filter.
|
| InterruptedIterationException |
Thrown when an iteration is prematurely interrupted by an exception.
|
| InvalidFilterException |
Thrown to signal that an invalid filter was specified using the filter builder.
|
| IsoDate |
A date on any valid ISO 8601 format.
|
| IsoDateTime |
A date and time on the ISO 8601 format.
|
| JavaScriptNotifier |
A class used by the JavaScript notification system.
|
| MessageAuthentication |
A class that is used for signing messages.
|
| MissingSubpanelException | |
| Month |
Enumeration of months.
|
| OnPremConnector |
Connector for on-premise instances of Apptus eSales.
|
| Order |
A sale order from a customer session.
|
| Order.Line |
An order line in a sale order.
|
| OrdinalDate |
A date on the form YYYY-DDD according to the Gregorian calendar, where
DDD specifies the day of year.
|
| Panel |
A panel in the eSales panel hierarchy.
|
| PanelContent |
The content of a panel as retrieved from an eSales service.
|
| PanelConversionReport |
Report for panel performance, one section for each public panel path.
|
| PanelConversionReport.Section |
Sub class for PanelConversionReport.
|
| PanelException |
Thrown when trying to read the result from a panel, if the evaluation resulted in error in the eSales service.
|
| ParseException |
Thrown when a response from the eSales service could not be parsed.
|
| Path |
Convenience class for working with panel paths.
|
| Placement |
A class holding the number of clicks, number of displays and click through rate for a public panel path.
|
| ProductSalesByAttributeReport |
Report containing sales statistics aggregated by product attribute values during the specified time interval.
|
| ProductSalesByAttributeReport.Section |
Sub class for
ProductSalesByAttributeReport Contains sales data for a group of products with a common facet value. |
| ProductSalesByTimeReport |
Report containing aggregated sales statistics.
|
| ProductStreamer |
An Iterable
ProductStreamer that allows you to do filtered product exports, conveniently parsed into
Result.Product items. |
| ProductTopSellersReport |
Report for products.
|
| ProductTopSellersReport.Section |
Sub class for
ProductTopSellersReport Contains sales data for one product (or variant). |
| Rate |
A wrapper class for a double representing a rate.
|
| Report | |
| Reporter |
A Reporter fetches market-specific reports from an eSales cluster.
|
| ReportException | |
| Result |
Base class for results parsed from the replies from an eSales service.
|
| Result.Ad |
Represents a single element in a result having the ad format.
|
| Result.Ads |
Represents a result having the ads format.
|
| Result.Attribute |
Representation of an attribute for a product, variant, category or ad.
|
| Result.Category |
A common abstraction for the
Result.CategoryNode and Result.CategoryData classes. |
| Result.CategoryData |
A class representing a category that holds only attribute information.
|
| Result.CategoryList |
Represents a result having the category_list format, which is a list of CategoryData objects.
|
| Result.CategoryNode |
Represents a result having the category_tree format.
|
| Result.Completion |
Represents a single element in a result having the completions format.
|
| Result.Completions |
Represents a result having the completions format.
|
| Result.Correction |
Represents a single element in a result having the corrections format.
|
| Result.Corrections |
Represents a result having the corrections format.
|
| Result.Count |
Represents a result having the count format.
|
| Result.Facet | |
| Result.FacetList |
Represents a result having the facet list format.
|
| Result.FacetRange |
Represents a result having the facet_range format.
|
| Result.Phrase |
Represents a single element in a result having the phrases format.
|
| Result.Phrases |
Represents a result having the phrases format.
|
| Result.Product |
Represents a single element in a result having the products format.
|
| Result.Products |
Represents a result having the products format.
|
| Result.ResultType |
Result types
|
| Result.Value |
Represents a single element in a result having the values format.
|
| Result.Values |
Represents a result having the values format.
|
| Result.Variant |
Represents a product variant.
|
| ResultTypeException |
Thrown when trying to retrieve a result as a specific resultType, which the result does not match.
|
| SearchStatisticsReport |
Report for Search statistics on the site.
|
| SearchStatisticsReport.SearchConversion |
Class holding data for rank, count conversion rate and impact for a phrase.
|
| SearchStatisticsReport.SearchCount |
Class holding data for rank, count and search rate for a phrase.
|
| Session |
A session where information is exchanged with an eSales service.
|
| SessionStatistics |
A class that holds data for a
SessionStatisticsReport. |
| SessionStatisticsReport |
Report for Session statistics on the site.
|
| SessionSummaryReport |
Report with a summary of session statistics for the entire site as well as grouped by searches and recommendations.
|
| SKUList | Deprecated.
As of eSales 3.3, please use Order instead.
|
| Subpanel |
A subpanel refers to a public panel, and can be provided to a dynamic page in order to
retrieve content from several panels at once without having to predefine a zone.
|
| Summary |
A class that holds data for a
SessionSummaryReport. |
| Time |
A time of day in ISO 8601 format.
|
| TimeInterval |
An interval between two points in time.
|
| Timeline<V> |
A list of
TimeSlot |
| TimelineType<S extends Comparable<? super S>> |
Enumeration for report timeline types
|
| TimeoutSettings | |
| TimePoint |
A point on the time scale.
|
| TimeSlot<V> |
A class representing time slots in the reports.
|
| TopSellingSearchesReport |
Report for search phrases associated with the products and variants that matches a filter.
|
| TopSellingSearchesReport.Section |
Sub class for
TopSellingSearchesReport Contains a search phrase together with
the total number of times the search phrase has lead to a purchase of a product or a variant that matches the filter specified in the report. |
| Unit |
An enumeration of time units.
|
| UnknownUnitException |
Thrown when a time unit is not recognized as a valid unit.
|
| WeekDate |
A week date on the format YYYY-Www-D, as defined by ISO 8601.
|
| Weekday |
A day-of-week enumeration.
|
Copyright © 2020 Apptus Technologies AB. All rights reserved.