Class DriveApp

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

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());
}

Properties

プロパティ種類説明
AccessAccess明示的にアクセス権を付与された個々のユーザーを除き、ファイルやフォルダにアクセスできるユーザーのクラスを表す列挙型。
PermissionPermission明示的にアクセス権を付与された個々のユーザーだけでなく、ファイルまたはフォルダにアクセスできるユーザーに付与された権限を表す列挙型。

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指定した検索条件に一致するユーザーのドライブ内にあるすべてのフォルダのコレクションを取得します。

詳細なドキュメント

continueFileIterator(continuationToken)

前のイテレータの継続トークンを使用して、ファイルの反復処理を再開します。この方法は、1 つの実行でイテレータの処理が最大実行時間を超える場合に便利です。継続トークンは通常 1 週間有効です。

パラメータ

名前説明
continuationTokenString前のファイル イテレータからの継続トークン

戻る

FileIterator - 継続トークンの生成時に前のイテレータに残ったファイルのコレクション


continueFolderIterator(continuationToken)

前のイテレータの継続トークンを使用して、フォルダの反復処理を再開します。この方法は、1 つの実行でイテレータの処理が最大実行時間を超える場合に便利です。継続トークンは通常 1 週間有効です。

パラメータ

名前説明
continuationTokenString前のフォルダ イテレータの継続トークン

戻る

FolderIterator - 継続トークンの生成時に前のイテレータに残ったフォルダのコレクション


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.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.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.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

enforceSingleParent(value)

アイテムの親に影響を与えるすべての呼び出しに対する applySingleParent 動作を有効または無効にします。

詳しくは、Google ドライブのフォルダ構造の簡素化とモデルの共有に関するブログをご覧ください。

パラメータ

名前説明
valueBooleanforceSingleParent フラグの新しい状態。

認可

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

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

getFileById(id)

指定された ID のファイルを取得します。ファイルが存在しない場合、またはユーザーにファイルへのアクセス権限がない場合、スクリプト例外をスローします。

パラメータ

名前説明
idStringファイルの ID

戻る

File - 指定された ID のファイル

認可

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

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

getFileByIdAndResourceKey(id, resourceKey)

指定された ID とリソースキーを持つファイルを取得します。リソースキーは、リンクを使用して共有されているファイルにアクセスするために渡す追加のパラメータです。

ファイルが存在しない場合、またはユーザーがファイルへのアクセス権限を持っていない場合に、スクリプトの例外をスローします。

パラメータ

名前説明
idStringファイルの ID。
resourceKeyStringフォルダのリソースキー。

戻る

File - 指定された ID のファイル。

認可

このメソッドを使用するスクリプトには、次の 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

getFolderById(id)

指定された ID のフォルダを取得します。フォルダが存在しない場合、またはユーザーにフォルダへのアクセス権がない場合は、スクリプト例外をスローします。

パラメータ

名前説明
idStringフォルダの ID

戻る

Folder - 指定された ID のフォルダ

認可

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

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

getFolderByIdAndResourceKey(id, resourceKey)

指定された ID とリソースキーを持つフォルダを取得します。リソースキーは、リンクを使用して共有フォルダにアクセスするために渡す追加のパラメータです。

フォルダが存在しない場合、またはユーザーにフォルダへのアクセス権がない場合は、スクリプト例外をスローします。

パラメータ

名前説明
idStringフォルダの ID。
resourceKeyStringフォルダのリソースキー。

戻る

Folder - 指定された ID のフォルダ。

認可

このメソッドを使用するスクリプトには、次の 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

getRootFolder()

ユーザーのドライブのルートフォルダを取得します。

戻る

Folder - ユーザーのドライブのルート フォルダ

認可

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

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

getStorageLimit()

ユーザーがドライブに保存できるバイト数を取得します。

戻る

Integer - ユーザーがドライブに保存できるバイト数

認可

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

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

getStorageUsed()

ユーザーが現在ドライブに保存しているバイト数を取得します。

戻る

Integer - ユーザーが現在ドライブに保存しているバイト数

認可

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

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

getTrashedFiles()

ユーザーのドライブのゴミ箱にあるすべてのファイルのコレクションを取得します。

戻る

FileIterator - ゴミ箱内のファイルのコレクション

認可

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

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

getTrashedFolders()

ユーザーのドライブのゴミ箱にあるすべてのフォルダのコレクションを取得します。

戻る

FolderIterator - ゴミ箱内のフォルダのコレクション

認可

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

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

searchFiles(params)

指定された検索条件に一致するユーザーのドライブ内にあるすべてのファイルのコレクションを取得します。検索条件の詳細については、Google ドライブ SDK のドキュメントをご覧ください。params 引数は文字列値を含むクエリ文字列であるため、引用符を正しくエスケープするよう注意してください(例: "title contains 'Gulliver\\'s Travels'"'title contains "Gulliver\'s Travels"')。

// Log the name of every file in the user's Drive that modified after February 28,
// 2013 whose name contains "untitled".
var files = DriveApp.searchFiles(
    'modifiedDate > "2013-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

パラメータ

名前説明
paramsString検索条件。詳しくは、Google ドライブ SDK のドキュメントをご覧ください。

戻る

FileIterator - 検索条件に一致するユーザーのドライブ内にあるすべてのファイルのコレクション。

認可

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

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

searchFolders(params)

指定した検索条件に一致するユーザーのドライブ内にあるすべてのフォルダのコレクションを取得します。検索条件の詳細については、Google ドライブ SDK のドキュメントをご覧ください。params 引数は文字列値を含むクエリ文字列であるため、引用符を正しくエスケープするよう注意してください(例: "title contains 'Gulliver\\'s Travels'"'title contains "Gulliver\'s Travels"')。

// Log the name of every folder in the user's Drive that you own and is starred.
var folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

パラメータ

名前説明
paramsString検索条件。詳しくは、Google ドライブ SDK のドキュメントをご覧ください。

戻る

FolderIterator - 検索条件に一致するユーザーのドライブ内にあるすべてのフォルダのコレクション。

認可

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

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

サポート終了のメソッド