Class Folder

コレクションでコンテンツを整理 必要に応じて、コンテンツの保存と分類を行います。
フォルダ

Google ドライブ内のフォルダ。フォルダへのアクセスまたは作成には、DriveApp を使用します。

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

Methods

方法戻り値の型概要
addEditor(emailAddress)Folder指定されたユーザーを Folder の編集者リストに追加します。
addEditor(user)Folder指定されたユーザーを Folder の編集者リストに追加します。
addEditors(emailAddresses)Folder指定したユーザー配列を Folder の編集者リストに追加します。
addViewer(emailAddress)Folder指定されたユーザーを Folder の閲覧者リストに追加します。
addViewer(user)Folder指定されたユーザーを Folder の閲覧者リストに追加します。
addViewers(emailAddresses)Folder指定したユーザー配列を Folder の閲覧者リストに追加します。
createFile(blob)File任意のデータの特定の Blob から現在のフォルダにファイルを作成します。
createFile(name, content)File現在のフォルダに、指定された名前とコンテンツでテキスト ファイルを作成します。
createFile(name, content, mimeType)File現在のフォルダに、指定した名前、内容、MIME タイプのファイルを作成します。
createFolder(name)Folder現在のフォルダに、指定した名前のフォルダを作成します。
createShortcut(targetId)File指定されたドライブ アイテム ID へのショートカットを作成して返します。
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)File指定されたドライブのアイテム ID とリソースキーへのショートカットを作成して返します。
getAccess(email)Permission指定されたユーザーに付与されている権限を取得します。
getAccess(user)Permission指定されたユーザーに付与されている権限を取得します。
getDateCreated()DateFolder の作成日を取得します。
getDescription()StringFolder の説明を取得します。
getEditors()User[]この Folder の編集者のリストを取得します。
getFiles()FileIterator現在のフォルダの子であるすべてのファイルのコレクションを取得します。
getFilesByName(name)FileIterator現在のフォルダの子であり、指定された名前を持つすべてのファイルのコレクションを取得します。
getFilesByType(mimeType)FileIterator現在のフォルダの子で、指定された MIME タイプを持つすべてのファイルのコレクションを取得します。
getFolders()FolderIterator現在のフォルダの子であるすべてのフォルダのコレクションを取得します。
getFoldersByName(name)FolderIterator現在のフォルダの子であり、指定された名前を持つすべてのフォルダのコレクションを取得します。
getId()StringFolder の ID を取得します。
getLastUpdated()DateFolder の最終更新日を取得します。
getName()StringFolder の名前を取得します。
getOwner()UserFolder のオーナーを取得します。
getParents()FolderIteratorFolder の直接の親であるフォルダのコレクションを取得します。
getResourceKey()Stringリンクを使用して共有されたアイテムにアクセスするために必要な Folder のリソースキーを取得します。
getSecurityUpdateEligible()Booleanこの Folder が、リンクを使用して共有するときにアクセスにリソースキーを必要とするセキュリティ アップデートを適用するかどうかを示します。
getSecurityUpdateEnabled()Booleanリンクを使用して共有するときに、この Folder がアクセスにリソースキーを必要とするかどうかを取得します。
getSharingAccess()Access明示的にアクセス権を付与されている個々のユーザーを除き、Folder にアクセスできるユーザークラスを取得します。
getSharingPermission()PermissionFolder にアクセスできるユーザーに付与された権限を取得します。明示的にアクセス権を付与された個々のユーザーを除きます。
getSize()IntegerFolder をドライブに保存するために使用されるバイト数を取得します。
getUrl()Stringドライブやドキュメントなどの Google アプリで Folder を開くために使用できる URL を取得します。
getViewers()User[]この Folder の閲覧者とコメント投稿者のリストを取得します。
isShareableByEditors()BooleanFolder の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを指定します。
isStarred()Booleanユーザーのドライブで Folder にスターが付いているかどうかを判断します。
isTrashed()BooleanFolder がユーザーのドライブのゴミ箱にあるかどうかを判断します。
moveTo(destination)Folderこのアイテムを指定したフォルダに移動します。
removeEditor(emailAddress)Folder指定されたユーザーを Folder の編集者のリストから削除します。
removeEditor(user)Folder指定されたユーザーを Folder の編集者のリストから削除します。
removeViewer(emailAddress)FolderFolder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
removeViewer(user)FolderFolder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
revokePermissions(user)Folder指定されたユーザーに付与された Folder へのアクセス権を取り消します。
revokePermissions(user)Folder指定されたユーザーに付与された Folder へのアクセス権を取り消します。
searchFiles(params)FileIterator現在のフォルダの子であり、指定した検索条件に一致するすべてのファイルのコレクションを取得します。
searchFolders(params)FolderIterator現在のフォルダの子であり、指定した検索条件に一致するすべてのフォルダのコレクションを取得します。
setDescription(description)FolderFolder の説明を設定します。
setName(name)FolderFolder の名前を設定します。
setOwner(emailAddress)FolderFolder の所有者を変更します。
setOwner(user)FolderFolder の所有者を変更します。
setSecurityUpdateEnabled(enabled)Folderリンクを使用してアクセスする場合に、Folder がアクセスにリソースキーを必要とするかどうかを設定します。
setShareableByEditors(shareable)FolderFolder の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを設定します。
setSharing(accessType, permissionType)FolderFolder にアクセスできるユーザークラスと、それらのユーザーに付与する権限(明示的にアクセス権を付与されたユーザーを除く)を設定します。
setStarred(starred)Folderユーザーのドライブで Folder にスターを付けるかどうかを設定します。
setTrashed(trashed)FolderFolder がユーザーのドライブのゴミ箱にあるかどうかを設定します。

