このページは 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 ドライブアプリをインストール、使用できなくなります。また、管理者が Drive SDK や Advanced Drive Service を使用する Apps Script スクリプト、ウェブアプリ、アドオンを使用できなくなります（管理者が Drive SDK を無効にする前に対象のアドオンやウェブアプリがインストールされている場合も同様）。

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

クラス

Name	概要
`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`	ファイルのオーナーを取得します。
`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 を取得します。