Class DriveApp

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

// Continues getting a list of all 'Untitled document' files in the user's Drive.
// Creates a file iterator named 'previousIterator'.
const previousIterator = DriveApp.getFilesByName('Untitled document');

// Gets continuation token from the previous file iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous file iterator.
const newIterator = DriveApp.continueFileIterator(continuationToken);

// Resumes the file iteration using a continuation token from 'firstIterator' and
// logs the file name.
if (newIterator.hasNext()) {
  const file = newIterator.next();
  console.log(file.getName());
}

パラメータ

復路

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

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

// Continues getting a list of all folders in user's Drive.
// Creates a folder iterator named 'previousIterator'.
const previousIterator = DriveApp.getFolders();

// Gets continuation token from the previous folder iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous folder iterator.
const newIterator = DriveApp.continueFolderIterator(continuationToken);

// Resumes the folder iteration using a continuation token from the previous iterator and logs
// the folder name.
if (newIterator.hasNext()) {
  const folder = newIterator.next();
  console.log(folder.getName());
}

パラメータ

復路

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

任意のデータの指定された 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);

パラメータ

復路

File - 新しいファイル。

認証

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

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

ユーザーのドライブのルートに、指定した名前とコンテンツでテキスト ファイルを作成します。content が 50 MB を超えると、例外をスローします。

// Create a text file with the content "Hello, world!"
DriveApp.createFile('New Text File', 'Hello, world!');

パラメータ

復路

File - 新しいファイル。

認証

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

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

ユーザーのドライブのルートに、指定した名前、内容、MIME タイプのファイルを作成します。content が 10 MB を超えると、例外をスローします。

// Create an HTML file with the content "Hello, world!"
DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

パラメータ

復路

File - 新しいファイル。

認証

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

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

ユーザーのドライブのルートに、指定した名前のフォルダを作成します。

パラメータ

復路

Folder - 新しいフォルダ。

認証

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

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

指定したドライブ アイテム ID へのショートカットを作成して返します。

パラメータ

復路

File - 新しいショートカット。

認証

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

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

指定したドライブのアイテム ID とリソースキーへのショートカットを作成して返します。リソースキーは、リンクを使用して共有されているターゲット ファイルまたはフォルダにアクセスするために渡す必要がある追加のパラメータです。

// Creates shortcuts for all folders in the user's drive that have a specific name.
// TODO(developer): Replace 'Test-Folder' with a valid folder name in your drive.
const folders = DriveApp.getFoldersByName('Test-Folder');

// Iterates through all folders named 'Test-Folder'.
while (folders.hasNext()) {
  const folder = folders.next();

  // Creates a shortcut to the provided Drive item ID and resource key, and returns it.
  DriveApp.createShortcutForTargetIdAndResourceKey(folder.getId(), folder.getResourceKey());
}

パラメータ

復路

File - 新しいショートカット。

認証

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

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

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

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

// Turns on enforceSingleParent behavior for all calls affecting item
  parents.
DriveApp.enforceSingleParent(true);

パラメータ

認証

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

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

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

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'Test' with your file name.
const files = DriveApp.getFilesByName('Test');

if (files.hasNext()) {
  // Gets the ID of each file in the list.
  const fileId = files.next().getId();

  // Gets the file name using its ID and logs it to the console.
  console.log(DriveApp.getFileById(fileId).getName());
}

パラメータ

復路

File - 指定された ID を持つファイル。

認証

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

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

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

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

// Gets a list of all files in Drive with the given name.
// TODO(developer): Replace 'Test' with your file name.
const files = DriveApp.getFilesByName('Test');
if (files.hasNext()) {

  // Gets the first file in the list.
  const file = files.next();

  // Gets the ID and resource key.
  const key = file.getResourceKey();
  const id = file.getId();

  // Logs the file name to the console using its ID and resource key.
  console.log(DriveApp.getFileByIdAndResourceKey(id, key).getName());
}

パラメータ

復路

File - 指定された ID を持つファイル。

認証

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

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

ユーザーのドライブ内のすべてのファイルのコレクションを取得します。

復路

FileIterator - ユーザーのドライブにあるすべてのファイルのコレクション。

認証

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

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

ユーザーのドライブ内にある、指定した名前を持つすべてのファイルのコレクションを取得します。

パラメータ

復路

FileIterator - 指定した名前のユーザーのドライブ内にあるすべてのファイルのコレクション。

認証

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

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

指定した MIME タイプのユーザーのドライブ内にあるすべてのファイルのコレクションを取得します。

パラメータ

復路

FileIterator - 指定された MIME タイプでユーザーのドライブ内にあるすべてのファイルのコレクション。

認証

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

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

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

パラメータ

復路

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

認証

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

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

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

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

パラメータ

復路

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

認証

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

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

ユーザーのドライブ内のすべてのフォルダのコレクションを取得します。

復路

FolderIterator - ユーザーのドライブ内のすべてのフォルダのコレクション。

認証

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

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

ユーザーのドライブ内にある、指定した名前を持つすべてのフォルダのコレクションを取得します。

パラメータ

復路

FolderIterator - 指定した名前のユーザーのドライブ内にあるすべてのフォルダのコレクション。

認証

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

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

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

// Gets the user's My Drive folder and logs its name to the console.
console.log(DriveApp.getRootFolder().getName());

// Logs the Drive owner's name to the console.
console.log(DriveApp.getRootFolder().getOwner().getName());

復路

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

認証

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

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

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

// Gets the number of bytes the user can store in Drive and logs it to the console.
console.log(DriveApp.getStorageLimit());

復路

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

認証

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

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

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

// Gets the number of bytes the user is currently storing in Drive and logs it to the console.
console.log(DriveApp.getStorageUsed());

復路

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

認証

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

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

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

// Gets a list of all the files in the trash of the user's Drive.
const trashFiles = DriveApp.getTrashedFiles();

// Logs the trash file names to the console.
while (trashFiles.hasNext()) {
  const file = trashFiles.next();
  console.log(file.getName());
}

復路

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

認証

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

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

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

// Gets a collection of all the folders in the trash of the user's Drive.
const trashFolders = DriveApp.getTrashedFolders();

// Logs the trash folder names to the console.
while (trashFolders.hasNext()) {
  const folder = trashFolders.next();
  console.log(folder.getName());
}

復路

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

認証

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

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

指定された検索条件に一致するユーザーのドライブ内のすべてのファイルのコレクションを取得します。検索条件について詳しくは、Google ドライブ SDK のドキュメントをご覧ください。ドライブ サービスは Drive API の v2 を使用するため、一部のクエリ フィールドは v3 とは異なることに注意してください。v2 と v3 のフィールドの違いを確認します。

params 引数は、文字列値を格納できるクエリ文字列なので、引用符を正しくエスケープする必要があります（例: "title contains 'Gulliver\\'s Travels'"、'title contains "Gulliver\'s Travels"'）。

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

パラメータ

復路

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

認証

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

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

指定した検索条件に一致するユーザーのドライブ内のすべてのフォルダのコレクションを取得します。検索条件について詳しくは、Google ドライブ SDK のドキュメントをご覧ください。ドライブ サービスは Drive API の v2 を使用するため、一部のクエリ フィールドは v3 とは異なることに注意してください。v2 と v3 のフィールドの違いを確認します。

params 引数は、文字列値を格納できるクエリ文字列なので、引用符を正しくエスケープする必要があります（例: "title contains 'Gulliver\\'s Travels'"、'title contains "Gulliver\'s Travels"'）。

// Logs 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();
  console.log(folder.getName());
}

パラメータ

復路

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

認証

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

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