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

Class File

Google ドライブ内のファイル。ファイルは DriveApp からアクセスまたは作成できます。

// Trash every untitled spreadsheet that hasn't been updated in a week.
var files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  var file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

メソッド

メソッド	戻り値の型	概要
`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` をユーザーのドライブのゴミ箱に入れるかどうかを設定します。

詳細なドキュメント

`addCommenter(emailAddress)`

指定されたユーザーを File の閲覧者（コメント可）のリストに追加します。ユーザーが閲覧者のリストにすでに含まれている場合、このメソッドでは閲覧者のリストからユーザーを昇格できます。

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'cloudysanfrancisco@gmail.com' with the email address that you
// want to add as a commenter.
while (files.hasNext()) {
  const file = files.next();
  email = 'cloudysanfrancisco@gmail.com';
  console.log(file.addCommenter(email));
}

パラメータ

名前	型	説明
`emailAddress`	`String`	追加するユーザーのメールアドレス。

戻る

File - この File（チェーン用）。

承認

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

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

`addCommenter(user)`

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

// Adds the active user as a commenter.
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter(Session.getActiveUser());
}

パラメータ

名前	型	説明
`user`	`User`	追加するユーザーの表現。

戻る

File - この File（チェーン用）。

承認

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

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

`addCommenters(emailAddresses)`

指定されたユーザーの配列を File の閲覧者（コメント可）のリストに追加します。該当する場合のユーザーがすでに閲覧者リストに含まれていた場合、この方法はできます。

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

while (files.hasNext()) {
  const file = files.next();
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and
  // 'baklavainthebalkans@gmail.com' with the email addresses to add as commenters.
  const emails = ['cloudysanfrancisco@gmail.com','baklavainthebalkans@gmail.com'];
  console.log(file.addCommenters(emails));
}

パラメータ

名前	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

戻る

File - この File（チェーン用）。

承認

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

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

`addEditor(emailAddress)`

指定されたユーザーを File の編集者のリストに追加します。ユーザーがすでに閲覧者のリストに含まれていた場合、このメソッドでは閲覧者のリストからユーザーを昇格できます。

パラメータ

名前	型	説明
`emailAddress`	`String`	追加するユーザーのメールアドレス。

戻る

File - この File（チェーン用）。

承認

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

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

`addEditor(user)`

パラメータ

名前	型	説明
`user`	`User`	追加するユーザーの表現。

戻る

File - この File（チェーン用）。

承認

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

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

`addEditors(emailAddresses)`

指定されたユーザー配列を File の編集者のリストに追加します。もしユーザーがすでに閲覧者リストに含まれていた場合、この方法では閲覧者リストから昇格します。できます。

パラメータ

名前	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

戻る

File - この File（チェーン用）。

承認

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

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

`addViewer(emailAddress)`

指定したユーザーを File の閲覧者のリストに追加します。ユーザーがすでにエディタのリストに含まれていると、このメソッドは機能しません。

パラメータ

名前	型	説明
`emailAddress`	`String`	追加するユーザーのメールアドレス。

戻る

File - この File（チェーン用）。

承認

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

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

`addViewer(user)`

指定したユーザーを File の閲覧者のリストに追加します。ユーザーがすでにエディタのリストに含まれていると、このメソッドは機能しません。

パラメータ

名前	型	説明
`user`	`User`	追加するユーザーの表現。

戻る

File - この File（チェーン用）。

承認

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

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

`addViewers(emailAddresses)`

指定されたユーザーの配列を File の閲覧者のリストに追加します。もしユーザーがすでに編集者リストに含まれていた場合、このメソッドでは効果がありません。

パラメータ

名前	型	説明
`emailAddresses`	`String[]`	追加するユーザーのメールアドレスの配列。

戻る

File - この File（チェーン用）。

承認

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

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

`getAccess(email)`

特定のユーザーに付与されている権限を取得します。

パラメータ

名前	型	説明
`email`	`String`	権限を確認するユーザーのメールアドレス

戻る

Permission - ユーザーに付与されている権限

承認

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

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

`getAccess(user)`

特定のユーザーに付与されている権限を取得します。

パラメータ

名前	型	説明
`user`	`User`	権限を確認する必要があるユーザーの表現

戻る

Permission - ユーザーに付与されている権限

承認

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

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

`getAs(contentType)`

このオブジェクト内のデータを、指定されたコンテンツタイプに変換された blob として返します。このメソッドにより、ファイル名に適切な拡張子（例: myfile.pdf）が追加されます。ただし、ファイル名の最後のピリオド（ある場合）に続く部分は、指定します。したがって、「ShoppingList.12.25.2014」となります。が以下に変換される: 「ShoppingList.12.25.pdf」

コンバージョンの 1 日あたりの割り当てを確認するには、Google Cloud の割り当てサービス。新しく作成された Google Workspace ドメインには一時的に厳格なできます。

パラメータ

名前	型	説明
`contentType`	`String`	変換先の MIME タイプ。ほとんどの blob の場合、`'application/pdf'` は次のようになります。唯一の有効な選択肢となりますBMP、GIF、JPEG、PNG 形式の画像の場合は、`'image/bmp'`、`'image/gif'`、`'image/jpeg'`、`'image/png'` のいずれかも可有効です。Google ドキュメントのドキュメントの場合は、`'text/markdown'` も有効です。

戻る

Blob - blob としてのデータ。

`getBlob()`

このオブジェクト内のデータを blob として返します。

戻る

Blob - blob としてのデータ。

`getDateCreated()`

File が作成された日付を取得します。

戻る

Date - File の作成日

承認

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

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

`getDescription()`

File の説明を取得します。

戻る

String - File の説明

承認

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

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

`getDownloadUrl()`

ファイルのダウンロードに使用できる URL を取得します。ファイルを開く権限があるユーザーのみその URL にアクセスできます。ブラウザでこの URL を使用してファイルをダウンロードできますが、 UrlFetchApp でファイルを取得するために使用することはできません。URL の内容が getBlob() を使用します。

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

// Loops through the files and logs the download URLs to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getDownloadUrl());
}

戻る

String - ファイルのダウンロードに使用できる URL。

承認

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

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

`getEditors()`

この File の編集者のリストを取得します。スクリプトを実行するユーザーが File に対する編集権限がない場合、このメソッドは空の配列を返します。

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Adds the email addresses in the array as editors of each file.
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com'
  // and 'baklavainthebalkans@gmail.com' with valid email addresses.
  file.addEditors(['cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com']);

  // Gets a list of the file editors.
  const editors = file.getEditors();

  // For each file, logs the editors' email addresses to the console.
  for (const editor of editors) {
    console.log(editor.getEmail());
  }
}

戻る

User[] - ユーザーがこの File の編集権限を持っている場合、。ユーザーに編集権限がない場合は、空の配列を返します。

承認

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

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

`getId()`

File の ID を取得します。

戻る

String - File の ID

承認

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

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

`getLastUpdated()`

File が最後に更新された日付を取得します。

戻る

Date - File が最後に更新された日付

承認

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

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

`getMimeType()`

ファイルの MIME タイプを取得します。

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

// Loops through the files and logs the MIME type to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getMimeType());
}

戻る

String - ファイルの MIME タイプ。

承認

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

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

`getName()`

File の名前を取得します。

戻る

String - File の名前

承認

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

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

`getOwner()`

ファイルのオーナーを取得します。

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

// Loops through the files and logs the names of the file owners to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getOwner().getName());
}

戻る

User - ファイルのオーナー。

承認

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

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

`getParents()`

File の直接の親であるフォルダのコレクションを取得します。

戻る

FolderIterator - File の直接の親であるフォルダのコレクション

承認

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

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

`getResourceKey()`

次のアイテムにアクセスするために必要な File のリソースキーを取得します。リンクを使用して共有されました。

戻る

String - File のリソースキー。

承認

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

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

`getSecurityUpdateEligible()`

この File が、次のセキュリティアップデートの適用対象となるかどうかを取得しますリンクを使用して共有する場合、アクセスのためにリソースキーが必要です。

Google ドライブで共有されたファイルやフォルダにアクセスするには、リソースキーが必要です。表示されます。この変更はセキュリティアップデートの一環です。対象デバイスの場合、アップデートはデフォルトでオンになっています。管理できます。対象となるファイルに対してリソースキーの要件を有効または無効にするには、次のコマンドを使用します。 setSecurityUpdateEnabled。

詳しくは、Google ドライブのセキュリティアップデートをご覧ください。

戻る

Boolean - File にリソースキーの要件を適用できるかどうか。

承認

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

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

`getSecurityUpdateEnabled()`

この File にアクセスするためにリソースキーが必要かどうかを取得します。リンクを使用して共有しています。この要件は、対象となるファイルとフォルダに対してデフォルトでオンになっています。適格ファイルに対してリソースキーの要件を有効または無効にするには、setSecurityUpdateEnabled を使用します。