詳細なドキュメント

addEditor(emailAddress)

指定されたユーザーを Folder の編集者リストに追加します。ユーザーがすでに閲覧者のリストに含まれていた場合、このメソッドはユーザーを閲覧者のリストから昇格させます。

パラメータ

名前説明
emailAddressString追加するユーザーのメールアドレス。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

addEditor(user)

指定されたユーザーを Folder の編集者リストに追加します。ユーザーがすでに閲覧者のリストに含まれていた場合、このメソッドはユーザーを閲覧者のリストから昇格させます。

パラメータ

名前説明
userUser追加するユーザーの表現。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

addEditors(emailAddresses)

指定したユーザー配列を Folder の編集者リストに追加します。いずれかのユーザーがすでに閲覧者のリストに含まれていた場合、この方法によって閲覧者のリストから昇格されます。

パラメータ

名前説明
emailAddressesString[]追加するユーザーのメールアドレスの配列。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

addViewer(emailAddress)

指定されたユーザーを Folder の閲覧者リストに追加します。ユーザーがすでに編集者のリストに含まれていた場合、このメソッドは何の効果もありません。

パラメータ

名前説明
emailAddressString追加するユーザーのメールアドレス。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

addViewer(user)

指定されたユーザーを Folder の閲覧者リストに追加します。ユーザーがすでに編集者のリストに含まれていた場合、このメソッドは何の効果もありません。

パラメータ

名前説明
userUser追加するユーザーの表現。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

addViewers(emailAddresses)

指定したユーザー配列を Folder の閲覧者リストに追加します。すでに編集者のリストにすでに登録されているユーザーがいる場合、このメソッドはその編集者に影響しません。

パラメータ

名前説明
emailAddressesString[]追加するユーザーのメールアドレスの配列。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

createFile(blob)

任意のデータの特定の Blob から現在のフォルダにファイルを作成します。

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(blob);

パラメータ

名前説明
blobBlobSource新しいファイルのデータ。

戻る

File - 新しいファイル。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

createFile(name, content)

現在のフォルダに、指定された名前とコンテンツでテキスト ファイルを作成します。content が 50 MB を超えると、例外をスローします。

// Create a text file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');

パラメータ

名前説明
nameString新しいファイルの名前。
contentString新しいファイルの内容。

戻る

File - 新しいファイル。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

createFile(name, content, mimeType)

現在のフォルダに、指定した名前、内容、MIME タイプのファイルを作成します。content が 10 MB を超える場合は例外をスローします。

// Create an HTML file with the content "Hello, world!"
DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

パラメータ

名前説明
nameString新しいファイルの名前。
contentString新しいファイルの内容。
mimeTypeString新しいファイルの MIME タイプ。

戻る

File - 新しいファイル。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

createFolder(name)

現在のフォルダに、指定した名前のフォルダを作成します。

パラメータ

名前説明
nameString新しいフォルダの名前。

戻る

Folder - 新しいフォルダ。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

createShortcut(targetId)

指定されたドライブ アイテム ID へのショートカットを作成して返します。

パラメータ

名前説明
targetIdString対象のファイルまたはフォルダのファイル ID。

戻る

File - 新しいショートカットです。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

