View on
MetaCPAN
Jon Schutz > WWW-Analytics-MultiTouch > multitouch_report.pl

Download:
WWW-Analytics-MultiTouch-0.36.tar.gz

Annotate this POD

CPAN RT

Open  1
View/Report Bugs
Source  

NAME ^

multitouch_report.pl - MultiTouch Analytics Reporting

SYNOPSIS ^

multitouch_report --ID=ANALYTICSID --start_date=YYYYMMDD --end_date=YYYYMMDD --filename=FILENAME

DESCRIPTION ^

Runs MultiTouch Analytics reports; see http://www.multitouchanalytics.com/ for details.

GOOGLE ACCOUNT AUTHORISATION ^

In order to give permission for the multitouch reporting to access your data, you must follow the authorisation process. On first use, a URL will be displayed. You must click on this URL or cut and paste it into a browser, log in as the Google user that has access to the Google Analytics profile that you wish to analyse, grant permission, and paste the resulting authorisation code into the console. After this, the authorisation tokens will be stored and there should be no need to repeat the process.

In case you need to change user or profile or re-authenticate, see the information on the --auth_file option.

NOTE: In versions prior to 0.30, it was necessary to specify a the username and password for your Google account. This is no longer necessary.

BASIC OPTIONS

REPORT OPTIONS

ADVANCED OPTIONS

CONFIGURATION FILE ^

A configuration file can be used to store any of the command line options, plus advanced options that control the type and layout of the reports.

The file format is Config::General, per the following example:

  id = 5555555
  ga_timezone = -1300
  report_timezone = UTC

  channel_pattern = med-subcat

  <column_heading_format>
    bold = 1
    color = white
    bg_color = red
    right_color = white
    right = 1
  </column_heading_format>

  <row_heading_format>
    bold = 1
    bg_color = gray
  </row_heading_format>

  <header_layout>
    hide_gridlines = 2
    <image>
      row = 1
      col = 0
      filename = MyLogo.png
    </image>
    <header>
      row = 5
      col = 0
      colspan = 5
      text = Multi Touch Reporting
      <cell_format>
        align = center
        bold = 1
        bg_color = red
        color = white
        size = 16
      </cell_format>
    </header>
    <header>
      row = 7
      col = 0
      text = Generation Date:
      text = Report Type:
      text = Date Range:
      text = Analysis Window:
      <cell_format>
        align = right
        bold = 1
      </cell_format>
    </header>
    <header>
      row = 7
      col = 1
      text = @generation_date
      text = @title
      text = @start_date - @end_date
      text = @window_length days
    </header>

    start_row = 10
  </header_layout>

  <channel_map>
    (none)-(none) = Direct
    organic-(none) = Organic
    cpc-(none) = CPC
    email-(none) = Email
    referral-(none) = Referral
  </channel_map>

The configuration file contains a global section and may contain a report-specific section for each report. Options from the report-specific section are merged with the global options before use.

For every type of report in the command-line options, (all_touches_report, first_touch_report, transactions_report, etc), the report-specific section has a corresponding name, e.g. 'all_touches', 'first_touch', 'transactions'. For example,

  <all_touches>
    title = Channel Contribution
    <title_format>
      bold = 1
    </title_format>
    sheetname = Channel Contribution
    <heading_map>
      Transactions = Contributed Transactions
      Revenue = Contributed Revenue
    </heading_map>
    <column_formats>
      bg_color = white
    </column_formats>
  </all_touches>

The options in the configuration file are the same as those described under "process" in WWW::Analytics::MultiTouch. An example configuration file can be found in the examples directory of this distribution.

The special variable $cwd may be used to refer to the directory in which the configuration file is found, so filenames may be specified relative to this directory, e.g.

  filename = $cwd/../images/MyLogo.png

RELATED INFORMATION ^

See http://www.multitouchanalytics.com for further details.

AUTHOR ^

Jon Schutz, <jon at jschutz.net>

BUGS ^

Please report any bugs or feature requests to bug-www-analytics-multitouch at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=WWW-Analytics-MultiTouch. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT ^

You can find documentation for this module with the perldoc command.

    perldoc WWW::Analytics::MultiTouch

You can also look for information at:

COPYRIGHT & LICENSE ^

 Copyright 2010 YourAmigo Ltd.

 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
 in the Software without restriction, including without limitation the rights
 to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 copies of the Software, and to permit persons to whom the Software is
 furnished to do so, subject to the following conditions:

 The above copyright notice and this permission notice shall be included in
 all copies or substantial portions of the Software.

 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
syntax highlighting: