Google Apps Scriptで共有ドライブをコントロールする

G Suite for Business以上には、Google Driveをファイルサーバのように扱える「Team Drive」こと「共有ドライブ」という機能があります。チームやプロジェクト単位で共有するドライブで、誰が見ても同じフォルダ・ファイル構成で、オーナーは特定個人ではなくチームドライブ自身がオーナーになるため、ファイルサーバから移行がしやすい機能ですね。

さて、このチームドライブですが、Google Apps Scriptから「作成」やファイルの移動が出来るのですが、これまでのようなDriveAppで単純に操作ができません。使えないわけではないのですが、以上のようなチームドライブの特性上そのままだと一部、操作ができないようになっている為です。

今回のまとめは、Google Apps Scriptからチームドライブを操作する一連の作業となります。

難易度：

リンク

1 今回使用するスプレッドシート
2 事前準備
- 2.1 Drive APIを有効にする
- 2.2 権限一覧を整備する
3 ソースコード
4 関連リンク
- 4.1 関連記事

今回使用するスプレッドシート

チームドライブ操作あれこれシート

事前準備

Drive APIを有効にする

今回のスクリプトはDrive API v2を利用します。よって、以下の手順に従って、Drive APIをONにする必要性があります。

スクリプトエディター画面に於いて、メニューの「リソース」⇒「Googleの拡張サービス」を開く
Drive APIを探しだして、トグルをONにする

これでDrive APIがGoogle Apps ScriptでDrive APIを使えるようになります。場合によっては、Cloud Console側でもONにし、プロジェクト番号を紐つける必要性もあります。紐付け作業はこちらのページを参考にしてみてください。

図：Drive APIをオンにした

権限一覧を整備する

チームドライブにメンバーを追加や権限付与する場合には、スプレッドシートの権限一覧シートに於いてメンバーのメアド、権限を選択して整備する必要があります。この時、権限ですが、以下の通りとなります。

organizer : 管理者
fileOrganizer : コンテンツ管理者
writer : 投稿者
commenter : 閲覧者(コメント可)
reader : 閲覧者

管理者は複数設定できます。但し、1人に与えられる権限は1個です。

ソースコード

新規作成

//共有ドライブを作る
function createTeamDrive() {
  var ui = SpreadsheetApp.getUi();
  
  var ret = ui.prompt("作成するチームドライブの名称を入力してください。", 
      ui.ButtonSet.OK_CANCEL);

  //押されたボタンによって処理を分岐
  switch(ret.getSelectedButton()){
    //OKボタンを押した時の処理
    case ui.Button.OK:
      var str = ret.getResponseText();
      var teamDrive = Drive.Drives.insert({name:str}, Utilities.getUuid())
      Logger.log(teamDrive);
      ui.alert("作成完了しました。")
      break;
    //キャンセルを押した時の処理
    case ui.Button.CANCEL:
      ui.alert("何もせずに閉じました。");
      break;
    case ui.Button.CLOSE:
      break;
  }
}

//共有ドライブを作る