詳しくは、Google ドライブのセキュリティアップデートをご覧ください。

戻る

Boolean - この File に対してリソースキーの要件を有効にするかどうか。

承認

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

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

`getSharingAccess()`

File にアクセスできるユーザーのクラスを取得します。また、個々のクラスも取得します。ユーザーが含まれます。

戻る

Access - File にアクセスできるユーザーのクラス

承認

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

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

`getSharingPermission()`

File にアクセスできるユーザーに付与されている権限を取得します。明示的にアクセス権を付与された個々のユーザーは含まれません。

戻る

Permission - File にアクセスできるユーザーに付与される権限

承認

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

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

`getSize()`

File をドライブに保存するために使用されているバイト数を取得します。注: Google Workspace のアプリケーションファイルはドライブストレージの上限にはカウントされず、 0 バイト。

戻る

Integer - File をドライブに保存するために使用するバイト数

承認

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

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

`getTargetId()`

ショートカットの場合は、そのアイテムの ID を返します。

それ以外の場合は、null を返します。

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the target ID of the shortcut.
console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);

戻る

String - 対象商品アイテムの ID。

`getTargetMimeType()`

ショートカットの場合は、そのアイテムの MIME タイプを返します。

それ以外の場合は、null を返します。

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the MIME type of the file that the shortcut points to.
console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);

戻る

String - 対象アイテムの MIME タイプ。

`getTargetResourceKey()`

ファイルがショートカットの場合は、そのファイルが指しているアイテムのリソースキーを返します。リソースキーは、追加のパラメータです。このパラメータは、表示されます。

ファイルがショートカットでない場合は、null を返します。

// Gets a file by its ID.
// TODO(developer): Replace 'abc123456' with your file ID.
const file = DriveApp.getFileById('abc123456');

// If the file is a shortcut, returns the resource key of the file that it points to.
console.log(file.getTargetResourceKey());

戻る

String - 対象アイテムのリソースキー。ファイルがショートカットでない場合は null。

承認

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

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

`getThumbnail()`

ファイルのサムネイル画像を取得します。サムネイルが存在しない場合は null です。

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Logs the thumbnail image for each file to the console as a blob,
  // or null if no thumbnail exists.
  console.log(file.getThumbnail());
}

戻る

Blob - ファイルのサムネイル画像。

承認

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

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

`getUrl()`

次のような Google アプリで File を開くために使用できる URL を取得します。ドライブまたはドキュメントです。

戻る

String - 次のような Google アプリでこの File を表示するために使用できる URL ドライブまたはドキュメント

承認

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

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

`getViewers()`

この File の閲覧者とコメント投稿者のリストを取得します。操作したユーザーがスクリプトを実行する場合、File に対する編集権限がない場合、このメソッドでは空の配列を返します。

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // For each file, logs the viewers' email addresses to the console.
  const viewers = file.getViewers();
  for (viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

戻る

User[] - ユーザーがこの File の編集権限を持っている場合、閲覧者とコメント投稿者ユーザーに編集権限がない場合は、空の配列を返します。

承認

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

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

`isShareableByEditors()`

File の編集権限を持つユーザーに許可するかどうかを指定します他のユーザーとの共有や権限の変更を行えます。

戻る

Boolean - 編集権限を持つユーザーが他のユーザーとの共有が許可されている場合は、true 権限を変更する。含まれていない場合は false

承認

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

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

`isStarred()`

ユーザーのドライブで File にスターが付いているかどうかを確認します。

戻る

Boolean - ユーザーのドライブで File にスターが付いている場合は true。そうでない場合は false

承認

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

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

`isTrashed()`

File がユーザーのドライブのゴミ箱にあるかどうかを判断します。

戻る

Boolean - File がユーザーのドライブのゴミ箱にある場合は true。そうでない場合は false

承認

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

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

`makeCopy()`

ファイルのコピーを作成します。

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and logs the file name to the console.
  console.log(file.makeCopy().getName());
}

戻る

File - 新しいコピー。

承認

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

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

`makeCopy(destination)`

コピー先ディレクトリにファイルのコピーを作成します。

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and adds it to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy(destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

パラメータ

名前	型	説明
`destination`	`Folder`	ファイルのコピー先のディレクトリ。

戻る

File - 新しいコピー。

承認

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

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

`makeCopy(name)`

ファイルのコピーを作成し、指定された名前で名前を付けます。

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and sets the name to 'Test-Copy.'
  const filename = file.makeCopy('Test-Copy');

  // Logs the copied file's name to the console.
  console.log(filename.getName());
}