指定されたドライブのアイテム ID とリソースキーへのショートカットを作成して返します。リソースキーは、リンクを使用して共有されたターゲット ファイルまたはフォルダにアクセスするために渡す追加のパラメータです。

パラメータ

名前説明
targetIdString対象ファイルまたはフォルダの ID。
targetResourceKeyString対象ファイルまたはフォルダのリソースキー。

戻る

File - 新しいショートカットです。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

getAccess(email)

指定されたユーザーに付与されている権限を取得します。

パラメータ

名前説明
emailString権限を確認する必要があるユーザーのメールアドレス

戻る

Permission - ユーザーに付与されている権限

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAccess(user)

指定されたユーザーに付与されている権限を取得します。

パラメータ

名前説明
userUser権限をチェックする必要があるユーザーの表現

戻る

Permission - ユーザーに付与されている権限

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDateCreated()

Folder の作成日を取得します。

戻る

Date - Folder が作成された日付

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDescription()

Folder の説明を取得します。

戻る

String - Folder の説明

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getEditors()

この Folder の編集者のリストを取得します。スクリプトを実行するユーザーに Folder の編集アクセス権がない場合、このメソッドは空の配列を返します。

戻る

User[] - 編集権限を持つユーザーの配列。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFiles()

現在のフォルダの子であるすべてのファイルのコレクションを取得します。

戻る

FileIterator - 現在のフォルダの子であるすべてのファイルのコレクション。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFilesByName(name)

現在のフォルダの子であり、指定された名前を持つすべてのファイルのコレクションを取得します。

パラメータ

名前説明
nameString検索するファイルの名前。

戻る

FileIterator - 現在のフォルダの子であり、特定の名前を持つすべてのファイルのコレクション。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFilesByType(mimeType)

現在のフォルダの子で、指定された MIME タイプを持つすべてのファイルのコレクションを取得します。

パラメータ

名前説明
mimeTypeString検索するファイルの MIME タイプ。

戻る

FileIterator - 現在のフォルダの子であり、指定された MIME タイプを持つすべてのファイルのコレクション。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFolders()

現在のフォルダの子であるすべてのフォルダのコレクションを取得します。

戻る

FolderIterator - 現在のフォルダの子であるすべてのフォルダのコレクションです。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getFoldersByName(name)

現在のフォルダの子であり、指定された名前を持つすべてのフォルダのコレクションを取得します。

パラメータ

名前説明
nameString検索するフォルダの名前。

戻る

FolderIterator - 現在のフォルダの子であり、指定された名前を持つすべてのフォルダのコレクション。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getId()

Folder の ID を取得します。

戻る

String - Folder の ID

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getLastUpdated()

Folder の最終更新日を取得します。

戻る

Date - Folder が最後に更新された日付

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getName()

Folder の名前を取得します。

戻る

String - Folder の名前

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getOwner()

Folder のオーナーを取得します。

戻る

User - オーナーを表す User オブジェクト

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getParents()

Folder の直接の親であるフォルダのコレクションを取得します。

戻る

FolderIterator - Folder の親のフォルダのコレクションです。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getResourceKey()

リンクを使用して共有されたアイテムにアクセスするために必要な Folder のリソースキーを取得します。

戻る

String - Folder のリソースキー。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEligible()

この Folder が、リンクを使用して共有するときにアクセスにリソースキーを必要とするセキュリティ アップデートを適用するかどうかを確認します。

ドライブで、リンクを使用して共有されているファイルまたはフォルダにアクセスするには、リソースキーが必要です。この変更はセキュリティ アップデートの一部です。対象のファイルとフォルダに対する更新はデフォルトで有効になっています。対象ファイルに対してリソースキーの要件を有効または無効にするには、setSecurityUpdateEnabled を使用します。

詳しくは、Google ドライブのセキュリティ アップデートをご覧ください。

戻る

Boolean - Folder にリソースキーの要件を適用できるかどうか。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEnabled()

リンクを使用して共有するときに、この Folder がアクセスにリソースキーを必要とするかどうかを取得します。この要件は、対象となるファイルとフォルダではデフォルトで有効になっています。対象ファイルに対してリソースキーの要件を有効または無効にするには、 setSecurityUpdateEnabled を使用します。

詳しくは、Google ドライブのセキュリティ アップデートをご覧ください。

戻る

Boolean - この Folder のリソースキーの要件が有効かどうかを示します。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingAccess()

明示的にアクセス権を付与されている個々のユーザーを除き、Folder にアクセスできるユーザークラスを取得します。

戻る

Access - Folder にアクセスできるユーザークラス

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingPermission()

