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 AdList

Report for ads containing all ad attributes together with click through rate and conversion rate.

This report can be seen in the Ads tab on the Reports page in eSales Manager and it is described in the Ads section on Apptus Zone (http://zone.apptus.com).

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

Creates an AdList from an XML document.

Creates an AdList from an XML document.

Parameters

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

Returns

Apptus\ESales\Connector\Report\AdList
An AdList.

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, DateTimeZone $tz )

Creates an AdList.

Creates an AdList.

Note that null is illegal for all input parameters.

Parameters

$asXml
XmlTree to be used if the Apptus\ESales\Connector\Report\Report::exportToXml() method is called.
$sections
list of Apptus\ESales\Connector\Report\AdListSection elements. One for each ad in the report.
$interval
time range for the data in this report.
$tz
time zone for the data in this report.
public Apptus\ESales\Connector\Report\AdListSection[]
# sections( )

Returns

Apptus\ESales\Connector\Report\AdListSection[]
All sections in this report. One for each ad.
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