パラメータ

名前	型	説明
`name`	`String`	新しいコピーに適用するファイル名。

戻る

File - 新しいコピー。

承認

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

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

`makeCopy(name, destination)`

コピー先のディレクトリにファイルのコピーを作成し、指定した名前の名前を付けます。

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file, sets the file name, and adds the copied file
  // to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy('Test-Copy', destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

パラメータ

名前	型	説明
`name`	`String`	新しいコピーに適用するファイル名。
`destination`	`Folder`	ファイルのコピー先のディレクトリ。

戻る

File - 新しいコピー。

承認

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

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

`moveTo(destination)`

指定された宛先フォルダにこのアイテムを移動します。

現在のユーザーは、ファイルのオーナーであるか、アイテムの少なくとも 1 つの編集権限を持っている必要があります現在の親フォルダを変更する必要があります。

パラメータ

名前	型	説明
`destination`	`Folder`	新しい親になるフォルダ。

戻る

File - この File（チェーン用）。

承認

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

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

`removeCommenter(emailAddress)`

File のコメント投稿者のリストから、指定したユーザーを削除します。この方法はユーザーが特定のクラスに属している場合、File へのアクセスはブロックされません。たとえば、File がユーザーのユーザーと共有されている場合や、管理できます。

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  // TODO(developer): Replace the email with the email of the user you want to remove.
  file.removeCommenter('cloudysanfrancisco@gmail.com');
}

パラメータ

名前	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

戻る

File - この File（チェーン用）。

承認

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

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

`removeCommenter(user)`

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

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  console.log(file.removeCommenter(Session.getActiveUser()));
}

パラメータ

名前	型	説明
`user`	`User`	削除するユーザーの表現。

戻る

File - この File（チェーン用）。

承認

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

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

`removeEditor(emailAddress)`

File の編集者のリストから指定したユーザーを削除します。この方法では次のクラスのユーザーに属している場合、File へのアクセスをブロックします。（たとえば、File がユーザーの組織全体で共有されている場合、 File が、ユーザーがアクセスできる共有ドライブ内にあるかどうかも確認できます。

ドライブのファイルの場合、閲覧者のリストからユーザーが削除されます。

パラメータ

名前	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

戻る

File - この File（チェーン用）。

承認

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

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

`removeEditor(user)`

ドライブのファイルの場合、閲覧者のリストからユーザーが削除されます。

パラメータ

名前	型	説明
`user`	`User`	削除するユーザーの表現。

戻る

File - この File（チェーン用）。

承認

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

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

`removeViewer(emailAddress)`

File の閲覧者と閲覧者（コメント可）のリストから指定したユーザーを削除します。このユーザーが編集者であり、閲覧者でもコメント投稿者でもない場合、メソッドは効果がありません。この方法でもは、所属するユーザーが次のクラスのユーザーに属している場合でも、File へのアクセスをブロックしません。一般的なアクセス権を持っている（たとえば、File がユーザーのまたは、File が、ユーザーがアクセスできる共有ドライブ内にあるかどうかを指定できます。

ドライブのファイルの場合は、編集者のリストからユーザーが削除されます。

パラメータ

名前	型	説明
`emailAddress`	`String`	削除するユーザーのメールアドレス。

戻る

File - このチェーン用の File。

承認

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

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

`removeViewer(user)`

File の閲覧者と閲覧者（コメント可）のリストから指定したユーザーを削除します。このメソッドは、ユーザーが編集者であって閲覧者ではない場合は機能しません。この方法では一般的なユーザークラスに属するユーザーは、File にアクセスできないたとえば、File がユーザーのドメイン全体と共有されている場合、または File が、ユーザーがアクセスできる共有ドライブ内にあるかどうか。

ドライブのファイルの場合は、編集者のリストからユーザーが削除されます。

パラメータ

名前	型	説明
`user`	`User`	削除するユーザーの表現。

戻る

File - このチェーン用の File。

承認

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

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

`revokePermissions(emailAddress)`

指定されたユーザーに付与されている File へのアクセス権を取り消します。この方法ではユーザーが次のクラスのユーザーに属する場合、File へのアクセスをブロックする一般的なアクセス権を持っている（たとえば、File がユーザーの管理できます。

