このページは Cloud Translation API によって翻訳されました。

Drive Service

このサービスにより、スクリプトで Google ドライブ内のファイルとフォルダを作成、検索、変更できます。

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

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

ただし、ドライブサービスを使用してアドオンをドメイン全体でインストールするために公開し、ドメイン内または一部のユーザーに管理者がインストールした場合や、ドメイン管理者が OAuth クライアントを許可リストに登録している Apps Script がある場合は、ドライブ 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`	ファイルまたはフォルダにアクセスできるユーザーに付与される権限を表す列挙型。アクセス権が明示的に付与された個々のユーザーは含まれません。

Methods

メソッド	戻り値の型	概要
`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`	アイテムの親に影響するすべての呼び出しで forceSingleParent の動作を有効または無効にします。
`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`

Methods

メソッド	戻り値の型	概要
`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`	`File` のオーナーを取得します。
`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 アプリで `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`

Methods

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

`Folder`

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()`	`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`

Methods

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

`Permission`

プロパティ

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

`User`

Methods

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