Docs
search ⌘K
search Esc

Plugins

Plugins extend UbuntuPlay with data integrations and automation. Install them from the marketplace, configure settings, and run manually or on an automated schedule.

Official Plugins

analytics Google Sheets Export

Automatically exports your organisation's latest impact report data to a Google Sheet. Supports daily scheduled runs and manual triggers. Uses a Service Account — no OAuth redirect required, works from a local server.

Setup (one-time, ~10 minutes)

  1. Go to console.cloud.google.com and create or select a project

  2. Navigate to APIs & Services → Enable APIs → search for Google Sheets API → Enable

  3. Go to IAM & Admin → Service Accounts → Create Service Account. Give it any name (e.g. ubuntu-play-export)

  4. Click the new service account → Keys tab → Add Key → Create new key → JSON. A credentials file downloads to your device

  5. Open your Google Sheet → click Share → paste the service account email (looks like name@project.iam.gserviceaccount.com) → Send

  6. Copy the Spreadsheet ID from the sheet URL — the long string between /d/ and /edit

Installation

  1. Go to Plugins → Marketplace in the org portal

  2. Click + Install on Google Sheets Export

  3. Go to My Plugins → settings Settings

  4. Paste the full JSON credentials file contents into Service Account JSON

  5. Enter the Spreadsheet ID

  6. Click Save, then Enable

description
Sheet columns exportedExport Date, Organisation, School ID, School Name, Country, Unique Learners, Total Puzzles, Quiz Accuracy %, Learning Minutes, Avg Minutes/Learner, Active Days, Report Date — plus optional plan/status/student count columns.

Installing Any Plugin

  1. Go to Plugins in the org portal sidebar

  2. Click Marketplace tab

  3. Browse available plugins — official plugins show a military_tech badge

  4. Click + Install

  5. Go to My Plugins, find the plugin, click settings Settings

  6. Fill in required configuration fields and click Save

  7. Click Enable to activate the plugin

warning
Enable after configuringPlugins are disabled by default after installation. Configure all required settings before enabling to avoid errors on first run.

Running Plugins

Manual trigger

Enabled plugins with the manual trigger show a ▶ Run Now button. Click it to run immediately. The result panel shows what the plugin returned — for Google Sheets, this includes the number of rows written and a link to open the sheet.

Scheduled (daily at 6am)

Plugins with the schedule:daily trigger run automatically at 06:00 server time every day. No action required after enabling.

On report

Plugins with the on_report trigger fire automatically each time a school sends an impact report to the hub.

For Developers

Want to build and publish your own plugin? See Publishing a Plugin →