Folder にアクセスできるユーザーに付与された権限を取得します。明示的にアクセス権を付与された個々のユーザーを除きます。

戻る

Permission - Folder にアクセスできるユーザーに付与される権限

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSize()

Folder をドライブに保存するために使用されるバイト数を取得します。Google Workspace アプリケーション ファイルはドライブの保存容量制限にカウントされないため、0 バイトが返されます。

戻る

Integer - Folder をドライブに保存するために使用されるバイト数

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getUrl()

ドライブやドキュメントなどの Google アプリで Folder を開くために使用できる URL を取得します。

戻る

String - ドライブやドキュメントなどの Google アプリでこの Folder を表示するために使用できる URL

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getViewers()

この Folder の閲覧者とコメント投稿者のリストを取得します。スクリプトを実行するユーザーに Folder の編集アクセス権がない場合、このメソッドは空の配列を返します。

戻る

User[] - 表示またはコメントの権限を持つユーザーの配列。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isShareableByEditors()

Folder の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを指定します。

戻る

Boolean - 編集権限のあるユーザーが他のユーザーと共有したり、権限を変更したりできる場合は true。そうでない場合は false を指定します。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isStarred()

ユーザーのドライブで Folder にスターが付いているかどうかを判断します。

戻る

Boolean - Folder がユーザーのドライブでスターが付いている場合は true、そうでない場合は false

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isTrashed()

Folder がユーザーのドライブのゴミ箱にあるかどうかを判断します。

戻る

Boolean - Folder がユーザーのドライブのゴミ箱にある場合は true、存在しない場合は false

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

moveTo(destination)

このアイテムを指定したフォルダに移動します。

アイテムを移動先のフォルダに移動するには、現在のユーザーがファイルのオーナーであるか、アイテムの現在の親フォルダ以上の編集権限を持っている必要があります。

パラメータ

名前説明
destinationFolder新しい親になるフォルダ。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

removeEditor(emailAddress)

指定されたユーザーを Folder の編集者のリストから削除します。このメソッドは、Folder がドメイン全体で共有されている場合や、Folder がアクセスできる共有ドライブ内にある場合など、一般的なアクセス権を持つクラスのクラスに属している場合、ユーザーが Folder にアクセスすることをブロックしません。

ドライブ ファイルの場合は、閲覧者のリストからユーザーも削除されます。

パラメータ

名前説明
emailAddressString削除するユーザーのメールアドレス。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

removeEditor(user)

指定されたユーザーを Folder の編集者のリストから削除します。このメソッドは、Folder がドメイン全体で共有されている場合や、Folder がアクセスできる共有ドライブ内にある場合など、一般的なアクセス権を持つクラスのクラスに属している場合、ユーザーが Folder にアクセスすることをブロックしません。

ドライブ ファイルの場合は、閲覧者のリストからユーザーも削除されます。

パラメータ

名前説明
userUser削除するユーザーの表現。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

removeViewer(emailAddress)

Folder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。ユーザーが編集者で、閲覧者や閲覧者(コメント可)ではない場合、このメソッドは何の効果も生じさせません。この方法は、一般へのアクセス権を持つユーザーのクラスに属している場合であっても、Folder へのアクセスをブロックしません。たとえば、Folder がドメイン全体と共有されている場合や、ユーザーがアクセスできる共有ドライブに Folder が含まれている場合も同様です。

ドライブのファイルについては、編集者のリストからも削除されます。

パラメータ

名前説明
emailAddressString削除するユーザーのメールアドレス。

戻る

Folder - チェーン用の Folder

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

removeViewer(user)

Folder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。ユーザーが編集者ではなく閲覧者では、このメソッドは何の効果も生じさせません。このメソッドは、Folder がドメイン全体で共有されている場合や、Folder がアクセスできる共有ドライブ内にある場合など、一般アクセス権を持つユーザーのクラスに属している場合に、ユーザーが Folder にアクセスすることをブロックしません。

ドライブのファイルについては、編集者のリストからも削除されます。

パラメータ

名前説明
userUser削除するユーザーの表現。

戻る

Folder - チェーン用の Folder

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

revokePermissions(user)

指定されたユーザーに付与された Folder へのアクセス権を取り消します。このメソッドは、Folder がドメイン全体と共有されている場合など、一般的なアクセス権を持つクラスに属している場合、ユーザーが Folder にアクセスすることをブロックしません。

パラメータ

名前説明
userStringアクセス権を取り消すユーザーのメールアドレス

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

revokePermissions(user)

