├── Code.gs
├── ProcessDimensions.html
├── ProcessJavaScript.html
├── PropertySelector.html
├── README.md
├── SelectorJavaScript.html
└── Styles.html


/Code.gs:
--------------------------------------------------------------------------------
  1 | function buildSourceSheet() {
  2 |   var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Source Data');
  3 |   var i, defaultDim, scopeRange, scopeRule, activeRange, activeRule;
  4 |   if (!sheet) {
  5 |     sheet = SpreadsheetApp.getActiveSpreadsheet().insertSheet('Source Data');
  6 |   }
  7 |   defaultDim = sheet.getRange(2, 2, 1, 3).getValues();
  8 |   sheet.getRange(1, 2, 1, 3).setValues([['Name', 'Scope', 'Active']]);
  9 |   sheet.getRange(2, 1, 1, 1).setValue('DEFAULT/EMPTY');
 10 |   sheet.getRange(1, 1, 203, 4).setNumberFormat('@');
 11 |   if (isEmpty(defaultDim[0])) {
 12 |     sheet.getRange(2, 2, 1, 3).setNumberFormat('@').setValues([['(n/a)', 'HIT', 'false']]);
 13 |   }
 14 |   for (i = 1; i <= 200; i++) {
 15 |     sheet.getRange(2 + i, 1, 1, 1).setValue('ga:dimension' + i);
 16 |   }
 17 |   
 18 |   // Set validation for SCOPE
 19 |   scopeRange = sheet.getRange(2, 3, 201, 1);
 20 |   scopeRule = SpreadsheetApp.newDataValidation()
 21 |     .requireValueInList(['HIT','PRODUCT','SESSION','USER'])
 22 |     .setAllowInvalid(false)
 23 |     .setHelpText('Scope must be one of HIT, PRODUCT, SESSION or USER')
 24 |     .build();
 25 |   scopeRange.setDataValidation(scopeRule);
 26 |   
 27 |   // Set validation for ACTIVE
 28 |   activeRange = sheet.getRange(2, 4, 201, 1);
 29 |   activeRule = SpreadsheetApp.newDataValidation()
 30 |     .requireValueInList(['true', 'false'])
 31 |     .setAllowInvalid(false)
 32 |     .setHelpText('Active must be one of true or false')
 33 |     .build();
 34 |   activeRange.setDataValidation(activeRule);
 35 | }
 36 | 
 37 | function fetchAccounts() {
 38 |   return Analytics.Management.AccountSummaries.list({
 39 |     fields: 'items(id,name,webProperties(id,name))'
 40 |   });
 41 | }
 42 | 
 43 | function include(filename) {
 44 |   return HtmlService.createHtmlOutputFromFile(filename)
 45 |     .getContent();
 46 | }
 47 | 
 48 | function isEmpty(row) {
 49 |   return /^$/.test(row[0]) && /^$/.test(row[1]) && /^$/.test(row[2]);
 50 | }
 51 | 
 52 | function isValid(row) {
 53 |   var name = row[0];
 54 |   var scope = row[1];
 55 |   var active = row[2];
 56 |   return !/^$/.test(name) && /HIT|SESSION|USER|PRODUCT/.test(scope) && /true|false/.test(active);
 57 | }
 58 | 
 59 | function buildSourceData(sheet) {
 60 |   var range = sheet.getRange(3, 2, 200, 3).getValues();
 61 |   var defaultDim = sheet.getRange(2, 2, 1, 3).getValues();
 62 |   if (!isValid(defaultDim[0])) {
 63 |     throw new Error('Invalid source value found in DEFAULT/EMPTY row');
 64 |   }
 65 |   var sourceDimensions = [];
 66 |   var i;
 67 |   for (i = 0; i < range.length; i++) {
 68 |     if (!isEmpty(range[i]) && !isValid(range[i])) {
 69 |       throw new Error('Invalid source value found in dimension ga:dimension' + (i + 1));
 70 |     }
 71 |     if (!isEmpty(range[i])) {
 72 |       sourceDimensions.push({
 73 |         id: 'ga:dimension' + (i + 1),
 74 |         name: range[i][0],
 75 |         scope: range[i][1],
 76 |         active: range[i][2]
 77 |       });
 78 |     } else {
 79 |       sourceDimensions.push({
 80 |         name: defaultDim[0][0] || '(n/a)',
 81 |         scope: defaultDim[0][1] || 'HIT',
 82 |         active: defaultDim[0][2] || 'false'
 83 |       });
 84 |     }
 85 |   }
 86 |   return sourceDimensions;
 87 | }
 88 | 
 89 | function updateDimension(action, aid, pid, index, newDimension) {
 90 |   if (action === 'update') {
 91 |     return Analytics.Management.CustomDimensions.update(newDimension, aid, pid, 'ga:dimension' + index, {ignoreCustomDataSourceLinks: true});
 92 |   }
 93 |   if (action === 'create') {
 94 |     return Analytics.Management.CustomDimensions.insert(newDimension, aid, pid);
 95 |   }
 96 | }
 97 | 
 98 | function startProcess(aid, pid, limit) {
 99 |   var dimensions = Analytics.Management.CustomDimensions.list(aid, pid, {fields: 'items(id, name, scope, active)'});
100 |   var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Source Data');
101 |   var sourceData = buildSourceData(sheet);
102 |   var template = HtmlService.createTemplateFromFile('ProcessDimensions');
103 |   template.data = {
104 |     limit: limit,
105 |     dimensions: dimensions,
106 |     sourceData: sourceData,
107 |     accountId: aid,
108 |     propertyId: pid
109 |   };
110 |   SpreadsheetApp.getUi().showModalDialog(template.evaluate().setWidth(400).setHeight(400), 'Manage Custom Dimensions for ' + pid);
111 | } 
112 | 
113 | function isValidSheet(sheet) {
114 |   var defaultDim = sheet.getRange(2, 2, 1, 3).getValues();
115 |   var dims = sheet.getRange(3, 2, 200, 3).getValues();
116 |   var i;
117 |   if (!isValid(defaultDim[0])) {
118 |     throw new Error('You must populate the DEFAULT/EMPTY row with proper values');
119 |   }
120 |   for (i = 0; i < dims.length; i++) {
121 |     if (!isEmpty(dims[i]) && !isValid(dims[i])) {
122 |       throw new Error('Invalid values for dimension ga:dimension' + (i + 1));
123 |     }
124 |   }
125 |   return true;
126 | }
127 | 
128 | function openDimensionModal() {
129 |   var ui = SpreadsheetApp.getUi();
130 |   var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Source Data');
131 |   var html = HtmlService.createTemplateFromFile('PropertySelector').evaluate().setWidth(400).setHeight(280);
132 |   if (!sheet) { 
133 |     throw new Error('You need to create the Source Data sheet first');
134 |   }
135 |   if (!isValidSheet(sheet)) {
136 |     throw new Error('You must populate the Source Data fields correctly');
137 |   }
138 |   SpreadsheetApp.getUi().showModalDialog(html, 'Select account and property for management');
139 | }
140 | 
141 | function onOpen() {
142 |   SpreadsheetApp.getUi()
143 |       .createMenu('Google Analytics Custom Dimension Manager')
144 |       .addItem('1. Build/reformat Source Data sheet', 'buildSourceSheet')
145 |       .addItem('2. Manage Custom Dimensions', 'openDimensionModal')
146 |       .addToUi();
147 | }
148 | 


--------------------------------------------------------------------------------
/ProcessDimensions.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html>
 3 |   <head>
 4 |     <base target="_top">
 5 |     <link rel="stylesheet" href="https://ssl.gstatic.com/docs/script/css/add-ons1.css">
 6 |     <?!= include('Styles') ?>
 7 |     <script>
 8 |       window.data = <?!= JSON.stringify(data) ?>;
 9 |     </script>
10 |   </head>
11 |   <body>
12 |     <div class="block">
13 |       Processing dimension <span id="current" data-value="1">1</span> / <?= data.limit ?>
14 |     </div>
15 |     <div class="block">
16 |       <table id="dimensions">
17 |         <tr>
18 |           <th>
19 |             Old (Google Analytics)
20 |           </th>
21 |           <th>
22 |           </th>
23 |           <th>
24 |             New (Source Data)
25 |           </th>
26 |         </tr>
27 |         <tr>
28 |           <td>
29 |             Name: <span id="oldName"></span><br/>
30 |             Scope: <span id="oldScope"></span><br/>
31 |             Active: <span id="oldActive"></span>
32 |           </td>
33 |           <td>
34 |             <strong>=></strong>
35 |           </td>
36 |           <td>
37 |             Name: <span id="newName"></span><br/>
38 |             Scope: <span id="newScope"></span><br/>
39 |             Active: <span id="newActive"></span>
40 |           </td>
41 |         </tr>
42 |       </table>
43 |     </div>
44 |     <div class="block" id="warning"></div>
45 |     <div class="block">
46 |       <button id="update" class="create" disabled>Update</button>
47 |       <button id="skip" class="action" disabled>Skip</button>
48 |       <button id="close">Cancel</button>
49 |     </div>    
50 |     <?!= include('ProcessJavaScript') ?>    
51 |   </body>
52 | </html>
53 | 
54 | 
55 | 


--------------------------------------------------------------------------------
/ProcessJavaScript.html:
--------------------------------------------------------------------------------
  1 | <script>
  2 |   (function() {
  3 |     var limit = data.limit;
  4 |     var accountId = data.accountId;
  5 |     var propertyId = data.propertyId;
  6 |     var current = document.querySelector('#current');
  7 |     var oldName = document.querySelector('#oldName');
  8 |     var newName = document.querySelector('#newName');
  9 |     var oldScope = document.querySelector('#oldScope');
 10 |     var newScope = document.querySelector('#newScope');
 11 |     var oldActive = document.querySelector('#oldActive');
 12 |     var newActive = document.querySelector('#newActive');
 13 |     var update = document.querySelector('#update');
 14 |     var skip = document.querySelector('#skip');
 15 |     var close = document.querySelector('#close');
 16 |     var warning = document.querySelector('#warning');
 17 |     var dimensions = data.dimensions;
 18 |     var sourceData = data.sourceData;
 19 |     var i, newI, oDim, nDim;
 20 |     
 21 |     var disableButtons = function() {
 22 |       update.setAttribute('disabled', '');
 23 |       skip.setAttribute('disabled', '');
 24 |     };
 25 |     
 26 |     var enableButtons = function() {
 27 |       update.removeAttribute('disabled');
 28 |       skip.removeAttribute('disabled');
 29 |     };
 30 |     
 31 |     var showError = function(e) {
 32 |       warning.className = 'block error';
 33 |       warning.innerHTML = e.message;
 34 |       close.innerHTML = 'Close';
 35 |     };
 36 |     
 37 |     var isSame = function(oDim, nDim) {
 38 |       return oDim.name === nDim.name &&
 39 |              oDim.scope === nDim.scope &&
 40 |              oDim.active.toString() === nDim.active.toString();
 41 |     };
 42 |     
 43 |     var run = function(i) {
 44 |       var updateDimension, skipDimension, checkClose;
 45 |       oDim = dimensions.items[i];
 46 |       nDim = sourceData[i];
 47 |       newI = i + 1;
 48 |       current.setAttribute('data-value', newI);
 49 |       current.innerHTML = newI;
 50 |       oldName.innerHTML = oDim && oDim.name || '-';
 51 |       oldScope.innerHTML = oDim && oDim.scope || '-';
 52 |       oldActive.innerHTML = oDim && (oDim.active || oDim.active === false) ? oDim.active : '-';
 53 |       newName.innerHTML = nDim.name;
 54 |       newScope.innerHTML = nDim.scope;
 55 |       newActive.innerHTML = nDim.active;
 56 |       
 57 |       checkClose = function() {
 58 |         if (newI < limit) { 
 59 |           run(newI); 
 60 |         } else {
 61 |           close.innerHTML = 'Close';
 62 |           warning.className = 'block';
 63 |           warning.innerHTML = 'All done! You can close this dialog now.';
 64 |         }     
 65 |       };
 66 |       
 67 |       updateDimension = function() {
 68 |         update.removeEventListener('click', updateDimension);
 69 |         skip.removeEventListener('click', skipDimension);
 70 |         disableButtons();
 71 |         warning.className = 'block';
 72 |         warning.innerHTML = 'Updating dimension...';
 73 |         google.script.run.withFailureHandler(showError).withSuccessHandler(checkClose).updateDimension('update', accountId, propertyId, newI, nDim);
 74 |       };
 75 |       
 76 |       skipDimension = function() {
 77 |         update.removeEventListener('click', updateDimension);
 78 |         skip.removeEventListener('click', skipDimension);
 79 |         disableButtons();
 80 |         checkClose();
 81 |       };
 82 |       
 83 |       if (oDim && isSame(oDim, nDim)) {
 84 |         warning.className = 'block';
 85 |         warning.innerHTML = 'Skipping dimension...';
 86 |         window.setTimeout(skipDimension, 100);
 87 |       } else if (oDim) {
 88 |         enableButtons();
 89 |         warning.className = 'block error';
 90 |         warning.innerHTML = 'Dimension already populated. UPDATE to get value from sheet, or SKIP to keep original value.';
 91 |         update.addEventListener('click', updateDimension);
 92 |         skip.addEventListener('click', skipDimension);
 93 |       } else {
 94 |         warning.innerHTML = 'Creating dimension...';
 95 |         warning.className = 'block';
 96 |         disableButtons();
 97 |         google.script.run.withFailureHandler(showError).withSuccessHandler(checkClose).updateDimension('create', accountId, propertyId, newI, nDim);
 98 |       }
 99 |     };
100 |     
101 |     run(0);
102 |       
103 |     close.addEventListener('click', function() {
104 |       google.script.host.close();
105 |     });
106 |   })();
107 | </script>


--------------------------------------------------------------------------------
/PropertySelector.html:
--------------------------------------------------------------------------------
 1 | <!DOCTYPE html>
 2 | <html>
 3 |   <head>
 4 |     <base target="_top">
 5 |     <link rel="stylesheet" href="https://ssl.gstatic.com/docs/script/css/add-ons1.css">
 6 |   </head>
 7 |   <body>
 8 |     <div class="block secondary form-group">
 9 |       To CREATE new dimensions, you need EDIT access in both GA Account and Property.<br/>
10 |       To UPDATE an existing dimension, you need EDIT access in the GA Property.
11 |     </div>
12 |     <div id="fetching" class="block form-group">
13 |       Fetching data...
14 |     </div>
15 |     <div id="accountWrapper" class="block form-group" style="display: none">
16 |       <label for="accounts">Select account</label>
17 |       <select id="accounts"></select>
18 |     </div>
19 |     <div id="propertyWrapper" class="block form-group" style="display: none">
20 |       <label for="property">Select property</label>
21 |       <select id="properties"></select>
22 |     </div>
23 |     <div class="block">
24 |       Process dimensions
25 |       <br/>
26 |       <label>1-20</label>
27 |       <input type="radio" value="20" name="howManyDimensions" checked/>
28 |       <label>1-200</label>
29 |       <input type="radio" value="200" name="howManyDimensions"/>
30 |     </div>
31 |     <div class="block">
32 |       <button class="action" id="start" disabled>Start</button>    
33 |       <button id="close">Close</button>
34 |     </div>
35 |     <?!= include('SelectorJavaScript'); ?>
36 | </body>
37 | </html>
38 | 
39 | 
40 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | # ga-custom-dimension-manager
2 | Custom Dimension Manager for Google Sheets
3 | 


--------------------------------------------------------------------------------
/SelectorJavaScript.html:
--------------------------------------------------------------------------------
 1 | <script>
 2 |   (function() {
 3 |     var accountHierarchy = {};
 4 |     
 5 |     var addProperties = function(e) {
 6 |       var aid = e.value;
 7 |       var propertySelect = document.querySelector('#properties');
 8 |       var start = document.querySelector('#start');
 9 |       var temp;
10 |       propertySelect.disabled = true;
11 |       propertySelect.innerHTML = '';
12 |       start.disabled = true;
13 |       accountHierarchy[aid].webProperties.forEach(function(prop) {
14 |         temp = document.createElement('option');
15 |         temp.value = prop.id;
16 |         temp.innerHTML = prop.name;
17 |         propertySelect.appendChild(temp);
18 |       });
19 |       document.querySelector('#fetching').style.display = 'none';
20 |       document.querySelector('#accountWrapper').style.display = 'block';
21 |       document.querySelector('#propertyWrapper').style.display = 'block';
22 |       propertySelect.disabled = false;
23 |       start.disabled = false;
24 |     };  
25 |     
26 |     var addAccounts = function(accountSummary) {
27 |       var accountSelect = document.querySelector('#accounts');
28 |       var temp;
29 |       accountSummary.items.forEach(function(acct) {
30 |         temp = document.createElement('option');
31 |         temp.value = acct.id;
32 |         temp.innerHTML = acct.name;
33 |         accountSelect.appendChild(temp);
34 |         accountHierarchy[acct.id] = {
35 |           webProperties: acct.webProperties
36 |         };
37 |       });
38 |       accountSelect.addEventListener('change', function(e) {
39 |         addProperties(e.target);
40 |       });
41 |       addProperties(accountSelect.options[accountSelect.selectedIndex]);
42 |     };
43 |     
44 |     google.script.run.withSuccessHandler(addAccounts).fetchAccounts();
45 |     
46 |     document.querySelector('#close').addEventListener('click', function() {
47 |       google.script.host.close();
48 |     });
49 |     
50 |     document.querySelector('#start').addEventListener('click', function() {
51 |       var accounts = document.querySelector('#accounts');
52 |       var properties = document.querySelector('#properties');
53 |       google.script.run
54 |         .withSuccessHandler(function() { google.script.host.close(); })
55 |         .startProcess(
56 |           accounts.options[accounts.selectedIndex].value, 
57 |           properties.options[properties.selectedIndex].value,
58 |           document.querySelector('[name="howManyDimensions"]:checked').value
59 |         );
60 |     });
61 |   })();
62 | </script>


--------------------------------------------------------------------------------
/Styles.html:
--------------------------------------------------------------------------------
 1 | <style>
 2 |   table#dimensions {
 3 |     width: 100%;
 4 |     font-family: Courier;
 5 |   }
 6 |   
 7 |   table#dimensions th {
 8 |     font-weight: bold;
 9 |     width: 175px;
10 |   }
11 |   
12 |   table#dimensions th:nth-child(2) {
13 |     width: 50px;
14 |   }
15 |   
16 |   td span {
17 |     font-weight: bold;
18 |   }
19 |   
20 |   span#current {
21 |     font-weight: bold;
22 |   }
23 | </style>


--------------------------------------------------------------------------------