Drive Service

このサービスを使用すると、スクリプトで Google ドライブ内のファイルやフォルダの作成、検索、変更を行えます。組み込みのドライブサービスは使いやすいですが、いくつかの制限があります。最新の機能とサポートを利用し、共有ドライブ内のファイルやフォルダにアクセスするには、高度なドライブサービスを使用します。

スクリプトでデフォルトの Cloud プロジェクトではなく標準の Cloud プロジェクトを使用している場合は、Drive API を手動で有効にする必要があります。標準の Cloud プロジェクトで、ドライブ API をオンにします。

Drive API を有効にする

次のコードサンプルは、ユーザーの [マイドライブ] フォルダ内の各ファイルの名前をログに記録する方法を示しています。

// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

注: Google Workspace 管理者は、ドメインの Drive SDK をオフにすることができます。これにより、ユーザーは Google ドライブアプリをインストールして使用できなくなります。この設定により、ユーザーは Drive サービスまたは高度な Drive サービスを使用する Apps Script スクリプト、ウェブアプリ、アドオンを使用できなくなります（アドオンやウェブアプリが管理者が Drive SDK をオフにする前にインストールされていた場合でも同様です）。

ただし、ドライブサービスを使用するアドオンがドメイン全体へのインストール用に公開され、ドメイン内のユーザーの一部またはすべてに対して管理者がインストールした場合、またはドメイン管理者が OAuth クライアントを許可リストに登録したスクリプトの場合、ドメインで Drive SDK がオフになっていても、そのユーザーに対してアドオンは機能します。

クラス

名前	概要
`Access`	明示的にアクセス権が付与された個々のユーザー以外に、ファイルやフォルダにアクセスできるユーザーのクラスを表す列挙型。
`DriveApp`	スクリプトが Google ドライブ内のファイルやフォルダを作成、検索、変更できるようにします。
`File`	Google ドライブ内のファイル。
`FileIterator`	スクリプトが大量のファイルコレクションを反復処理できるようにするイテレータ。
`Folder`	Google ドライブ内のフォルダ。
`FolderIterator`	スクリプトでフォルダの大きなコレクションを反復処理できるオブジェクト。
`Permission`	ファイルやフォルダにアクセスできるユーザーに付与された権限を表す列挙型。明示的にアクセス権が付与された個々のユーザーは除きます。
`User`	Google ドライブ内のファイルに関連付けられているユーザー。

`Access`

プロパティ

プロパティ	タイプ	説明
`ANYONE`	`Enum`	インターネット上の誰でも検索とアクセスができます。
`ANYONE_WITH_LINK`	`Enum`	リンクを知っている全員がアクセスできます。
`DOMAIN`	`Enum`	ドメイン内のユーザーが検索、アクセスできます。
`DOMAIN_WITH_LINK`	`Enum`	リンクを知っているドメイン内のユーザーがアクセスできます。
`PRIVATE`	`Enum`	明示的に権限を付与されたユーザーだけがアクセスできます。

`DriveApp`

プロパティ

プロパティ	タイプ	説明
`Access`	`Access`	明示的にアクセス権が付与された個々のユーザー以外に、ファイルやフォルダにアクセスできるユーザーのクラスを表す列挙型。
`Permission`	`Permission`	ファイルやフォルダにアクセスできるユーザーに付与された権限を表す列挙型。明示的にアクセス権が付与された個々のユーザーは除きます。

メソッド

