Extension:GoogleAnalyticsMetrics
GoogleAnalyticsMetrics Release status: stable |
|
---|---|
Implementation | Parser function |
Description | Gets metrics from Google Analytics |
Author(s) | Ike Hecht (Tosfostalk) |
Maintainer(s) | WikiTeq team |
Latest version | 1.0.2 (January 2023) |
Compatibility policy | For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension. |
MediaWiki | 1.35, 1.39 |
Database changes | No |
License | GNU General Public License 2.0 or later |
Download | |
|
|
Quarterly downloads | 6 (Ranked 127th) |
Translate the GoogleAnalyticsMetrics extension if it is available at translatewiki.net | |
Issues | Open tasks · Report a bug |
The GoogleAnalyticsMetrics extension gets various metrics from Google Analytics and inserts them into a wiki page using a parser function. This extension was created for WikiWorks.
The GoogleAnalyticsMetrics
extension may not be appropriate for your site if you have data security and privacy concerns.
The extensions inserts JavaScript code in each page served, and the code causes the client to contact Google services to process and aggregate data.
Your site's users will be subjected to tracking and data mining regardless of the Do Not Track or Global Privacy Control browser settings.
Installation
- Setup Google Analytics API by following Step 1 here
- Install the Google Client Library by following Step 2 here
- Enable Google Analytics Reporting API in your Google Cloud Console
- Download and move the extracted
GoogleAnalyticsMetrics
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/GoogleAnalyticsMetrics - Only when installing from Git, run Composer to install PHP dependencies, by issuing
composer install --no-dev
in the extension directory. (See task T173141 for potential complications.) - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'GoogleAnalyticsMetrics' );
- Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Usage
The googleanalyticsmetrics
parser function takes three parameters, in the form of:
{{#googleanalyticsmetrics: metric=Name of metric|page=Page Name|startDate=Start date|endDate=End date}}
- Name of metric
- The name of the Google Analytics Metric that should be displayed. The full list of Google Analytics metrics is here. Omit the
ga:
prefix. - Page Name
- The name of the page. This parameter is only used when the metric is a per page metric.
- Start date
- Show the metric since this date (optional). Defaults to
2005-01-01
, which is the beginning of time according to Google Analytics. - End date
- Show the metric until this date (optional). Defaults to
today
.
Both date parameters use the form: Year-Month-Day.
Examples
This example displays the number of page views for this site, from the beginning until the end of time:
{{#googleanalyticsmetrics: metric=pageviews}}
Show the number of sessions from February 3, 2011 until today.
{{#googleanalyticsmetrics: metric=session|startDate=2011-02-03}}
Show the average session duration until February 1 2012:
{{#googleanalyticsmetrics: metric=avgSessionDuration|endDate=2012-02-01}}
Show the number of page views for last month only, with the help of the ParserFunctions extension:
{{#googleanalyticsmetrics: metric=pageviews|startDate={{#time:Y-m-d|first day of last month}}|endDate={{#time:Y-m-d|first day of this month}}}}
Or, to make that nicer:
{{formatnum:{{#googleanalyticsmetrics: metric=pageviews|startDate={{#time:Y-m-d|first day of last month}}|endDate={{#time:Y-m-d|first day of this month}}}}}}
Show the number of page views for a page, from the beginning until the end of time:
{{#googleanalyticsmetrics: metric=pageviews|page=Main_Page}}
See this page for some help with formatting this extension's output.
There is also a {{#googleanalyticstrackurl:http://urlhere|link text}}
function but it only works if the ga
js library has already been loaded.
Configuration parameters
- $wgGoogleAnalyticsMetricsAllowed
- An array containing the name of Google Analytics metrics that are allowed to be retrieved by the extension. Defaults to
*
, which allows all metrics. - $wgGoogleAnalyticsMetricsEmail
- The email address of the Google Analytics account.
- $wgGoogleAnalyticsMetricsPath
- Path to your certificate key file.
- $wgGoogleAnalyticsMetricsViewId
- Google Analytics View ID.
See also
This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |