└── Code.gs


/Code.gs:
--------------------------------------------------------------------------------
  1 | /**
  2 |  * 
  3 |  * Author: Nick Young - @techupover | techupover.com
  4 |  * 
  5 |  * 
  6 |  * CREDITS
  7 |  * Kudos to https://www.pbainbridge.co.uk/2020/06/bulk-create-google-drive-folders-20.html
  8 |  * and various stackoverflow threads for filling in some gaps about how things work
  9 |  */
 10 | 
 11 | /**
 12 |  * 
 13 |  * CHANGE THESE VARIABLES PER YOUR PREFERENCES
 14 |  * 
 15 |  */
 16 | 
 17 | const CUSTOM_MENU_NAME = 'Neat Features'; // the name of the new menu in your google sheet
 18 | const CUSTOM_MENU_ITEM = 'Generate Folders Now'; // the menu item you'll click to run the script
 19 | const DATA_TAB_NAME = 'folder_data'; // name for the sheet tab that contains the folder info that will be created/processed
 20 | const LOG_TAB_NAME = 'log'; // name of the sheet tab that will store the log messages from this script
 21 | const DATE_FORMAT = 'yyyy-MM-dd HH:mm:ss'; // date format to use for the log entries. Probably dont change this unless you really really want to.
 22 | 
 23 | /**
 24 |  * 
 25 |  * DO NOT CHANGE ANYTHING UNDER THIS LINE
 26 |  * 
 27 |  * ONLY CHANGE THINGS IN THE CONFIG.GS FILE
 28 |  * 
 29 |  */
 30 | 
 31 | /**
 32 |  * When the spreadsheet is open, add a custom menu
 33 |  */
 34 | function onOpen() {
 35 |   var spreadsheet = SpreadsheetApp.getActive();
 36 |   var customMenuItems = [
 37 |     {name: CUSTOM_MENU_ITEM, functionName: 'processGoogleSheetData_'}
 38 |   ];
 39 |   spreadsheet.addMenu(CUSTOM_MENU_NAME, customMenuItems);
 40 | }
 41 | 
 42 | /**
 43 | * Bulk create Google Folders from data within a Google Sheet.
 44 | * This is the function to call from the custom menu item.
 45 | * Others are referenced by this one.
 46 | */
 47 | function processGoogleSheetData_() {
 48 |   
 49 |   // get current spreadsheet
 50 |   var ss = SpreadsheetApp.getActiveSpreadsheet();
 51 | 
 52 |   // Log starting of the script
 53 |   logEventToGoogleSheet('Script has started');
 54 | 
 55 |   // display Toast notification
 56 |   ss.toast('Starting!!!', 'Yep, we are starting...now.');
 57 |   
 58 |   // get TimeZone
 59 |   var timeZone = ss.getSpreadsheetTimeZone();
 60 |   
 61 |   // get Data sheet
 62 |   var dataSheet = ss.getSheetByName(DATA_TAB_NAME);
 63 |   
 64 |   // get all data as a 2-D array
 65 |   var data = dataSheet.getDataRange().getValues();
 66 |   
 67 |   // create a name:value pair array to send the data to the next Function
 68 |   var spreadsheetData = {ss:ss, timeZone:timeZone, dataSheet:dataSheet, data:data};
 69 |   
 70 |   // run Function to create Google Folders
 71 |   var doCreateFolders = createFolders(spreadsheetData);
 72 |   
 73 |   // check success status
 74 |   if (doCreateFolders) {
 75 |     // display Toast notification
 76 |     ss.toast('Script complete', 'Finished');
 77 |   }
 78 |   else {
 79 |     // script completed with error
 80 |     // display Toast notification
 81 |     ss.toast('Got some errors. Check the logs', 'Finished');
 82 |   }
 83 |   
 84 |   // Log starting of the script
 85 |   logEventToGoogleSheet('Script finished');
 86 |   
 87 |   
 88 | }
 89 | 
 90 | 
 91 | /**
 92 | * Loop through each row and create folders, set permissions
 93 | */
 94 | function createFolders(spreadsheetData) {
 95 |   
 96 |   // extract data from name:value pair array
 97 |   var ss = spreadsheetData['ss'];
 98 |   var timeZone = spreadsheetData['timeZone'];
 99 |   var dataSheet = spreadsheetData['dataSheet']; 
100 |   var data = spreadsheetData['data'];
101 | 
102 |   // get last row number so we know when to end the loop
103 |   var lastRow = dataSheet.getLastRow();
104 | 
105 |   var folderIdMap = new Object();
106 | 
107 |   // start of loop to go through each row iteratively
108 |   for (var i=1; i<lastRow; i++) {
109 |     
110 |     // extract values from row of data for easier reference below
111 |     var rootFolderId = data[i][0];
112 |     var templateDocId = data[i][1]
113 |     var newFolderName = data[i][2];
114 |     var parentFolderName = data[i][3];
115 |     var folderId = data[i][4];
116 |     var permissionEmailViewer = data[i][5];
117 |     var permissionEmailEditor = data[i][6];
118 |     
119 |     // only perform this row if the folder ID is blank
120 |     if(folderId == '') {
121 | 
122 |       // if the sheet doesn't have a specified parent folder name, then it goes in the root.
123 |       // if the parent folder name is supplied then it had to have been created by this script, 
124 |       // so get it from script properties (where the ID is saved during an earlier loop)
125 |       if(parentFolderName == '') {
126 |         destinationFolderId = rootFolderId;
127 |         
128 |       } else {
129 |         
130 |         var thisMapKey = createMapString(rootFolderId + '___' + parentFolderName);
131 |         var destinationFolderId = folderIdMap[thisMapKey];
132 |         
133 |       }
134 |       
135 |       // display Toast notification
136 |       ss.toast(newFolderName, 'Creating New Folder');
137 | 
138 |       // run Function to create Google Folder and return its URL/ID
139 |       var folderDetails = createFolder(newFolderName, destinationFolderId);
140 | 
141 |       // check new Folder created successfully
142 |       if (folderDetails) {
143 | 
144 |         // extract Url/Id for easier reference later
145 |         var newFolderUrl = folderDetails['newFolderUrl'];
146 |         var newFolderId = folderDetails['newFolderId'];
147 | 
148 |         //push the key/folder id to the array map so we can use it later in the loop
149 |         var thisMapKey = createMapString(destinationFolderId + '___' + newFolderName);
150 |         folderIdMap[thisMapKey] = newFolderId;
151 | 
152 |         // copy the template doc into the new directory (if specified)
153 |         if(templateDocId != '') {
154 |           makeCopy(templateDocId, newFolderId, newFolderName + ' Template Document');
155 |         } 
156 |                 
157 |         // set the Folder ID value in the google sheet, inserting it as a link
158 |         var newFolderLink = '=HYPERLINK("' + newFolderUrl + '","' + newFolderName + '")';
159 |         dataSheet.getRange(i+1, 5).setFormula(newFolderLink);
160 |         
161 |         // check if Viewer Permissions need adding - if there are emails in the column for this row
162 |         if (permissionEmailViewer != '') { 
163 |           
164 |           // run Function to add Folder permissions
165 |           var currentRow = i+1;
166 |           var addPermissionsFlag = addPermissions('VIEWER', timeZone, dataSheet, permissionEmailViewer,
167 |                                                   newFolderId, currentRow, 8);
168 |           
169 |           // if problem adding Permissions return for status message
170 |           if (addPermissionsFlag == false) {
171 |             // display Toast notification and return false flag
172 |             ss.toast('Error when adding Viewer Permissions to: ' + newFolderName, 'Error');
173 |             return false;
174 |           }
175 |           
176 |         }
177 | 
178 |         // check if Editor Permissions need adding - if there are emails in the column for this row
179 |         if (permissionEmailEditor != '') { 
180 |           
181 |           // run Function to add Folder permissions
182 |           var currentRow = i+1;
183 |           var addPermissionsFlag = addPermissions('EDITOR', timeZone, dataSheet, permissionEmailEditor,
184 |                                                   newFolderId, currentRow, 9);
185 |           
186 |           // if problem adding Permissions return for status message
187 |           if (addPermissionsFlag == false) {
188 |             // display Toast notification and return false flag
189 |             ss.toast('Error when adding EDITOR Permissions to: ' + newFolderName, 'Error');
190 |             return false;
191 |           }
192 |           
193 |         }
194 |         
195 |         // write all pending updates to the google sheet using flush() method
196 |         SpreadsheetApp.flush();
197 |         
198 |       } else {
199 |         // write error into 'Permission Added?' cell and return false value
200 |         dataSheet.getRange(i+1, 4).setValue('Error creating folder. Please see Logs');
201 |         // new Folder not created successfully
202 |         return false;
203 |       }
204 | 
205 |     } else {
206 | 
207 |       ss.toast('Skipping Row - Folder ID already set', 'Moving onto the next row to process');
208 | 
209 |     }
210 |     
211 |   } // end of loop to go through each row in turn **********************************
212 |   
213 |   // completed successfully
214 |   return true;
215 |   
216 |   
217 | }
218 | 
219 | function makeCopy(sourceDocumentId, destinationFolderId, destinationFileName) {
220 | 
221 |   var destinationFolder = DriveApp.getFolderById(destinationFolderId);
222 |   
223 |   return DriveApp.getFileById(sourceDocumentId).makeCopy(destinationFileName,destinationFolder);
224 | 
225 | }
226 | 
227 | 
228 | /**
229 |  * Function to create new Google Drive Folder and return details (url, id)
230 | */
231 | 
232 | function createFolder(folderName, destinationFolderId) {
233 |   
234 |   try {
235 |     // get destination Folder
236 |     var destinationFolder = DriveApp.getFolderById(destinationFolderId);
237 |   }
238 |   catch(e) {
239 |     logEventToGoogleSheet('Error getting destination folder: ' + e + e.stack);
240 |     var destinationFolder = false;
241 |   }
242 |   
243 |   
244 |   // proceed if successfully got destination folder
245 |   if (destinationFolder) {
246 |     var documentProperties = PropertiesService.getDocumentProperties();
247 |     
248 |     try {
249 |       // create new Folder in destination
250 |       var newFolder = destinationFolder.createFolder(folderName);
251 |       // get new Drive Folder Url/Id and return to Parent Function
252 |       var newFolderUrl = newFolder.getUrl();
253 |       var newFolderId = newFolder.getId();
254 |       var folderDetails = {newFolderUrl:newFolderUrl, newFolderId:newFolderId};
255 |       
256 |       return folderDetails;
257 |     }
258 |     catch(e) {
259 |       logEventToGoogleSheet('Error creating new Folder: ' + e + e.stack);
260 |       return false;
261 |     }
262 |   }
263 |   else {
264 |     // return false as unable to get destination folder
265 |     return false;
266 |   }
267 | }
268 | 
269 | 
270 | /**
271 |  * Function to add permissions to each Folder using the provided email address(es).
272 |  * 
273 |  * role var can be either VIEWER or EDITOR
274 | */
275 | 
276 | function addPermissions(role, timeZone, dataSheet, permissionEmail, newFolderId, currentRow, permAddedCol) {
277 |   
278 |   // split up email address array to be able to loop through them separately
279 |   var emailAddresses = permissionEmail.split(',');
280 |   logEventToGoogleSheet(role + ' emailAddress array is: ' + emailAddresses);
281 |   
282 |   // get length of array for loop
283 |   var emailAddressesLength = emailAddresses.length;
284 |   
285 |   
286 |   try {
287 |     // get Google Drive Folder
288 |     var newFolder = DriveApp.getFolderById(newFolderId);
289 |   }
290 |   catch(e) {
291 |     logEventToGoogleSheet('Error getting destination folder: ' + e + e.stack);
292 |     var newFolder = false;
293 |   }
294 |   
295 |   
296 |   // proceed if successfully got destination folder
297 |   if (newFolder) {
298 |     
299 |     // loop through each email address and add as 'Editor' *******************
300 |     for (var i=0; i<emailAddressesLength; i++) {
301 |       
302 |       var emailAddress = emailAddresses[i].trim();
303 |       logEventToGoogleSheet(role + ' emailAddress for adding permission is: ' + emailAddress);
304 |       
305 |       try {
306 |         
307 |         if(role == 'VIEWER') {
308 | 
309 |           logEventToGoogleSheet('Adding ' + emailAddress + ' as ' + role);
310 |           newFolder.addViewer(emailAddress);
311 |           var success = true;
312 | 
313 |         } 
314 | 
315 |         if(role == 'EDITOR') {
316 | 
317 |           logEventToGoogleSheet('Adding ' + emailAddress + ' as ' + role);
318 |           newFolder.addEditor(emailAddress);
319 |           var success = true;
320 | 
321 |         }
322 |         // add 'Edit' permission using email address
323 | 
324 |         if (success) {
325 |           // write timestamp into 'Permission Added?' cell
326 |           var date = new Date;
327 |           var timeStamp = Utilities.formatDate(date, timeZone, DATE_FORMAT);
328 |           dataSheet.getRange(currentRow, permAddedCol).setValue(timeStamp);
329 |         }
330 |         else {
331 |           // write error into 'Permission Added?' cell and return false value
332 |           dataSheet.getRange(currentRow, permAddedCol).setValue('Error adding ' + role + ' permission. Please see Logs');
333 |           return false;
334 |         }
335 |         
336 |       }
337 |       catch(e) {
338 |         logEventToGoogleSheet('Error adding ' + role + ' permission: ' + e + e.stack);
339 |       }
340 |       
341 |     }
342 |     
343 |   }
344 |   else {
345 |     // write error into cell and return false value
346 |     dataSheet.getRange(currentRow, permAddedCol).setValue('Error getting folder. Please see Logs');
347 |     // return false as unable to get Google Drive Folder
348 |     return false;
349 |   }
350 |   
351 |   
352 |   // return true as all permissions added successfully
353 |   return true;
354 |   
355 |   
356 | }
357 | 
358 | 
359 | /** 
360 | * Write log message to Google Sheet
361 | */
362 | 
363 | function logEventToGoogleSheet(text_to_log) {
364 |   
365 |   // get the user running the script
366 |   var activeUserEmail = Session.getActiveUser().getEmail();
367 |   
368 |   // get the relevant spreadsheet to output log details
369 |   var ss = SpreadsheetApp.getActiveSpreadsheet();
370 |   var googleSheet = ss.getSheetByName(LOG_TAB_NAME);
371 |   
372 |   // create and format a timestamp
373 |   var now = new Date();
374 |   var timeZone = ss.getSpreadsheetTimeZone();
375 |   var niceDateTime = Utilities.formatDate(now, timeZone, DATE_FORMAT);
376 |   
377 |   // create array of data for pasting into log sheet
378 |   var logData = [niceDateTime, activeUserEmail, text_to_log];
379 |   
380 |   // append details into next row of log sheet
381 |   googleSheet.appendRow(logData);
382 |   
383 | }
384 | 
385 | /**
386 |  * Create a string that can easily be used as an object/array key for reference
387 |  * during the create folder loop. (Helps with identifying the parent folder dynamically)
388 |  */
389 | function createMapString(input_string) {
390 | 
391 |   return input_string.replace(/\W/g, '');
392 | 
393 | }
394 | 


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