function createTeamDrive() {

var ui = SpreadsheetApp.getUi();

var ret = ui.prompt("作成するチームドライブの名称を入力してください。",

ui.ButtonSet.OK_CANCEL);

//押されたボタンによって処理を分岐

switch(ret.getSelectedButton()){

//OKボタンを押した時の処理

case ui.Button.OK:

var str = ret.getResponseText();

var teamDrive = Drive.Drives.insert({name:str}, Utilities.getUuid())

Logger.log(teamDrive);

ui.alert("作成完了しました。")

break;

//キャンセルを押した時の処理

case ui.Button.CANCEL:

ui.alert("何もせずに閉じました。");

break;

case ui.Button.CLOSE:

break;

}

チームドライブを直接作成するコードです。
変数teamDriveには、ドライブのIDなどの情報が返ってきます。
ドライブのIDといっても、通常のフォルダと同じで、ドライブ直下のディレクトリのIDと同じです。
名前を指定して作成を実行するだけです。

共有権限一覧取得

//共有ドライブの権限一覧を取得する
function getTeamDrivePermissions(){
  var ui = SpreadsheetApp.getUi();
  
  var ret = ui.prompt("調べるチームドライブのIDを入力", 
      ui.ButtonSet.OK_CANCEL);

  //押されたボタンによって処理を分岐
  switch(ret.getSelectedButton()){
    //OKボタンを押した時の処理
    case ui.Button.OK:
      var str = ret.getResponseText();
      var id = str;
      break;
    //キャンセルを押した時の処理
    case ui.Button.CANCEL:
      ui.alert("何もせずに閉じました。");
      break;
    case ui.Button.CLOSE:
      break;
  }

  //変数の宣言
  var permissions ;
  var pageToken;
  
  //メンバーと権限の一覧を取得する
  var roles = "";
  do{
    //supportsAllDrives:trueを入れないと動かない。けれどこのオプションはDeprecatedに指定されているという（なのでTrueにしておく）
    permissions = Drive.Permissions.list(id, {maxResults:20,pageToken:pageToken,supportsAllDrives:true}) ;
    if(permissions.items && permissions.items.length > 0){
      for (var i = 0; i < permissions.items.length; i++) {
        //権限情報を取得して変数に格納
        var permission = permissions.items[i];
        roles += permission.emailAddress + " : " + permission.role + "\n";
      }
    }else{
      Logger.log("権限は見つかりませんでした。");
    }
    
    //次のページのpageTokenを取得する
    pageToken = permissions.nextPageToken
  }while(pageToken)
  
  //権限一覧を表示
  ui.alert(roles);
  
}

//共有ドライブの権限一覧を取得する

function getTeamDrivePermissions(){

var ui = SpreadsheetApp.getUi();

var ret = ui.prompt("調べるチームドライブのIDを入力",

ui.ButtonSet.OK_CANCEL);

//押されたボタンによって処理を分岐

switch(ret.getSelectedButton()){

//OKボタンを押した時の処理

case ui.Button.OK:

var str = ret.getResponseText();

var id = str;

break;

//キャンセルを押した時の処理

case ui.Button.CANCEL:

ui.alert("何もせずに閉じました。");

break;

case ui.Button.CLOSE:

break;

}

//変数の宣言

var permissions ;

var pageToken;

//メンバーと権限の一覧を取得する

var roles = "";

do{

//supportsAllDrives:trueを入れないと動かない。けれどこのオプションはDeprecatedに指定されているという（なのでTrueにしておく）

permissions = Drive.Permissions.list(id, {maxResults:20,pageToken:pageToken,supportsAllDrives:true}) ;

if(permissions.items && permissions.items.length > 0){

for (var i = 0; i < permissions.items.length; i++) {

//権限情報を取得して変数に格納

var permission = permissions.items[i];

roles += permission.emailAddress + " : " + permission.role + "\n";

}

}else{

Logger.log("権限は見つかりませんでした。");

}

//次のページのpageTokenを取得する

pageToken = permissions.nextPageToken

}while(pageToken)

//権限一覧を表示

ui.alert(roles);

}

対象のチームドライブ上に設定されている権限（メアドと権限名）を返します。

図：権限の一覧がダイアログで表示される

チームドライブ一覧

//チームドライブの一覧を取得する（ID含む）
function adminListAllTeamDrives(){
  //変数の宣言
  var pageToken;
  var teamDrives;
  
  //管理者リストを取得する
  var drives = "";
  do{
    teamDrives = Drive.Drives.list({pageToken:pageToken,maxResults:50,useDomainAdminAccess:true})
    if(teamDrives.items && teamDrives.items.length > 0){
      for (var i = 0; i < teamDrives.items.length; i++) {
        //ドライブ一覧情報を変数に格納する
        var teamDrive = teamDrives.items[i];
        drives += teamDrive.name + " : " + teamDrive.id + "\n";
      }
    }else{
      Logger.log("権限が見つかりませんでした。");
    }
    
    //次のページのpageTokenを取得する
    pageToken = teamDrives.nextPageToken
  }while(pageToken)
  
  //チームドライブ一覧表示
  SpreadsheetApp.getUi().alert(drives);

}

//チームドライブの一覧を取得する（ID含む）

function adminListAllTeamDrives(){

//変数の宣言

var pageToken;

var teamDrives;

//管理者リストを取得する

var drives = "";

do{

teamDrives = Drive.Drives.list({pageToken:pageToken,maxResults:50,useDomainAdminAccess:true})

if(teamDrives.items && teamDrives.items.length > 0){

for (var i = 0; i < teamDrives.items.length; i++) {

//ドライブ一覧情報を変数に格納する

var teamDrive = teamDrives.items[i];

drives += teamDrive.name + " : " + teamDrive.id + "\n";

}

}else{

Logger.log("権限が見つかりませんでした。");

}

//次のページのpageTokenを取得する

pageToken = teamDrives.nextPageToken

}while(pageToken)

//チームドライブ一覧表示

SpreadsheetApp.getUi().alert(drives);

}

現在用意されているチームドライブの一覧（名前とID）を返します。

チームドライブ管理者一覧

//共有ドライブの管理者権限持ってる人リストを取得する
function adminGetTeamDrivePermissions(){
  var ui = SpreadsheetApp.getUi();
  
  var ret = ui.prompt("調査するチームドライブのIDを入れてください。", 
      ui.ButtonSet.OK_CANCEL);

  //押されたボタンによって処理を分岐
  switch(ret.getSelectedButton()){
    //OKボタンを押した時の処理
    case ui.Button.OK:
      var id = ret.getResponseText();
      break;
    //キャンセルを押した時の処理
    case ui.Button.CANCEL:
      ui.alert("何もせずに閉じました。");
      break;
    case ui.Button.CLOSE:
      break;
  }
  
  //変数の宣言
  var permissions ;
  var pageToken;
  
  //管理者一覧を取得する
  var admins = "";
  do{
    permissions = Drive.Permissions.list(id, {maxResults:20,pageToken:pageToken,supportsAllDrives:true,useDomainAdminAccess:true}) ;
    if(permissions.items && permissions.items.length > 0){
      for (var i = 0; i < permissions.items.length; i++) {
        //管理者権限一覧を変数に格納する
        var permission = permissions.items[i];
        admins += permission.emailAddress + " : " + permission.role + "\n";
      }
    }else{
      Logger.log("権限が見つかりませんでした。");
    }
    
    //次のページのpageTokenを取得する
    pageToken = permissions.nextPageToken;
  }while(pageToken)
  
  //権限一覧を表示する
  ui.alert(admins);
  
}

//共有ドライブの管理者権限持ってる人リストを取得する

function adminGetTeamDrivePermissions(){

var ui = SpreadsheetApp.getUi();

var ret = ui.prompt("調査するチームドライブのIDを入れてください。",

ui.ButtonSet.OK_CANCEL);

//押されたボタンによって処理を分岐

switch(ret.getSelectedButton()){

//OKボタンを押した時の処理

case ui.Button.OK:

var id = ret.getResponseText();

break;

//キャンセルを押した時の処理

case ui.Button.CANCEL:

ui.alert("何もせずに閉じました。");

break;

case ui.Button.CLOSE:

break;

}

//変数の宣言

var permissions ;

var pageToken;

//管理者一覧を取得する

var admins = "";

do{

permissions = Drive.Permissions.list(id, {maxResults:20,pageToken:pageToken,supportsAllDrives:true,useDomainAdminAccess:true}) ;

if(permissions.items && permissions.items.length > 0){

for (var i = 0; i < permissions.items.length; i++) {

//管理者権限一覧を変数に格納する

var permission = permissions.items[i];

admins += permission.emailAddress + " : " + permission.role + "\n";

}

}else{

Logger.log("権限が見つかりませんでした。");

}

//次のページのpageTokenを取得する

pageToken = permissions.nextPageToken;

}while(pageToken)

//権限一覧を表示する

ui.alert(admins);

}

対象のチームドライブに管理者権限を持っている人の一覧を返します。

チームドライブに権限付与

//共有ドライブにメンバーと権限を追加する
function setPermissions(){
  var ui = SpreadsheetApp.getUi();
  
  var ret = ui.prompt("権限追加するチームドライブのIDを入力してください。", 
      ui.ButtonSet.OK_CANCEL);

  //押されたボタンによって処理を分岐
  switch(ret.getSelectedButton()){
    //OKボタンを押した時の処理
    case ui.Button.OK:
      var id = ret.getResponseText();
      break;
    //キャンセルを押した時の処理
    case ui.Button.CANCEL:
      ui.alert("何もせずに閉じました。");
      break;
    case ui.Button.CLOSE:
      break;
  }

  //シートの権限一覧からrolesを生成
  var roles = {};
  var temparr = [];
  var list = ["organizer","fileOrganizer","writer","commenter","reader"];
  
  //スプレッドシートのデータを取得
  var ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("権限一覧").getRange("A2:B").getValues();
  var length = ss.length;
    
  for(var i = 0;i<list.length;i++){
    //一時配列初期化
    temparr = [];
  
    //キー名を取得
    var keyman = list[i];
    
    //スプレッドシートデータを探索
    for(var j = 0;j<length;j++){
      if(ss[j][1] == ""){
        //権限が付与されていないレコードをスルー
        continue;
      }
      
      //対象のレコードが対象の権限名ならばpushする
      if(ss[j][1] == keyman){
        //配列にpushする
        temparr.push(ss[j][0]);
      }
    }
    
    //一時配列のlengthが0だったら処理をスルー
    if(temparr.length > 0){
      //rolesにkeyと配列を追加
      roles[keyman] = temparr;
    }else{
      //処理をスルーする
      continue;
    }
  }

  //ロールの分だけループを回してキーを取得
  for(var key in roles){
    var role = roles[key];
    
    //キーに指定したメンバー分設定を付ける
    role.forEach(function (email){
      var resource = {
        role: key,
        type:"user",
        value:email
      }
      
      //commenterというキーの時は、reader権限も付与する（でないとコメントできないからね）
      if(key == "commenter"){
        resource.role = "reader";
        resource.additionalRoles = ["commenter"]
      }
      
      //本人に通知なしで共有設定を追加する
      Drive.Permissions.insert(resource, id, {sendNotificationEmails:false,supportsAllDrives:true,useDomainAdminAccess:false});
    });
  }
  
  //メッセージを表示
  ui.alert("権限付与が完了しました。")
  
}

//共有ドライブにメンバーと権限を追加する

function setPermissions(){

var ui = SpreadsheetApp.getUi();

var ret = ui.prompt("権限追加するチームドライブのIDを入力してください。",

ui.ButtonSet.OK_CANCEL);

//押されたボタンによって処理を分岐

switch(ret.getSelectedButton()){

//OKボタンを押した時の処理

case ui.Button.OK:

var id = ret.getResponseText();

break;

//キャンセルを押した時の処理

case ui.Button.CANCEL:

ui.alert("何もせずに閉じました。");

break;

case ui.Button.CLOSE:

break;

}

//シートの権限一覧からrolesを生成

var roles = {};

var temparr = [];

var list = ["organizer","fileOrganizer","writer","commenter","reader"];

//スプレッドシートのデータを取得

var ss = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("権限一覧").getRange("A2:B").getValues();

var length = ss.length;

for(var i = 0;i<list.length;i++){

//一時配列初期化

temparr = [];

//キー名を取得

var keyman = list[i];

//スプレッドシートデータを探索

for(var j = 0;j<length;j++){

if(ss[j][1] == ""){

//権限が付与されていないレコードをスルー

continue;

}

//対象のレコードが対象の権限名ならばpushする

if(ss[j][1] == keyman){

//配列にpushする

temparr.push(ss[j][0]);

}

//一時配列のlengthが0だったら処理をスルー

if(temparr.length > 0){

//rolesにkeyと配列を追加

roles[keyman] = temparr;

}else{

//処理をスルーする

continue;

}

//ロールの分だけループを回してキーを取得

for(var key in roles){

var role = roles[key];

//キーに指定したメンバー分設定を付ける

role.forEach(function (email){

var resource = {

role: key,

type:"user",

value:email

}

//commenterというキーの時は、reader権限も付与する（でないとコメントできないからね）

if(key == "commenter"){

resource.role = "reader";

resource.additionalRoles = ["commenter"]

}

//本人に通知なしで共有設定を追加する

Drive.Permissions.insert(resource, id, {sendNotificationEmails:false,supportsAllDrives:true,useDomainAdminAccess:false});

});

}

//メッセージを表示

ui.alert("権限付与が完了しました。")

}

対象のチームドライブに権限付与・新規メンバーの追加を行います。
スプレッドシートの権限一覧シートから設定を行います。

チームドライブにファイル作成

//新規にファイルを作ることは出来る。
function creatNewFile() {
  var ui = SpreadsheetApp.getUi();
  
  var ret = ui.prompt("作成するフォルダのIDを入力", 
      ui.ButtonSet.OK_CANCEL);

  //押されたボタンによって処理を分岐
  switch(ret.getSelectedButton()){
    //OKボタンを押した時の処理
    case ui.Button.OK:
      var folderid = ret.getResponseText();
      break;
    //キャンセルを押した時の処理
    case ui.Button.CANCEL:
      ui.alert("何もせずに閉じました。");
      break;
    case ui.Button.CLOSE:
      break;
  }

  //新規にからのスプレッドシートを作成
  var ss = SpreadsheetApp.create("すぷれっどしーと新規SS").getId();
  
  //ファイルのIDとフォルダを取得する
  var file = DriveApp.getFileById(ss);
  var targetFolder = DriveApp.getFolderById(folderid);
  
  //共有ドライブに移動する
  targetFolder.addFile(file);
  
  //終了メッセージ
  ui.alert("ファイルが作成されました。");
}

//新規にファイルを作ることは出来る。

function creatNewFile() {

var ui = SpreadsheetApp.getUi();

var ret = ui.prompt("作成するフォルダのIDを入力",

ui.ButtonSet.OK_CANCEL);

//押されたボタンによって処理を分岐

switch(ret.getSelectedButton()){

//OKボタンを押した時の処理

case ui.Button.OK:

var folderid = ret.getResponseText();

break;

//キャンセルを押した時の処理

case ui.Button.CANCEL:

ui.alert("何もせずに閉じました。");

break;

case ui.Button.CLOSE:

break;

}

//新規にからのスプレッドシートを作成

var ss = SpreadsheetApp.create("すぷれっどしーと新規SS").getId();

//ファイルのIDとフォルダを取得する

var file = DriveApp.getFileById(ss);

var targetFolder = DriveApp.getFolderById(folderid);

//共有ドライブに移動する

targetFolder.addFile(file);

//終了メッセージ

ui.alert("ファイルが作成されました。");

}

通常のドライブと同じく、DriveAppにて新規ファイル作成が可能です。
ただし、ファイルのremoveやaddは使えません。あくまでも新規作成だけです。

チームドライブにフォルダコピー

//Google Driveから共有ドライブへコピーする
function moveTeamDrive() { 
  var ui = SpreadsheetApp.getUi();
  
  var ret = ui.prompt("移動元のGoogle DriveのフォルダのIDを入れてください", 
      ui.ButtonSet.OK_CANCEL);

  //押されたボタンによって処理を分岐
  switch(ret.getSelectedButton()){
    //OKボタンを押した時の処理
    case ui.Button.OK:
      var sourceFolder = ret.getResponseText();
      break;
    //キャンセルを押した時の処理
    case ui.Button.CANCEL:
      ui.alert("何もせずに閉じました。");
      break;
    case ui.Button.CLOSE:
      break;
  }

  var ret = ui.prompt("移動先のチームドライブのフォルダのIDを入れてください。", 
      ui.ButtonSet.OK_CANCEL);

  //押されたボタンによって処理を分岐
  switch(ret.getSelectedButton()){
    //OKボタンを押した時の処理
    case ui.Button.OK:
      var targetFolder = ret.getResponseText();
      break;
    //キャンセルを押した時の処理
    case ui.Button.CANCEL:
      ui.alert("何もせずに閉じました。");
      break;
    case ui.Button.CLOSE:
      break;
  }
  
  //フォルダを取得
  var source = DriveApp.getFolderById(sourceFolder);
  var target = DriveApp.getFolderById(targetFolder);

  //コピー開始
  copyFolder(source, target);
  
  //終了メッセージ
  ui.alert("コピー完了しました");
  
}

//コピーを作るメインルーチン（サブフォルダまで対応）
function copyFolder(source, target) {
  var folders = source.getFolders();
  var files   = source.getFiles();

  while(files.hasNext()) {
    var file = files.next();
    file.makeCopy(file.getName(), target);
  }

  while(folders.hasNext()) {
    var subFolder = folders.next();
    var folderName = subFolder.getName();
    var targetFolder = target.createFolder(folderName);
    copyFolder(subFolder, targetFolder);
  }  
}

//Google Driveから共有ドライブへコピーする

function moveTeamDrive() {

var ui = SpreadsheetApp.getUi();

var ret = ui.prompt("移動元のGoogle DriveのフォルダのIDを入れてください",

ui.ButtonSet.OK_CANCEL);

//押されたボタンによって処理を分岐

switch(ret.getSelectedButton()){

//OKボタンを押した時の処理

case ui.Button.OK:

var sourceFolder = ret.getResponseText();

break;

//キャンセルを押した時の処理

case ui.Button.CANCEL:

ui.alert("何もせずに閉じました。");

break;

case ui.Button.CLOSE:

break;

}

var ret = ui.prompt("移動先のチームドライブのフォルダのIDを入れてください。",

ui.ButtonSet.OK_CANCEL);

//押されたボタンによって処理を分岐

switch(ret.getSelectedButton()){

//OKボタンを押した時の処理

case ui.Button.OK:

var targetFolder = ret.getResponseText();

break;

//キャンセルを押した時の処理

case ui.Button.CANCEL:

ui.alert("何もせずに閉じました。");

break;

case ui.Button.CLOSE:

break;

}

//フォルダを取得

var source = DriveApp.getFolderById(sourceFolder);

var target = DriveApp.getFolderById(targetFolder);

//コピー開始

copyFolder(source, target);

//終了メッセージ

ui.alert("コピー完了しました");

}

//コピーを作るメインルーチン（サブフォルダまで対応）

function copyFolder(source, target) {

var folders = source.getFolders();

var files = source.getFiles();

while(files.hasNext()) {

var file = files.next();

file.makeCopy(file.getName(), target);

}

while(folders.hasNext()) {

var subFolder = folders.next();

var folderName = subFolder.getName();

var targetFolder = target.createFolder(folderName);

copyFolder(subFolder, targetFolder);

}

これがちょっとややこしく、素直にDriveAppで.addメソッドで行おうとすると失敗します。
makeCopyメソッドで複製させます。
移動の場合は、複製後に移動元のファイルをremoveすればOK
今回のメソッドはフォルダ構造維持してまるごとコピーします。

チームドライブにファイル移動や削除

GASだけでチームドライブの間でファイルの移動ができるか？といったら答えはNoです。新規に作る分にはDriveAppが使えますが。チームドライブのファイルの編集自体はDrive APIを介して行う事ができます。

//チームドライブ内のファイルの削除
Drive.Files.remove(fileid, {supportsTeamDrives:true});

//チームドライブへファイルを移動
function moveFileToFolder(fileid, targetfolderid) {  
  var file = Drive.Files.get(fileid, {supportsTeamDrives: true});

  Drive.Files.patch(file, fileid, {
    removeParents: file.parents.map(function(f) { return f.id; }),
    addParents: [targetfolderid],
    supportsTeamDrives: true
  });
}

//チームドライブ内のファイルの削除

Drive.Files.remove(fileid, {supportsTeamDrives:true});

//チームドライブへファイルを移動

function moveFileToFolder(fileid, targetfolderid) {

var file = Drive.Files.get(fileid, {supportsTeamDrives: true});

Drive.Files.patch(file, fileid, {

removeParents: file.parents.map(function(f) { return f.id; }),

addParents: [targetfolderid],

supportsTeamDrives: true

});

}

この方法では、コピーではなく移動ができています。なので、ファイルのIDが変更されることがありません。
ファイルの削除も編集作業なので、Drive APIを用いて行います。
チームドライブ間のファイルの移動も可能です。
targetfolderidが移動先のフォルダのID、fileidが移動させるファイルのIDになります。

MENU

Google Apps Scriptで共有ドライブをコントロールする

今回使用するスプレッドシート

事前準備

Drive APIを有効にする

権限一覧を整備する

ソースコード

新規作成

共有権限一覧取得

チームドライブ一覧

チームドライブ管理者一覧

チームドライブに権限付与

チームドライブにファイル作成

チームドライブにフォルダコピー

チームドライブにファイル移動や削除

関連リンク

関連記事