Page History
| Table of Contents |
|---|
Google Analytics
...
Support
It is possible to record User Interface traffic by enabling the recording of Google Analytics data within DSpace using the DSpace. DSpace supports either Universal Analytics or Google Analytics 4. Also, under GA4 it currently supports the Google Tag (gtag.js), but not Google Tag Manager (GTM).
Enabling Google Analytics
By default, Google Analytics is disabled in DSpace. To enable it, simply set the value of google.analytics.key in the DSpace configuration file either your local.cfg or dspace.cfg. Until DSpace version 5.0 only User Interface activity could be recorded, that is to say that downloads initiated straight from a Google search (or any other search engine) were not recorded. As of DSpace version 5.0 downloads are now recorded as Google 'Events', so that all item page views and bitstream downloads are now recorded.
...
:
| Code Block |
|---|
# For Universal Analytics (older style Google Analytics)
google.analytics.key = UA-XXXXXX-X
# Or, for Google Analytics 4
google.analytics.key = G-XXXXX |
| Info |
|---|
When Google Analytics is disabled, you will see 404 responses returned from the REST API whenever the User Interface attempts to access |
Configuring Google Analytics
Additional configuration are provided to allow for enhanced Google Analytics support.
Property: |
|
Example Value: |
|
Informational Note: | Maximum number of events held in the buffer to send to Google Analytics. Used in conjunction with "cron" settings below. |
Property: |
|
Example Value: |
|
Informational Note: | REQUIRED if you want to send file download events to Google Analytics (where they will be tracked as Google "events"). This defines the schedule for how frequently events tracked on the backend (like file downloads) will be sent to Google Analytics. Syntax is defined at https://www.quartz-scheduler.org/api/2.3.0/org/quartz/CronTrigger.html The above example will run this task every 5 minutes (0 0/5 * * * ?) For Google Analytics 4, you MUST also add the "api-secret" below to support sending download events. |
Property: |
|
Example Value: |
|
Informational Note: | (Only used for Google Analytics 4) Defines a Measurement Protocol API Secret to be used to track interactions which occur outside of the user's browser. Steps to create your API secret are also available from https://www.monsterinsights.com/docs/how-to-create-your-measurement-protocol-api-secret-in-ga4/ |
Property: |
|
Example Value: |
|
Informational Note: | Which Bundles to include in Bitstream statistics. By default, set to ORIGINAL bundle only. |
Google Analytics Reports in DSpace UI
| Warning | ||
|---|---|---|
| ||
Google Analytics Reporting is not available in DSpace 7.0. While DSpace 7 can capture statistics via Google Analytics (see above), it is not able to display Google Analytics reports in the DSpace User Interface (like was supported in the XMLUI). It is under discussion as it's unclear how many sites use it. At this time it is tentatively scheduled for discussion as part of 7.2, see used this feature. See DSpace Release 7.0 Status |
...
*Note:- The Google documentation specifies that the Service Account email address should only require 'Read and Analyze' permission. However, it would appear this may not be the case and it may be necessary to grant greater permissions, at least initially.
Configuration settings for Google Analytics Statistics
In the [dspace.dir]/config/modules/google-analytics.cfg file review the following fields. These should be either edited directly or overridden in your local.cfg config file (see Configuration Reference).
Property: | google-analytics.application.name |
Value: | Dummy Project |
Informational Note: | Not sure if this property is required but it was in the example code provided by Google. Please do not delete. |
Property: | google-analytics.table.id |
Example Value: | ga:12345678 |
Informational Note: | Logon to the Google Analytics Dashboard and select the Property (or website in plain English) that you wish to target. Then select the Admin section for the property. You should then be able to select the 'view settings' for the view you are interested in. The View ID should replace 12345678 below (note - confusingly the Reporting API documentation refers to the View ID as Table ID). |
Property: | google-analytics.account.email |
Example Value: | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx@developer.gserviceaccount.com |
Informational Note: | The email address automatically generated when you created the Service Account. |
Property: | google-analytics.certificate.location |
Example Value: | /home/example/dslweb--privatekey.p12 |
Informational Note: | The certificate file automatically generated when you created the Service Account. |
Property: | google-analytics.authorization.admin.usage |
Example Value: | true |
Informational Note: | Control if the statistics pages should be only shown to authorized users. If enabled, only the administrators for the DSpaceObject will be able to view the statistics. If disabled, anyone with READ permissions on the DSpaceObject will be able to view the statistics. |
Google Analytics development and debugging
Identifying outgoing events in Chrome Dev Tools
Through "Inspect Element" in Chrome dev tools, you can identify outgoing requests to Google Analytics filtering on requests starting with "collect?"
The GA4 Measurement protocol and event parameters
https://www.thyngster.com/ga4-measurement-protocol-cheatsheet/ provides a handy overview of the parameters that are sent along
Analytics Debug View and Debugger Chrome extension
DebugView documentation: https://support.google.com/analytics/answer/7201382?hl=en
Overview
Content Tools