今日からGoogleドライブで使えるGASのコード一覧

  • このエントリーをはてなブックマークに追加
  • Pocket
  • LINEで送る
Google Drive Icon
スポンサーリンク

DriveAppの概要

DriveAppとは、Google Apps ScriptでGoogleドライブ上のファイルやフォルダを扱うために利用するコードのことです。DriveAppに用意されているメソッドを利用すれば、Googleドライブ上のファイルやフォルダを作成したり、編集したり、検索したりというような処理を実行することができます。

クラス名一覧

DriveAppFileFileIteratorFolder
FolderIteratorUser

※クリックすると対象場所にジャンプします

列挙型一覧

AccessPermission

※クリックすると対象場所にジャンプします

クラス別メソッド名一覧

Class DriveApp

メソッド名返り値簡単な説明
addFileFolderマイドライブにファイルを所属させる
addFolderFolderマイドライブにフォルダを所属させる
continueFileIteratorFileIteratorトークンを使ってファイルイテレータを途中から再開させる
continueFolderIteratorFolderIteratorトークンを使ってフォルダイテレータを途中から再開させる
createFileFileマイドライブにファイルを作成する
createFolderFolderマイドライブにフォルダを作成する
getFileByIdFileファイルIDでファイルを取得する
getFilesFileIteratorマイドライブ直下のすべてのファイルを取得する
getFilesByNameFileIteratorマイドライブ直下で指定した名前のファイルをすべて取得する
getFilesByTypeFileIteratorマイドライブ直下の指定した形式のファイルをすべて取得する
getFolderByIdFolderフォルダIDでフォルダを取得する
getFoldersFolderIteratorマイドライブ直下のフォルダをすべて取得する
getFoldersByNameFolderIteratorマイドライブ直下で指定した名前のフォルダをすべて取得する
getRootFolderFolderマイドライブを取得
getStorageLimitIntegerストレージの上限値を取得する
getStorageUsedInteger使用済みストレージ容量を取得する
getTrashedFilesFileIteratorゴミ箱に入っているファイルをすべて取得する
getTrashedFoldersFolderIteratorゴミ箱に入っているフォルダをすべて取得する
removeFileFolderファイルからマイドライブの所属を削除する
removeFolderFolderフォルダからマイドライブの所属を削除する
searchFilesFileIterator条件に合致するファイルを取得する
searchFoldersFolderIterator条件に合致するフォルダを取得する

Class File

メソッド名返り値簡単な説明
addCommenterFileコメント者を追加
addEditorFile編集者を追加
addViewerFile閲覧者を追加
getAccessPermission対象アカウントのアクセス権限を取得
getAsBlobファイル形式を変換してBlobを取得
getBlobBlobBlobを取得
getDateCreatedDateファイル作成日を取得
getDescriptionStringファイルの説明を取得
getDownloadUrlStringダウンロード用URLを取得
getEditorsUser[]編集者を配列で取得
getIdStringファイルIDを取得
getLastUpdatedDate最終更新日を取得
getMimeTypeStringMimeTypeを取得
getNameStringファイル名を取得
getOwnerUserオーナーアカウントを取得
getParentsFolderIterator親フォルダを取得
getSharingAccessAccess共有権限を取得
getSharingPermissionPermission共有アカウントの共有権限を取得
getSizeIntegerファイルサイズを取得
getThumbnailBlobサムネイル画像を取得
getUrlStringファイルのURLを取得
getViewersUser[]閲覧者を配列で取得
isShareableByEditorsBoolean編集者が他のユーザーにファイルを共有できるかを真偽値で取得
isStarredBooleanスター付きかどうかを真偽値で取得
isTrashedBooleanゴミ箱に入れられているかを真偽値で取得
makeCopyFileファイルをコピーする
removeCommenterFileコメント者を削除する
removeEditorFile編集者を削除する
removeViewerFile閲覧者を削除する
revokePermissionsFile対象アカウントから共有権限を削除する
setContentFileファイル内容を上書きする
setDescriptionFile説明を追加する
setNameFileファイル名を設定する
setOwnerFileオーナーを設定する
setShareableByEditorsFile編集者が他のユーザーにファイルを共有できるかを設定する
setSharingFile共有権限を設定する
setStarredFileスターをつける
setTrashedFileゴミ箱に捨てる

Class FileIterator

メソッド名返り値簡単な説明
getContinuationTokenStringあとで再開用のトークンを取得
hasNextBooleannextでファイルが返されるかを真偽値で取得
nextFile次のファイルを取得

Class Folder

