HeRoMo/RealtimeAURecorder

A Google Apps Script to record realtime activeUsers

RealtimeAURecorder

A Google Apps Script application to record realtime active users from Google Analytics.

This application has the following features,

• Recording the value of realtime active users
• Drawing line chart of recorded active users

Dependencies

• Node.js 8.11 or later
• google/clasp 1.5.3 or later
• Google Sheets
• Google Analytics API

How to install

1. Clone RealtimeAURecorder. and install npm packages.

$ git clone https://github.com/HeRoMo/RealtimeAURecorder.git
$ cd RealtimeAURecorder
$ yarn install

2. Create project and deploy

$ yarn clasp:login
$ yarn clasp:create # create new GAS project named RealtimeAuRecorder
$ yarn clasp:push # deploy

Notice: this scripts uses clasp command. see @google/clasp

3. Open container spreadsheet, and open script editor, then run setUp function in code.gs.
   • function setUp creates SETTINGS sheet in container spreadsheet.
4. Turn ON Google Analytics API in Advanced Google services setting of the script and API console of Google Cloud.

How to setting

1. Create a folder as base_dir in your Google Drive, that is for creating spreadsheets to record realtime active users count.
2. Open the SETTINGS sheet.
3. Add a row to SETTINGS sheet.
   • name : your web site name
   • ga_view_id : Google Analytics view id of your web site.
   • base_dir : Google Drive folder id of your base_dir.
4. Test your setting.
   Open script editor and exec recordAUAll function in code.gs.
   if your setting is collect, a folder and a spreadsheet created in base_dir.
5. If you have another web site, add another row in the SETTINGS sheet.

Record continuously

To record active users, you only run recordAUAll function in code.gs.
To record active users continuously, you can use time-driven trigger.

1. Run yarn clasp:open to open script editor.
2. From the script editor, choose Edit > Current project's triggers.
3. Click the link that says: Click here to add one now.
4. Under Run, select recordAUAll function.
5. Under Events, select Time-driven, and select Minutes timer, and then select every 5 minutes.

Web interface

This application has web user interface, for showing the chart of active users count.

At first, you have to Deploy this scripts as a web app.

1. Open script editor from the container spreadsheet.
2. Select Publish > Deploy as web app.
3. Select version, authorization and access scope.
4. Publish the web app.
5. Access your web app url.

License

This scripts is released under the MIT License, see LICENSE.