指定されたユーザーに付与された Folder へのアクセス権を取り消します。このメソッドは、Folder がドメイン全体と共有されている場合など、一般的なアクセス権を持つクラスに属している場合、ユーザーが Folder にアクセスすることをブロックしません。

パラメータ

名前説明
userUserアクセス権を取り消すユーザーの指定

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

searchFiles(params)

現在のフォルダの子であり、指定した検索条件に一致するすべてのファイルのコレクションを取得します。検索条件の詳細については、Google ドライブ SDK のドキュメントをご覧ください。params 引数は文字列値を含むクエリ文字列であるため、引用符を正しくエスケープするよう注意してください(例: "title contains 'Gulliver\\'s Travels'"'title contains "Gulliver\'s Travels"')。

// Log the name of every file that are children of the current folder and modified after February 28,
// 2013 whose name contains "untitled".
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2013-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

パラメータ

名前説明
paramsString検索条件。詳しくは、Google ドライブ SDK のドキュメントをご覧ください。

戻る

FileIterator - 現在のフォルダの子であり、検索条件に一致するすべてのファイルのコレクション。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

searchFolders(params)

現在のフォルダの子であり、指定した検索条件に一致するすべてのフォルダのコレクションを取得します。検索条件の詳細については、Google ドライブ SDK のドキュメントをご覧ください。params 引数は文字列値を含むクエリ文字列であるため、引用符を正しくエスケープするよう注意してください(例: "title contains 'Gulliver\\'s Travels'"'title contains "Gulliver\'s Travels"')。

// Log the name of every folder that are children of the current folder and you own and is starred.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

パラメータ

名前説明
paramsString検索条件。詳しくは、Google ドライブ SDK のドキュメントをご覧ください。

戻る

FolderIterator - 現在のフォルダの子であり、検索条件に一致するすべてのフォルダのコレクション。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

setDescription(description)

Folder の説明を設定します。

パラメータ

名前説明
descriptionStringFolder の新しい説明

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

setName(name)

Folder の名前を設定します。

パラメータ

名前説明
nameStringFolder の新しい名前

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

setOwner(emailAddress)

Folder の所有者を変更します。このメソッドにより、前の所有者は Folder への明示的な編集アクセス権も付与されます。

パラメータ

名前説明
emailAddressString新しいオーナーになるユーザーのメールアドレス

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

setOwner(user)

Folder の所有者を変更します。このメソッドにより、前の所有者は Folder への明示的な編集アクセス権も付与されます。

パラメータ

名前説明
userUser新しいオーナーになるユーザーの表現

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

setSecurityUpdateEnabled(enabled)

リンクを使用してアクセスする場合に、Folder がアクセスにリソースキーを必要とするかどうかを設定します。対象ファイルとフォルダはデフォルトで有効になっています。

詳しくは、Google ドライブのセキュリティ アップデートをご覧ください。

パラメータ

名前説明
enabledBooleanFolder のリソースキー要件を有効にするかどうか。

戻る

Folder - この Folder。チェーン用です。

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

setShareableByEditors(shareable)

Folder の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを設定します。新しい Folder のデフォルトは true です。

パラメータ

名前説明
shareableBoolean編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可する場合は true、そうでない場合は false に設定します。

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

setSharing(accessType, permissionType)

Folder にアクセスできるユーザークラスと、それらのユーザーに付与されている権限(明らかにアクセス権を付与されている個々のユーザーを除く)を設定します。

// 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.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

パラメータ

名前説明
accessTypeAccessFolder にアクセスする必要のあるユーザーのクラス
permissionTypePermissionFolder にアクセスできるユーザーに付与する必要がある権限

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

setStarred(starred)

ユーザーのドライブで Folder にスターを付けるかどうかを設定します。新しい Folder のデフォルトは false です。

パラメータ

名前説明
starredBooleanユーザーのドライブで Folder にスターを付ける場合は true、そうでない場合は false にします。

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

setTrashed(trashed)

Folder がユーザーのドライブのゴミ箱にあるかどうかを設定します。オーナーのみが Folder をゴミ箱に移動できます。新しい Folder のデフォルトは false です。

パラメータ

名前説明
trashedBooleanFolder をユーザーのドライブのゴミ箱に移動する場合は true、それ以外の場合は false

戻る

Folder - この Folder(チェーンの場合)

認可

このメソッドを使用するスクリプトには、次の 1 つ以上のスコープによる承認が必要です。

  • https://www.googleapis.com/auth/drive

サポート終了のメソッド