メソッド	戻り値の型	概要
`continueFileIterator(continuationToken)`	`FileIterator`	前のイテレータの継続トークンを使用して、ファイルイテレーションを再開します。
`continueFolderIterator(continuationToken)`	`FolderIterator`	前のイテレータの継続トークンを使用して、フォルダの反復を再開します。
`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 とリソースキーへのショートカットを作成して返します。
`enforceSingleParent(value)`	`void`	アイテムの親に影響するすべての呼び出しに対して enforceSingleParent 動作を有効または無効にします。
`getFileById(id)`	`File`	指定された ID のファイルを取得します。
`getFileByIdAndResourceKey(id, resourceKey)`	`File`	指定された ID とリソースキーを持つファイルを取得します。
`getFiles()`	`FileIterator`	ユーザーのドライブ内のすべてのファイルのコレクションを取得します。
`getFilesByName(name)`	`FileIterator`	指定された名前を持つユーザーのドライブ内のすべてのファイルのコレクションを取得します。
`getFilesByType(mimeType)`	`FileIterator`	指定された MIME タイプのファイルがユーザーのドライブに存在する場合、そのすべてのファイルを含むコレクションを取得します。
`getFolderById(id)`	`Folder`	指定された ID のフォルダを取得します。
`getFolderByIdAndResourceKey(id, resourceKey)`	`Folder`	指定された ID とリソースキーを持つフォルダを取得します。
`getFolders()`	`FolderIterator`	ユーザーのドライブ内のすべてのフォルダのコレクションを取得します。
`getFoldersByName(name)`	`FolderIterator`	指定された名前のフォルダがユーザーのドライブに存在する場合、そのフォルダのコレクションを取得します。
`getRootFolder()`	`Folder`	ユーザーのドライブのルートにあるフォルダを取得します。
`getStorageLimit()`	`Integer`	ユーザーがドライブに保存できるバイト数を取得します。
`getStorageUsed()`	`Integer`	ユーザーが現在ドライブに保存しているバイト数を取得します。
`getTrashedFiles()`	`FileIterator`	ユーザーのドライブのゴミ箱にあるすべてのファイルのコレクションを取得します。
`getTrashedFolders()`	`FolderIterator`	ユーザーのドライブのゴミ箱にあるすべてのフォルダのコレクションを取得します。
`searchFiles(params)`	`FileIterator`	指定された検索条件に一致するユーザーのドライブ内のすべてのファイルのコレクションを取得します。
`searchFolders(params)`	`FolderIterator`	指定された検索条件に一致するユーザーのドライブ内のすべてのフォルダのコレクションを取得します。

`File`

メソッド

メソッド	戻り値の型	概要
`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\|null`	これがショートカットの場合、指しているアイテムの ID を返します。
`getTargetMimeType()`	`String\|null`	これがショートカットの場合、参照先のアイテムの MIME タイプを返します。
`getTargetResourceKey()`	`String\|null`	ファイルがショートカットの場合、そのファイルが指すアイテムのリソースキーを返します。
`getThumbnail()`	`Blob\|null`	ファイルのサムネイル画像を取得します。サムネイルが存在しない場合は `null` を返します。
`getUrl()`	`String`	ドライブやドキュメントなどの 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` がユーザーのドライブのゴミ箱にあるかどうかを設定します。

`FileIterator`

メソッド

メソッド	戻り値の型	概要
`getContinuationToken()`	`String`	後でこのイテレーションを再開するために使用できるトークンを取得します。
`hasNext()`	`Boolean`	`next()` の呼び出しでアイテムが返されるかどうかを判断します。
`next()`	`File`	ファイルまたはフォルダのコレクション内の次のアイテムを取得します。

`Folder`

メソッド

