Overview

Namespaces

  • Apptus
    • ESales
      • Connector
        • Report
        • Time
    • Util
      • Cache
  • PHP

Classes

  • Ad
  • AdConversionReport
  • AdConversionReportSection
  • AdList
  • AdListSection
  • AdOrderValueReport
  • AdOrderValueReportSection
  • AdPlacementReport
  • AdPlacementReportSection
  • Attribute
  • PanelConversionReport
  • PanelConversionReportSection
  • Placement
  • ProductSalesByAttributeReport
  • ProductSalesByAttributeReportSection
  • ProductSalesByTimeReport
  • ProductTopSellersReport
  • ProductTopSellersReportSection
  • Rate
  • Report
  • SearchConversion
  • SearchCount
  • SearchStatisticsReport
  • SessionStatistics
  • SessionStatisticsReport
  • SessionSummaryReport
  • Summary
  • Timeline
  • TimelineType
  • TimeSlot
  • TopSellingSearchesReport
  • TopSellingSearchesReportSection

Exceptions

  • FormatException
  • Overview
  • Namespace
  • Class
  • Tree

Class AdOrderValueReport

Report for ads.

Each section of the report contains all attributes for an ad together with timlines for click through rate and average order value for this ad. This report can be seen in the Ads tab on the Reports page in eSales Manager and it is described in the Order Value section on Apptus Zone (http://zone.apptus.com) .

Apptus\ESales\Connector\Report\Report
Extended by Apptus\ESales\Connector\Report\AdOrderValueReport
Namespace: Apptus\ESales\Connector\Report
Located at Connector/Report/AdOrderValueReport.php
Methods summary
public static Apptus\ESales\Connector\Report\AdConversionReport
# parse( string $data, DateTimeZone $tz )

Creates an AdOrderValueReport from an XML document.

Creates an AdOrderValueReport from an XML document.

Parameters

$data
string with the XML document to parse.
$tz
time zone for the report.

Returns

Apptus\ESales\Connector\Report\AdConversionReport
An AdConversionReport.

Throws

Apptus\ESales\Connector\Report\FormatException
if the XML document does not match the expected format.
public
# __construct( SimpleXMLElement $asXml, array $sections, Apptus\ESales\Connector\Time\TimeInterval $interval, Apptus\ESales\Connector\Report\TimelineType $timelineType, DateTimeZone $tz )

Creates an AdOrderValueReport.

Creates an AdOrderValueReport.

Parameters

$asXml
XmlTree to be used if the Apptus\ESales\Connector\Report\Report::exportToXml() method is called. Can not be null.
$sections
list of Apptus\ESales\Connector\Report\AdOrderValueReportSection elements. One for each ad in the report. Can not be null.
$interval
time range for the data in this report. Can not be null.
$timelineType
timeline type for the data in this report. Can not be null.
$tz
time zone for the data in this report. Can not be null.
public Apptus\ESales\Connector\Report\TimelineType
# timelineType( )

Returns

Apptus\ESales\Connector\Report\TimelineType
The timeline type used for the data in this report.
public array
# sections( )

Returns

array
A list of Apptus\ESales\Connector\Report\AdOrderValueReportSection elements. One for each ad in the report.
public
# exportToExcel( string $file )

Writes the report to a file. The report is written in plain text and ';' is used as separator.

Writes the report to a file. The report is written in plain text and ';' is used as separator.

Parameters

$file
file to write the report to.
Methods inherited from Apptus\ESales\Connector\Report\Report
exportToXml(), timeInterval()
Apptus ESales Connector PHP API documentation generated by ApiGen