メソッド名返り値簡単な説明
addEditorFolder編集者を追加
addViewerFolder閲覧者を追加
addFileFolderフォルダにファイルを追加
addFolderFolderフォルダに子フォルダを追加
addViewerFolder閲覧者を追加
createFileFileファイルを作成する
createFolderFolderフォルダを作成する
getAccessPermission対象アカウントのアクセス権限を取得
getDateCreatedDateファイル作成日を取得
getDescriptionStringファイルの説明を取得
getEditorsUser[]編集者を配列で取得
getFilesFileIteratorすべてのファイルを取得
getFilesByNameFileIterator指定した名前のファイルをすべて取得する
getFilesByTypeFileIterator指定した形式のファイルをすべて取得する
getFoldersFolderIterator子フォルダをすべて取得する
getFoldersByNameFolderIterator指定した名前のフォルダをすべて取得する
getIdStringファイルIDを取得
getLastUpdatedDate最終更新日を取得
getNameStringファイル名を取得
getOwnerUserオーナーアカウントを取得
getParentsFolderIterator親フォルダを取得
getSharingAccessAccess共有権限を取得
getSharingPermissionPermission共有アカウントの共有権限を取得
getSizeIntegerフォルダサイズを取得
getUrlStringファイルのURLを取得
getViewersUser[]閲覧者を配列で取得
isShareableByEditorsBoolean編集者が他のユーザーにファイルを共有できるかを真偽値で取得
isStarredBooleanスター付きかどうかを真偽値で取得
isTrashedBooleanゴミ箱に入れられているかを真偽値で取得
removeEditorFolder編集者を削除する
removeFileFolderファイルからフォルダの所属を削除する
removeFolderFolderフォルダからフォルダの所属を削除する
removeViewerFolder閲覧者を削除する
revokePermissionsFolder対象アカウントから共有権限を削除する
searchFilesFileIterator条件に合致するファイルを取得する
searchFoldersFolderIterator条件に合致するフォルダを取得する
setDescriptionFolder説明を追加する
setNameFolderフォルダ名を設定する
setOwnerFolderオーナーを設定する
setShareableByEditorsFolder編集者が他のユーザーにフォルダを共有できるかを設定する
setSharingFolder共有権限を設定する
setStarredFolderスターをつける
setTrashedFolderゴミ箱に捨てる

Class FolderIterator

メソッド名返り値簡単な説明
getContinuationTokenStringあとで再開用のトークンを取得
hasNextBooleannextでフォルダが返されるかを真偽値で取得
nextFolder次のフォルダを取得

Class User

メソッド名返り値簡単な説明
getDomainStringユーザーアカウントのドメインを取得
getEmailStringアドレスを取得
getNameStringユーザー名を取得
getPhotoUrlStringユーザーの写真URLを取得

列挙型名一覧

Enums Access

この列挙型はアカウントに対してアクセス許可をされた個々のユーザーとは別に、ファイルやフォルダにアクセスできるユーザーのクラスを表して言います。下記表のプロパティ名はDriveApp.Access.プロパティ名という形で利用することができます。

DriveApp.Accessサンプル
//マイドライブ直下に『共有フォルダ』というフォルダを作成し、
//誰でも編集ができる状態に設定します。ログインは必要ありません。
//(ドメイン管理者はドメイン内のGSuiteユーザーに対してこの設定を
//禁止することができます。
var folder = DriveApp.createFolder("共有フォルダ");
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
プロパティタイプ説明
ANYONEEnumインターネットに接続できるユーザーであれば誰でも検索やアクセスができます。ログインは必要ありません。ドメイン管理者はこの設定を無効にすることができます。その場合、このプロパティを設定しようとするとエラーになります。
ANYONE_WITH_LINKEnumインターネットに接続でき、リンクを知っているユーザーであれば誰でもアクセスができます。ログインは必要ありません。ドメイン管理者はこの設定を無効にすることができます。その場合、このプロパティを設定しようとするとエラーになります。
DOMAINEnum同一ドメイン内のユーザーであれば誰でも検索やアクセスができます。ログインが必要です。この設定にはGSuiteドメインが必要です。ドメイン管理者はこの設定を無効にすることができます。その場合、このプロパティを設定しようとするとエラーになります。
DOMAIN_WITH_LINKEnum同一ドメインで、リンクを知っているユーザーであれば誰でもアクセスができます。ログインが必要です。この設定にはGSuiteドメインが必要です。ドメイン管理者はこの設定を無効にすることができます。その場合、このプロパティを設定しようとするとエラーになります。
PRIVATEEnum共有権限を付与されたユーザーのみアクセスすることができます。アクセスにはログインが必要です。

Enums Permission

この列挙型はアカウントに対してアクセス許可をされた個々のユーザーとは別に、ファイルやフォルダに対するユーザーの権限を表して言います。下記表のプロパティ名はDriveApp.Permission.プロパティ名という形で利用することができます。

DriveApp.Permissionサンプル
//マイドライブ直下に『共有フォルダ』というフォルダを作成し、
//誰でも編集ができる状態に設定します。ログインは必要ありません。
//(ドメイン管理者はドメイン内のGSuiteユーザーに対してこの設定を
//禁止することができます。
var folder = DriveApp.createFolder("共有フォルダ");
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
プロパティタイプ説明
VIEWEnumアクセスできるユーザーに対して閲覧権限を付与します。
EDITEnumアクセスできるユーザーに対して編集権限を付与します。File.setShareableByEditorsでfalseに設定されてない限り、編集ユーザーは共有権限を変更することができます。
COMMENTEnumアクセスできるユーザーに対してコメント権限を付与します。コメント権限を持っているユーザーは閲覧、コピー、コメントを残す機能が利用できます。
OWNEREnumファイルやフォルダのオーナーの場合はこのプロパティが返り値として取得されます。File.setSharingでこの値を渡すとエラーになります。
ORGANIZEREnum共有ドライブのコンテンツ管理者の場合はこのプロパティが返り値として取得されます。File.setSharingでこの値を渡すとエラーになります。
NONEEnumユーザーはファイルやフォルダに対していずれの権限も持っていない場合にこのプロパティが返り値として取得されます。File.setSharingでこの値を渡すとAccess.ANYONEと一緒に渡さない限りエラーになります。

SNSでもご購読できます。

商標および、登録商標について

Googleおよび、Googleロゴおよび、Googleドライブおよび、Googleドキュメントおよび、Googleフォトおよび、Googleスプレッドシートおよび、Googleサイトおよび、GoogleスライドおよびGmailおよび、Googleマップおよび、Googleタスクおよび、Google WorkspaceはGoogle LLCの登録商標です。

本サイトのコンテンツはいかなる場合においても、Googleから公式に提携及び承認されているわけではありません。