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()Permission明示的にアクセス権を付与された個々のユーザーを除き、Folder にアクセスできるユーザーに付与されている権限を取得します。
getSize()Integerドライブへの保存に使用されるバイト数を取得します。Folder
getUrl()Stringドライブやドキュメントなどの Google アプリで Folder を開くために使用できる URL を取得します。
getViewers()User[]この Folder の閲覧者と閲覧者（コメント可）のリストを取得します。
isShareableByEditors()BooleanFolder の編集権限を持つユーザーに、他のユーザーとの共有または権限の変更を許可するかどうかを指定します。
isStarred()BooleanFolder がユーザーのドライブにスターが付いているかどうかを確認します。
isTrashed()BooleanFolder がユーザーのドライブのゴミ箱にあるかどうかを判断します。
moveTo(destination)Folderこのアイテムを指定の場所に移動します。
removeEditor(emailAddress)FolderFolder の編集者のリストから指定されたユーザーを削除します。
removeEditor(user)FolderFolder の編集者のリストから指定されたユーザーを削除します。
removeViewer(emailAddress)FolderFolder の閲覧者と閲覧者（コメント可）のリストからユーザーを削除します。
removeViewer(user)FolderFolder の閲覧者と閲覧者（コメント可）のリストからユーザーを削除します。
revokePermissions(emailAddress)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)FolderFolder でリンクを使用して共有する際に、アクセス用のリソースキーを要求するかどうかを設定します。
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()

ドライブへの保存に使用されるバイト数を取得します。FolderGoogle 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(emailAddress)

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

パラメータ

氏名型説明
emailAddressStringアクセス権を取り消すユーザーのメールアドレス。

戻る

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 Drive SDK のドキュメントをご覧ください。ドライブ サービスは Drive API の v2 を使用するため、一部のクエリ フィールドは v3 とは異なることに注意してください。v2 と v3 のフィールドの違いを確認します。

params 引数は、文字列値を含めることができるクエリ文字列であるため、引用符を正しくエスケープするようにしてください（例: "title contains 'Gulliver\\'s Travels'"、'title contains "Gulliver\'s Travels"'）。

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

パラメータ

氏名型説明
paramsString検索条件（Google ドライブ SDK ドキュメントを参照）。

戻る

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

承認

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

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

searchFolders(params)

現在のフォルダの子であり、指定された検索条件に一致するすべてのフォルダのコレクションを取得します。検索条件について詳しくは、Google Drive SDK のドキュメントをご覧ください。ドライブ サービスは Drive API の v2 を使用するため、一部のクエリ フィールドは v3 とは異なることに注意してください。v2 と v3 のフィールドの違いを確認します。

params 引数は、文字列値を含めることができるクエリ文字列であるため、引用符を正しくエスケープするようにしてください（例: "title contains 'Gulliver\\'s Travels'"、'title contains "Gulliver\'s Travels"'）。

// Logs 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();
  console.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 です。

パラメータ

氏名型説明
shareableBooleantrue 編集権限を持つユーザーが他のユーザーと共有したり、権限を変更したりする必要がある場合は、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 です。

パラメータ

氏名型説明
starredBooleantrueユーザーのドライブにFolderスターを付ける場合は false

戻る

Folder - 連結用の Folder

承認

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

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

setTrashed(trashed)

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

パラメータ

氏名型説明
trashedBooleantrueFolderをユーザーのドライブのゴミ箱に移動する場合は false

戻る

Folder - 連結用の Folder

承認

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

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

サポート終了のメソッド