パラメータ

名前	型	説明
`emailAddress`	`String`	アクセス権を取り消すユーザーのメールアドレス。

戻る

File - この File（チェーン用）。

承認

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

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

`revokePermissions(user)`

指定されたユーザーに付与されている File へのアクセス権を取り消します。この方法ではユーザーが次のクラスのユーザーに属する場合、File へのアクセスをブロックする一般的なアクセス権を持っている（たとえば、File がユーザーの提供します。

パラメータ

名前	型	説明
`user`	`User`	アクセス権を取り消す必要があるユーザーの表現。

戻る

File - この File（チェーン用）。

承認

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

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

`setContent(content)`

ファイルの内容を指定した置換で上書きします。content が 10 MB より大きい場合、例外をスローします。

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

// Logs the content of the text file to the console.
console.log(file.getBlob().getDataAsString());

// Updates the content of the text file to 'Updated text!'
file.setContent('Updated text!')

// Logs content of the text file to the console.
console.log(file.getBlob().getDataAsString());

パラメータ

名前	型	説明
`content`	`String`	ファイルの新しい内容。

戻る

File - この File（チェーン用）。

承認

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

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

`setDescription(description)`

File の説明を設定します。

パラメータ

名前	型	説明
`description`	`String`	`File` の新しい説明

戻る

File - この File（チェーン用）

承認

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

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

`setName(name)`

File の名前を設定します。

パラメータ

名前	型	説明
`name`	`String`	`File` の新しい名前

戻る

File - この File（チェーン用）

承認

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

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

`setOwner(emailAddress)`

File のオーナーを変更します。この方法では、以前の所有者にも File に対する明示的な編集権限。

パラメータ

名前	型	説明
`emailAddress`	`String`	新しいオーナーになるユーザーのメールアドレス

戻る

File - この File（チェーン用）

承認

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

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

`setOwner(user)`

File のオーナーを変更します。この方法では、以前の所有者にも File に対する明示的な編集権限。

パラメータ

名前	型	説明
`user`	`User`	新しいオーナーになるユーザーを表す

戻る

File - この File（チェーン用）

承認

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

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

`setSecurityUpdateEnabled(enabled)`

File のアクセスにリソースキーが必要かどうかを設定しますリンクを使用して共有しています。対象となるファイルとフォルダはデフォルトで有効になっています。

詳しくは、Google ドライブのセキュリティアップデートをご覧ください。

パラメータ

名前	型	説明
`enabled`	`Boolean`	`File` のリソースキー要件を有効にするかどうか。

戻る

File - この File（チェーン用）。

承認

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

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

`setShareableByEditors(shareable)`

File の編集権限を持つユーザーに共有を許可するかどうかを設定します権限を変更したりできます。新しい File のデフォルトは次のとおりです。 true。

パラメータ

名前	型	説明
`shareable`	`Boolean`	`true`: 編集権限を持つユーザーに共有を許可する場合は、他のユーザーに対する変更または権限の変更を行うそうでない場合は `false`

戻る

File - この File（チェーン用）

承認

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

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

`setSharing(accessType, permissionType)`

File にアクセスできるユーザーのクラスと権限を設定します。明示的に許可された個々のユーザーを除き、これらのユーザーにも付与されます。

// Creates a folder that anyone on the Internet can read from and write to. (Domain
// administrators can prohibit this setting for users of a Google Workspace domain.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

パラメータ

名前	型	説明
`accessType`	`Access`	`File` にアクセスできるユーザーのクラス
`permissionType`	`Permission`	`File` にアクセスできるユーザーに付与する権限

戻る

File - この File（チェーン用）

承認

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

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

`setStarred(starred)`

ユーザーのドライブで File にスターを付けるかどうかを設定します。デフォルトの新しいFileはfalseです。

パラメータ

名前	型	説明
`starred`	`Boolean`	ユーザーのプロフィールで `File` にスターを付ける場合は `true` ドライブ含まれていない場合は `false`

戻る

File - この File（チェーン用）

承認

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

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

`setTrashed(trashed)`

File をユーザーのドライブのゴミ箱に入れるかどうかを設定します。オーナーが File をゴミ箱に移動できます。新しい File のデフォルト値は false です。

パラメータ

名前	型	説明
`trashed`	`Boolean`	`File` を次のフォルダのゴミ箱に移動する場合は `true` ユーザーのドライブ含まれていない場合は `false`

戻る

File - この File（チェーン用）

承認

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

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