Get UI Safe

SpreadsheetApp.getUi() only exists when a user has the spreadsheet open. Time-driven and many installable triggers are headless — calling getUi() throws and aborts the run. getUiSafe returns the UI or null so onOpen menus and shared helpers don't blow up overnight jobs.

What you'll need

  • A container-bound Sheets script (UI is spreadsheet-scoped)
  • Code shared between onOpen / menus and time-driven / installable triggers
  • A habit of branching on ui instead of assuming a dialog works

How to use this snippet

/** * Return SpreadsheetApp.getUi() when a UI exists; otherwise null. * Safe for time-driven / installable headless executions. * @return {GoogleAppsScript.Base.Ui|null} */ function getUiSafe() { try { return SpreadsheetApp.getUi(); } catch (e) { return null; } }

Example

function onOpen() { var ui = getUiSafe(); if (!ui) return; ui.createMenu('Ops') .addItem('Run nightly sync now', 'nightlySync') .addToUi(); } function nightlySync() { // works from menu OR time-driven trigger var result = syncLeads_(); var ui = getUiSafe(); if (ui) { ui.alert('Sync done', 'Rows: ' + result.count, ui.ButtonSet.OK); } else { console.log('nightlySync ok', result); } }

Tips:

  • Never put getUi() at the top of a shared library function without a guard.
  • Simple onOpen is UI-context; installable onOpen still has UI when a user opens the file — time-driven does not.
  • Use ui.alert / menus only after the null check; log or email for headless paths.
  • Pair with emailErrorAlert when headless failures need a human.

Tip: NitroGAS Co-Pilot is handy for splitting "menu path" vs "trigger path" in one function without duplicating the real work.

Happy Coding!

Tags

NitroGAS Chrome Extension

Want this snippet handy inside the Apps Script editor? NitroGAS gives you free themes and snippets — plus optional Co-Pilot when you want a boost (1-week, 1-month, or yearly passes — no subscription). Happy Coding!

Get the Extension

Other Helpful Code Snippets:

Fill Html Template

function fillHtmlTemplate(html, values, opts) { opts = opts || {}; var onMissing = opts.onMissing || 'blank'; // 'blank' | 'throw' values = values || {}; function escapeHtml(s) { return String(s == null ? '' : s) .replace(/&/g, '&amp;').replace(/</g, '&lt;').replace(/>/g, '&gt;') .replace(/"/g, '&quot;').replace(/'/g, '&#39;'); } // {{{token}}} = raw HTML; {{token}} = escaped return String(html).replace(/\{\{\{([^{}]+)\}\}\}|\{\{([^{}]+)\}\}/g, function (_, rawKey, escKey) { var key = String(rawKey || escKey).trim(); var has = Object.prototype.hasOwnProperty.call(values, key); if (!has) { if (onMissing === 'throw') throw new Error('fillHtmlTemplate: missing key "' + key + '"'); return ''; } var val = values[key]; if (rawKey) return String(val == null ? '' : val); // raw / unescaped return escapeHtml(val); }); } // fillHtmlTemplate('<p>Hi {{name}}</p>', { name: 'Ada <3' });

Group Objects By Key

function groupObjectsByKey(rows, keyOrFn) { var out = {}; if (!rows || !rows.length) return out; var getKey = typeof keyOrFn === 'function' ? keyOrFn : function (row) { return row[keyOrFn]; }; rows.forEach(function (row) { var key = getKey(row); // Blank / missing keys become '' so they still land in one bucket if (key == null) key = ''; key = String(key); if (!out[key]) out[key] = []; out[key].push(row); }); return out; } // var byClient = groupObjectsByKey(rows, 'Client');

Is Within Business Hours

function isWithinBusinessHours(startHHmm, endHHmm, opts) { opts = opts || {}; var ss = opts.spreadsheet || (typeof SpreadsheetApp !== 'undefined' ? SpreadsheetApp.getActive() : null); var tz = (ss && ss.getSpreadsheetTimeZone && ss.getSpreadsheetTimeZone()) || Session.getScriptTimeZone() || 'America/New_York'; var when = opts.when || new Date(); // Weekday: 1=Mon … 7=Sun in spreadsheet timezone (Utilities 'u') var weekday = Number(Utilities.formatDate(when, tz, 'u')); var allowed = opts.weekdays || [1, 2, 3, 4, 5]; if (allowed.indexOf(weekday) === -1) return false; var mins = function (hhmm) { var p = String(hhmm).split(':'); return Number(p[0]) * 60 + Number(p[1] || 0); }; var nowMins = Number(Utilities.formatDate(when, tz, 'H')) * 60 + Number(Utilities.formatDate(when, tz, 'm')); var start = mins(startHHmm); var end = mins(endHHmm); // Half-open window [start, end) so 17:00 is "closed" if (end <= start) return nowMins >= start || nowMins < end; // overnight window return nowMins >= start && nowMins < end; } // if (!isWithinBusinessHours('09:00', '17:00')) return;