Google ドライブ内のファイル。ファイルには DriveApp
からアクセスまたは作成できます。
// Trash every untitled spreadsheet that hasn't been updated in a week. const files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { const file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
メソッド
メソッド | 戻り値の型 | 概要 |
---|---|---|
addCommenter(emailAddress) | File | 指定したユーザーを File のコメント投稿者のリストに追加します。 |
addCommenter(user) | File | 指定したユーザーを File のコメント投稿者のリストに追加します。 |
addCommenters(emailAddresses) | File | 指定されたユーザーの配列を File のコメント投稿者のリストに追加します。 |
addEditor(emailAddress) | File | 指定されたユーザーを File の編集者のリストに追加します。 |
addEditor(user) | File | 指定されたユーザーを File の編集者のリストに追加します。 |
addEditors(emailAddresses) | File | 指定されたユーザーの配列を File の編集者のリストに追加します。 |
addViewer(emailAddress) | File | 指定したユーザーを File の視聴者のリストに追加します。 |
addViewer(user) | File | 指定したユーザーを File の視聴者のリストに追加します。 |
addViewers(emailAddresses) | File | 指定されたユーザーの配列を File の視聴者のリストに追加します。 |
getAccess(email) | Permission | 特定のユーザーに付与されている権限を取得します。 |
getAccess(user) | Permission | 特定のユーザーに付与されている権限を取得します。 |
getAs(contentType) | Blob | このオブジェクト内のデータを指定したコンテンツ タイプに変換された BLOB として返します。 |
getBlob() | Blob | このオブジェクト内のデータを blob として返します。 |
getDateCreated() | Date | File が作成された日付を取得します。 |
getDescription() | String | File の説明を取得します。 |
getDownloadUrl() | String | ファイルをダウンロードするために使用できる URL を取得します。 |
getEditors() | User[] | この File の編集者のリストを取得します。 |
getId() | String | File の ID を取得します。 |
getLastUpdated() | Date | File が最後に更新された日付を取得します。 |
getMimeType() | String | ファイルの MIME タイプを取得します。 |
getName() | String | File の名前を取得します。 |
getOwner() | User | ファイルのオーナーを取得します。 |
getParents() | FolderIterator | File の直接の親であるフォルダのコレクションを取得します。 |
getResourceKey() | String | リンクを使用して共有されたアイテムにアクセスするために必要な File のリソースキーを取得します。 |
getSecurityUpdateEligible() | Boolean | この File が、リンクを使用して共有する際にアクセスにリソースキーを必要とするセキュリティ アップデートを適用できるかどうかを取得します。 |
getSecurityUpdateEnabled() | Boolean | この File をリンクを使用して共有するときに、アクセスにリソースキーが必要かどうかを取得します。 |
getSharingAccess() | Access | 明示的にアクセス権が付与されている個々のユーザーのほかに、File にアクセスできるユーザークラスを取得します。 |
getSharingPermission() | Permission | File にアクセスできるユーザーに付与されている権限を取得します。明示的にアクセス権が付与されている個々のユーザーは除きます。 |
getSize() | Integer | ドライブに File を保存するために使用されるバイト数を取得します。 |
getTargetId() | String | ショートカットの場合は、ショートカットが参照するアイテムの ID を返します。 |
getTargetMimeType() | String | ショートカットの場合は、ショートカットが参照するアイテムの MIME タイプを返します。 |
getTargetResourceKey() | String | ファイルがショートカットの場合は、そのファイルが参照するアイテムのリソースキーを返します。 |
getThumbnail() | Blob | ファイルのサムネイル画像を取得します。サムネイルが存在しない場合は null を取得します。 |
getUrl() | String | Google ドライブや Google ドキュメントなどの Google アプリで File を開く際に使用できる URL を取得します。 |
getViewers() | User[] | この File の閲覧者とコメント投稿者のリストを取得します。 |
isShareableByEditors() | Boolean | File の編集権限を持つユーザーが、他のユーザーと共有したり、権限を変更したりできるかどうかを決定します。 |
isStarred() | Boolean | File がユーザーのドライブでスターを付けられているかどうかを判断します。 |
isTrashed() | Boolean | File がユーザーのドライブのゴミ箱にあるかどうかを判断します。 |
makeCopy() | File | ファイルのコピーを作成します。 |
makeCopy(destination) | File | ファイルのコピーを宛先ディレクトリに作成します。 |
makeCopy(name) | File | ファイルのコピーを作成し、指定された名前を付けます。 |
makeCopy(name, destination) | File | ファイルのコピーを宛先ディレクトリに作成し、指定された名前を付けます。 |
moveTo(destination) | File | このアイテムを指定された移動先のフォルダに移動します。 |
removeCommenter(emailAddress) | File | 指定したユーザーを File のコメント投稿者のリストから削除します。 |
removeCommenter(user) | File | 指定したユーザーを File のコメント投稿者のリストから削除します。 |
removeEditor(emailAddress) | File | 指定されたユーザーを File の編集者のリストから削除します。 |
removeEditor(user) | File | 指定されたユーザーを File の編集者のリストから削除します。 |
removeViewer(emailAddress) | File | 指定したユーザーを File の閲覧者とコメント投稿者のリストから削除します。 |
removeViewer(user) | File | 指定したユーザーを File の閲覧者とコメント投稿者のリストから削除します。 |
revokePermissions(emailAddress) | File | 指定されたユーザーに付与された File へのアクセス権を取り消します。 |
revokePermissions(user) | File | 指定されたユーザーに付与された File へのアクセス権を取り消します。 |
setContent(content) | File | 指定された置換文字列でファイルの内容を上書きします。 |
setDescription(description) | File | File の説明を設定します。 |
setName(name) | File | File の名前を設定します。 |
setOwner(emailAddress) | File | File のオーナーを変更します。 |
setOwner(user) | File | File のオーナーを変更します。 |
setSecurityUpdateEnabled(enabled) | File | File がリンクを使用して共有されるときに、アクセスにリソースキーが必要かどうかを設定します。 |
setShareableByEditors(shareable) | File | File の編集権限を持つユーザーが他のユーザーと共有したり、権限を変更したりできるかどうかを設定します。 |
setSharing(accessType, permissionType) | File | File にアクセスできるユーザークラスと、そのユーザーに付与される権限を設定します。明示的にアクセス権が付与されている個々のユーザーは除きます。 |
setStarred(starred) | File | File がユーザーのドライブでスターを付けられるかどうかを設定します。 |
setTrashed(trashed) | File | File がユーザーのドライブのゴミ箱にあるかどうかを設定します。 |
詳細なドキュメント
addCommenter(emailAddress)
指定したユーザーを File
のコメント投稿者のリストに追加します。ユーザーがすでに視聴者のリストに登録されている場合、このメソッドはユーザーを視聴者のリストから除外します。
const files = DriveApp.getFilesByName('Test'); // Loops through the files while (files.hasNext()) { const file = files.next(); file.addCommenter('hello@example.com'); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
emailAddress | String | 追加するユーザーのメールアドレス。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
addCommenter(user)
指定したユーザーを File
のコメント投稿者のリストに追加します。ユーザーがすでに視聴者のリストに登録されている場合、このメソッドはユーザーを視聴者のリストから除外します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Adds the active user as a commenter. while (files.hasNext()) { const file = files.next(); file.addCommenter(Session.getActiveUser()); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
user | User | 追加するユーザーを表します。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
addCommenters(emailAddresses)
指定されたユーザーの配列を File
のコメント投稿者のリストに追加します。ユーザーがすでに視聴者のリストに登録されている場合、このメソッドは視聴者のリストからユーザーを昇格させます。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); while (files.hasNext()) { const file = files.next(); // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and // 'baklavainthebalkans@gmail.com' with the email addresses to add as // commenters. const emails = [ 'cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com', ]; console.log(file.addCommenters(emails)); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
emailAddresses | String[] | 追加するユーザーのメールアドレスの配列。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
addEditor(emailAddress)
addEditor(user)
addEditors(emailAddresses)
addViewer(emailAddress)
addViewer(user)
addViewers(emailAddresses)
getAccess(email)
特定のユーザーに付与されている権限を取得します。このメソッドは、Google グループの権限や Google グループから継承された権限を返すことをサポートしていません。
パラメータ
名前 | 型 | 説明 |
---|---|---|
email | String | 権限を確認するユーザーのメールアドレス。Google グループはサポートされていません。 |
戻る
Permission
- ユーザーに付与されている権限。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAccess(user)
特定のユーザーに付与されている権限を取得します。このメソッドは、Google グループの権限や Google グループから継承された権限を返すことをサポートしていません。
パラメータ
名前 | 型 | 説明 |
---|---|---|
user | User | 権限を確認するユーザーを表すオブジェクト。 |
戻る
Permission
- ユーザーに付与されている権限。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAs(contentType)
このオブジェクト内のデータを指定したコンテンツ タイプに変換された BLOB として返します。この方法では、適切な拡張子がファイル名に追加されます(例: myfile.pdf)。ただし、最後のピリオド(存在する場合)の後のファイル名の部分は、置き換えが必要な既存の拡張子であると想定しています。そのため、「ShoppingList.12.25.2014」は「ShoppingList.12.25.pdf」になります。
コンバージョンの日別割り当てを表示するには、Google サービスの割り当てをご覧ください。新しく作成された Google Workspace ドメインには、一時的に厳しい割り当てが適用される場合があります。
パラメータ
名前 | 型 | 説明 |
---|---|---|
contentType | String | 変換する MIME タイプ。ほとんどの blob では、'application/pdf' のみが有効なオプションです。BMP、GIF、JPEG、PNG 形式の画像の場合は、'image/bmp' 、'image/gif' 、'image/jpeg' 、'image/png' のいずれも有効です。Google ドキュメント ドキュメントの場合は、'text/markdown' も有効です。 |
戻る
Blob
- BLOB としてのデータ。
getBlob()
getDateCreated()
getDescription()
getDownloadUrl()
ファイルをダウンロードするために使用できる URL を取得します。URL にアクセスできるのは、Google ドライブでファイルを開く権限を持つユーザーのみです。この URL をブラウザで使用してファイルをダウンロードすることはできますが、UrlFetchApp
でファイルを取得することはできません。ファイルの内容をスクリプトに含める場合は、getBlob()
を使用します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the download URLs to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getDownloadUrl()); }
戻る
String
- ファイルをダウンロードするために使用できる URL。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getEditors()
この File
の編集者のリストを取得します。スクリプトを実行するユーザーに File
の編集アクセス権がない場合は、このメソッドは空の配列を返します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Adds the email addresses in the array as editors of each file. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' // and 'baklavainthebalkans@gmail.com' with valid email addresses. file.addEditors([ 'cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com', ]); // Gets a list of the file editors. const editors = file.getEditors(); // For each file, logs the editors' email addresses to the console. for (const editor of editors) { console.log(editor.getEmail()); } }
戻る
User[]
- ユーザーがこの File
の編集権限を持っている場合は、編集者のリストを返します。ユーザーに編集権限がない場合、空の配列を返します。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
getLastUpdated()
getMimeType()
ファイルの MIME タイプを取得します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the MIME type to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getMimeType()); }
戻る
String
- ファイルの MIME タイプ。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getName()
getOwner()
ファイルのオーナーを取得します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the names of the file owners to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getOwner().getName()); }
戻る
User
- ファイルのオーナー。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getParents()
File
の直接の親であるフォルダのコレクションを取得します。
戻る
FolderIterator
- File
の直接の親であるフォルダのコレクション
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getResourceKey()
getSecurityUpdateEligible()
この File
が、リンクを使用して共有する際にアクセスにリソースキーを必要とするセキュリティ アップデートを適用できるかどうかを取得します。
リンクを使用して共有された一部のファイルまたはフォルダにアクセスするには、ドライブでリソースキーが必要です。この変更はセキュリティ アップデートの一環です。更新は、対象となるファイルとフォルダに対してデフォルトで有効になっています。対象ファイルのリソースキー要件をオンまたはオフにするには、setSecurityUpdateEnabled
を使用します。
詳しくは、Google ドライブのセキュリティ アップデートをご覧ください。
戻る
Boolean
- File
にリソースキーの要件を適用できるかどうか。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEnabled()
この File
をリンクを使用して共有するときに、アクセスにリソースキーが必要かどうかを取得します。この要件は、対象となるファイルとフォルダに対してデフォルトで有効になっています。対象ファイルのリソースキー要件をオンまたはオフにするには、
setSecurityUpdateEnabled
を使用します。
詳しくは、Google ドライブのセキュリティ アップデートをご覧ください。
戻る
Boolean
- この File
でリソースキーの要件が有効かどうか。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingAccess()
getSharingPermission()
File
にアクセスできるユーザーに付与されている権限を取得します。明示的にアクセス権が付与されている個々のユーザーは除きます。
戻る
Permission
- File
にアクセスできるユーザーに付与される権限
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSize()
getTargetId()
ショートカットの場合は、ショートカットが参照するアイテムの ID を返します。
それ以外の場合は null
を返します。
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the target ID of the shortcut. console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);
戻る
String
- ターゲット アイテム ID。
getTargetMimeType()
これがショートカットの場合は、ショートカットが参照するアイテムの MIME タイプを返します。
それ以外の場合は null
を返します。
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the MIME type of the file that the shortcut points to. console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);
戻る
String
- ターゲット アイテムの MIME タイプ。
getTargetResourceKey()
ファイルがショートカットの場合は、そのファイルが参照するアイテムのリソースキーを返します。リソースキーは、リンクを使用して共有されたファイルにアクセスするために渡す必要がある追加のパラメータです。
ファイルがショートカットでない場合は、null
が返されます。
// Gets a file by its ID. // TODO(developer): Replace 'abc123456' with your file ID. const file = DriveApp.getFileById('abc123456'); // If the file is a shortcut, returns the resource key of the file that it // points to. console.log(file.getTargetResourceKey());
戻る
String
- ターゲット アイテムのリソースキー。ファイルがショートカットでない場合は null
。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getThumbnail()
ファイルのサムネイル画像を取得します。サムネイルが存在しない場合は null
を取得します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Logs the thumbnail image for each file to the console as a blob, // or null if no thumbnail exists. console.log(file.getThumbnail()); }
戻る
Blob
- ファイルのサムネイル画像。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getUrl()
getViewers()
この File
の閲覧者とコメント投稿者のリストを取得します。スクリプトを実行するユーザーに File
の編集アクセス権がない場合は、このメソッドは空の配列を返します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // For each file, logs the viewers' email addresses to the console. const viewers = file.getViewers(); for (const viewer of viewers) { console.log(viewer.getEmail()); } }
戻る
User[]
- ユーザーがこの File
の編集権限を持っている場合、閲覧者とコメント投稿者のリストを返します。ユーザーに編集権限がない場合、空の配列を返します。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isStarred()
isTrashed()
makeCopy()
ファイルのコピーを作成します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and logs the file name to the console. console.log(file.makeCopy().getName()); }
戻る
File
- 新しいコピー。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
makeCopy(destination)
宛先ディレクトリにファイルのコピーを作成します。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and adds it to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy(destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
destination | Folder | ファイルをコピーするディレクトリ。 |
戻る
File
- 新しいコピー。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
makeCopy(name)
ファイルのコピーを作成し、指定された名前を付けます。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and sets the name to 'Test-Copy.' const filename = file.makeCopy('Test-Copy'); // Logs the copied file's name to the console. console.log(filename.getName()); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | 新しいコピーに適用するファイル名。 |
戻る
File
- 新しいコピー。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
makeCopy(name, destination)
宛先ディレクトリにファイルのコピーを作成し、指定された名前を付けます。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file, sets the file name, and adds the copied file // to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy('Test-Copy', destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
name | String | 新しいコピーに適用するファイル名。 |
destination | Folder | ファイルをコピーするディレクトリ。 |
戻る
File
- 新しいコピー。
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
moveTo(destination)
removeCommenter(emailAddress)
指定したユーザーを File
のコメント投稿者のリストから削除します。この方法では、一般的なアクセス権を持つユーザー クラスに属しているユーザーが File
にアクセスできないようにはなりません。たとえば、File
がユーザーのドメイン全体と共有されている場合などです。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. // TODO(developer): Replace the email with the email of the user you want to // remove. file.removeCommenter('cloudysanfrancisco@gmail.com'); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
emailAddress | String | 削除するユーザーのメールアドレス。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
removeCommenter(user)
指定したユーザーを File
のコメント投稿者のリストから削除します。この方法では、一般的なアクセス権を持つユーザー クラスに属しているユーザーが File
にアクセスできないようにはなりません。たとえば、File
がユーザーのドメイン全体と共有されている場合などです。
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. console.log(file.removeCommenter(Session.getActiveUser())); }
パラメータ
名前 | 型 | 説明 |
---|---|---|
user | User | 削除するユーザーを表す。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
removeEditor(emailAddress)
指定されたユーザーを File
の編集者のリストから削除します。この方法では、一般アクセス権を持つユーザー クラスに属するユーザーが File
にアクセスできないようにはなりません。たとえば、File
がユーザーのドメイン全体と共有されている場合や、File
がユーザーがアクセスできる共有ドライブにある場合などです。
ドライブ ファイルの場合、この操作により、ユーザーは閲覧者のリストからも削除されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
emailAddress | String | 削除するユーザーのメールアドレス。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
removeEditor(user)
指定されたユーザーを File
の編集者のリストから削除します。この方法では、一般アクセス権を持つユーザー クラスに属するユーザーが File
にアクセスできないようにはなりません。たとえば、File
がユーザーのドメイン全体と共有されている場合や、File
がユーザーがアクセスできる共有ドライブにある場合などです。
ドライブ ファイルの場合、この操作により、ユーザーは閲覧者のリストからも削除されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
user | User | 削除するユーザーを表す。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
removeViewer(emailAddress)
指定したユーザーを File
の閲覧者とコメント投稿者のリストから削除します。ユーザーが視聴者やコメント投稿者ではなく編集者である場合、この方法は効果がありません。また、この方法では、一般アクセス権を持つユーザー クラスに属しているユーザーが File
にアクセスできないようにはなりません。たとえば、File
がユーザーのドメイン全体と共有されている場合や、File
がユーザーがアクセスできる共有ドライブにある場合などです。
ドライブ ファイルの場合、この操作により、ユーザーは編集者のリストからも削除されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
emailAddress | String | 削除するユーザーのメールアドレス。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
removeViewer(user)
指定したユーザーを File
の閲覧者とコメント投稿者のリストから削除します。ユーザーが閲覧者ではなく編集者である場合、このメソッドは効果がありません。また、この方法では、一般的なアクセス権を持つユーザー クラスに属しているユーザーが File
にアクセスできないようにはなりません。たとえば、File
がユーザーのドメイン全体と共有されている場合や、File
がユーザーがアクセスできる共有ドライブにある場合などです。
ドライブ ファイルの場合、この操作により、ユーザーは編集者のリストからも削除されます。
パラメータ
名前 | 型 | 説明 |
---|---|---|
user | User | 削除するユーザーを表す。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
revokePermissions(emailAddress)
revokePermissions(user)
setContent(content)
ファイルの内容を指定された置換文字列で上書きします。content
が 10 MB を超えると、例外がスローされます。
// Creates a text file with the content 'Hello, world!' const file = DriveApp.createFile('New Text File', 'Hello, world!'); // Logs the content of the text file to the console. console.log(file.getBlob().getDataAsString()); // Updates the content of the text file to 'Updated text!' file.setContent('Updated text!'); // Logs content of the text file to the console. console.log(file.getBlob().getDataAsString());
パラメータ
名前 | 型 | 説明 |
---|---|---|
content | String | ファイルの新しいコンテンツ。 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive
setDescription(description)
setName(name)
setOwner(emailAddress)
setOwner(user)
setSecurityUpdateEnabled(enabled)
setSharing(accessType, permissionType)
File
にアクセスできるユーザークラスと、そのユーザーに付与される権限を設定します。明示的にアクセス権が付与されている個々のユーザーは除きます。
// Creates a folder that anyone on the Internet can read from and write to. // (Domain administrators can prohibit this setting for users of a Google // Workspace domain.) const folder = DriveApp.createFolder('Shared Folder'); folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
パラメータ
名前 | 型 | 説明 |
---|---|---|
accessType | Access | File にアクセスできるユーザーのクラス |
permissionType | Permission | File にアクセスできるユーザーに付与する必要がある権限 |
戻る
承認
このメソッドを使用するスクリプトには、次のスコープの 1 つ以上による承認が必要です。
-
https://www.googleapis.com/auth/drive