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

Drive Service

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

スクリプトでデフォルトの Cloud プロジェクトではなく標準の Cloud プロジェクトを使用している場合は、Drive API を手動で有効にする必要があります。標準の Cloud プロジェクトで、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 ドライブアプリをインストールして使用できなくなります。この設定により、ドライブサービスまたはドライブ拡張サービスを使用する Apps Script スクリプト、ウェブアプリ、アドオンも使用できなくなります（管理者がドライブ 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`	ショートカットの場合は、ショートカットが参照するアイテムの ID を返します。
`getTargetMimeType()`	`String`	ショートカットの場合は、ショートカットが参照するアイテムの MIME タイプを返します。
`getTargetResourceKey()`	`String`	ファイルがショートカットの場合は、そのファイルが参照するアイテムのリソースキーを返します。
`getThumbnail()`	`Blob`	ファイルのサムネイル画像を取得します。サムネイルが存在しない場合は `null` を取得します。
`getUrl()`	`String`	Google ドライブや Google ドキュメントなどの 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 ドライブや Google ドキュメントなどの 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`	ユーザーのアカウントに関連付けられているドメイン名を取得します。
`getEmail()`	`String`	ユーザーのメールアドレスを取得します。
`getName()`	`String`	ユーザーの名前を取得します。
`getPhotoUrl()`	`String`	ユーザーの写真の URL を取得します。