Provides automatic Google Analytics tracking of user interaction on embedded SoundCloud content
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
dist
src
test
.babelrc
.editorconfig
.gitignore
LICENSE
README.md
index.ejs
package.json
renovate.json
webpack.config.build.js
webpack.config.dev.js
webpack.config.js
webpack.config.test.js

README.md

SoundCloud IFRAME Analytics

A minimal library that attaches Google Analytics event tracking to user interactions performed on embedded SoundCloud iframes, both on single tracks as well as playlists. It should work from IE8 upwards - though the real concern with compatibility is probably restricted to the requirements of the SoundCloud embed itself -

This allows you to track user behaviour as well as have the events act as beacons to more accurately see page session duration. It also helps you in finding out how popular some of your tracks are ;)

Several versions of Google Analytics trackers are supported, namely:

  • Global Site Tag (gtag)
  • analytics.js (ga)
  • the legacy tracker (_gaq)

See the library in action here.

Installation

You can install this repository as a node module using npm:

npm install soundcloud-iframe-analytics --save-dev

How to integrate within your application

Firstly, embed the Analytics tracking code as provided by Google into your template(s).

The easy way, just drop in the JS file

Embed the SoundCloud iframes according to the embed code provided by SoundCloud. You do not need to make any changes to your markup. E.g. simply inject one or more instances of:

<iframe width="100%" height="300"
        scrolling="no" frameborder="no"
        src="https://w.soundcloud.com/player/?url=https%3A//api.soundcloud.com/playlists/{STRING_ID}&amp;color=%23ff5500&amp;auto_play=false&amp;hide_related=false&amp;show_comments=true&amp;show_user=true&amp;show_reposts=false&amp;show_teaser=true">
</iframe>

Include the minimized production version of the script (./dist/sia.min.js) at the bottom of your page and the script will automatically attach event listeners to the iframes.

The "I want full control" way

Alternatively, you can import the ES6 modules from the ./src folder and embed the library within your custom application code. You can use this in case you already use the SoundCloud Widget API to inject/control SoundCloud content in your page.

You can attach Analytics triggers to Widget events by passing an existing instance of SC.Widget to the attachSoundCloudAnalytics() function of the SoundCloud.js file, e.g.:

import { attachSoundCloudAnalytics } from "soundcloud-iframe-analytics/soundcloud/SoundCloud.js";

const existingWidget = ...; // SC.Widget instance created elsewhere in your application
attachSoundCloudAnalytics( existingWidget );

Bob's your uncle.

Event message format

The message format for the tracked events is:

  • Category: SoundCloud
  • Action: See list below
  • Label: Title of the SoundCloud track

The tracked actions are:

  • Playback started
  • Playback paused
  • Playback resumed
  • Playback scrubbed
  • Progress (num)
  • Progress (num) with scrubbing
  • Played in full
  • Played in full with scrubbing

Where:

  • starts are counted only once per track (unless it has finished playback, after which we can treat it as a new play).
  • scrubbed and with scrubbing indicates that the user has dragged the playback to a different point in the track and thus might have skipped sections. You can use this to determine engagement. Playback scrubbed is tracked only once (unless track has finished playback and is restarted).
  • progress is tracked for every 25 % of the track that has been played, expected values for (num) are: 1/4, 2/4, 3/4 and 4/4

Development

Setup

Install dependencies as usual:

npm install

Local development

Launching a local server (webpack-dev-server) with livereload and automatic recompilation on changes. Server will be available at http://localhost:8080

npm run dev

Creating a production build

npm run build

Build output will be stored in ./dist-folder.

Unit testing

Unit tests are run via Mocha, which is installed as a dependency, along with Chai as the assertion library. You can run the tests by using:

npm test

Unit tests go in the ./test-folder. The file name for a unit test must be equal to the file it is testing, but contain the suffix ".test", e.g. Functions.js will have a test file Functions.test.js.

Tests will be available at http://localhost:8080/test/test.html.

Configuration

Configurations for all target environments are in the root of the repository in the webpack.config.{TARGET}.js files.