メソッド	戻り値の型	概要
`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()`	`Date`	`Folder` の作成日を取得します。
`getDescription()`	`String`	`Folder` の説明を取得します。
`getEditors()`	`User[]`	この `Folder` の編集者のリストを取得します。
`getFiles()`	`FileIterator`	現在のフォルダの子であるすべてのファイルのコレクションを取得します。
`getFilesByName(name)`	`FileIterator`	現在のフォルダの子で、指定された名前を持つすべてのファイルのコレクションを取得します。
`getFilesByType(mimeType)`	`FileIterator`	現在のフォルダの子で、指定された MIME タイプのすべてのファイルのコレクションを取得します。
`getFolders()`	`FolderIterator`	現在のフォルダの子であるすべてのフォルダのコレクションを取得します。
`getFoldersByName(name)`	`FolderIterator`	現在のフォルダの子で、指定された名前を持つすべてのフォルダのコレクションを取得します。
`getId()`	`String`	`Folder` の ID を取得します。
`getLastUpdated()`	`Date`	`Folder` が最後に更新された日付を取得します。
`getName()`	`String`	`Folder` の名前を取得します。
`getOwner()`	`User`	この `Folder` のオーナーを取得します。
`getParents()`	`FolderIterator`	`Folder` の直近の親であるフォルダのコレクションを取得します。
`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()`	`Boolean`	`Folder` の編集権限を持つユーザーが、他のユーザーと共有したり、権限を変更したりできるかどうかを指定します。
`isStarred()`	`Boolean`	`Folder` がユーザーのドライブでスター付きになっているかどうかを判断します。
`isTrashed()`	`Boolean`	`Folder` がユーザーのドライブのゴミ箱にあるかどうかを判断します。
`moveTo(destination)`	`Folder`	このアイテムを指定された移動先フォルダに移動します。
`removeEditor(emailAddress)`	`Folder`	指定されたユーザーを `Folder` の編集者リストから削除します。
`removeEditor(user)`	`Folder`	指定されたユーザーを `Folder` の編集者リストから削除します。
`removeViewer(emailAddress)`	`Folder`	指定されたユーザーを `Folder` の視聴者とコメント投稿者のリストから削除します。
`removeViewer(user)`	`Folder`	指定されたユーザーを `Folder` の視聴者とコメント投稿者のリストから削除します。
`revokePermissions(emailAddress)`	`Folder`	指定されたユーザーに付与された `Folder` へのアクセス権を取り消します。
`revokePermissions(user)`	`Folder`	指定されたユーザーに付与された `Folder` へのアクセス権を取り消します。
`searchFiles(params)`	`FileIterator`	現在のフォルダの子で、指定された検索条件に一致するすべてのファイルのコレクションを取得します。
`searchFolders(params)`	`FolderIterator`	現在のフォルダの子フォルダで、指定された検索条件に一致するすべてのフォルダのコレクションを取得します。
`setDescription(description)`	`Folder`	`Folder` の説明を設定します。
`setName(name)`	`Folder`	`Folder` の名前を設定します。
`setOwner(emailAddress)`	`Folder`	`Folder` のオーナーを変更します。
`setOwner(user)`	`Folder`	`Folder` のオーナーを変更します。
`setSecurityUpdateEnabled(enabled)`	`Folder`	リンクを使用して共有されたときに、`Folder` がアクセスにリソースキーを必要とするかどうかを設定します。
`setShareableByEditors(shareable)`	`Folder`	`Folder` の編集権限を持つユーザーが他のユーザーと共有したり、権限を変更したりできるかどうかを設定します。
`setSharing(accessType, permissionType)`	`Folder`	明示的にアクセス権が付与された個々のユーザーを除き、どのクラスのユーザーが `Folder` にアクセスできるか、また、それらのユーザーにどのような権限が付与されるかを設定します。
`setStarred(starred)`	`Folder`	ユーザーのドライブで `Folder` にスターを付けるかどうかを設定します。
`setTrashed(trashed)`	`Folder`	`Folder` がユーザーのドライブのゴミ箱にあるかどうかを設定します。

`FolderIterator`

メソッド

メソッド	戻り値の型	概要
`getContinuationToken()`	`String`	後でこのイテレーションを再開するために使用できるトークンを取得します。
`hasNext()`	`Boolean`	`next()` の呼び出しでアイテムが返されるかどうかを判断します。
`next()`	`Folder`	ファイルまたはフォルダのコレクション内の次のアイテムを取得します。

`Permission`

プロパティ

プロパティ	タイプ	説明
`VIEW`	`Enum`	ファイルやフォルダにアクセスできるユーザーは、閲覧またはコピーのみを行うことができます。
`EDIT`	`Enum`	ファイルやフォルダにアクセスできるユーザーは、そのファイルやフォルダを編集できます。
`COMMENT`	`Enum`	ファイルやフォルダにアクセスできるユーザーは、閲覧、コピー、コメントの追加のみを行うことができます。
`OWNER`	`Enum`	ユーザーがファイルまたはフォルダのオーナーである。
`ORGANIZER`	`Enum`	共有ドライブ内のファイルやフォルダを整理できるユーザー。
`FILE_ORGANIZER`	`Enum`	共有ドライブ内のコンテンツの編集、ゴミ箱への移動、移動ができるユーザー。
`NONE`	`Enum`	ユーザーには、ファイルまたはフォルダに対する権限がありません。

`User`

メソッド

メソッド	戻り値の型	概要
`getDomain()`	`String\|null`	ユーザーのアカウントに関連付けられているドメイン名を取得します。
`getEmail()`	`String\|null`	ユーザーのメールアドレスを取得します。
`getName()`	`String\|null`	ユーザーの名前を取得します。
`getPhotoUrl()`	`String\|null`	ユーザーの写真の URL を取得します。

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

クラス

プロパティ

プロパティ

メソッド

メソッド

メソッド

メソッド

メソッド

プロパティ

メソッド

Drive Service