Drive Service

ドライブ

このサービスにより、スクリプトによる 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());
}

クラス

名前概要
Access明示的にアクセス権を付与された個々のユーザーを除き、ファイルやフォルダにアクセスできるユーザーのクラスを表す列挙型。
DriveAppGoogle ドライブのファイルやフォルダを作成、検索、変更できます。
FileGoogle ドライブ内のファイル。
FileIterator大量のファイルのコレクションに対してスクリプトで反復処理を行えるイテレータ。
FolderGoogle ドライブ内のフォルダ。
FolderIteratorフォルダの大規模なコレクションを反復処理するためのオブジェクトです。
Permission明示的にアクセス権を付与された個々のユーザーだけでなく、ファイルまたはフォルダにアクセスできるユーザーに付与された権限を表す列挙型。
UserGoogle ドライブ内のファイルに関連付けられているユーザー。

Access

Properties

プロパティ種類説明
ANYONEEnumインターネット上の誰でも検索やアクセスができます。
ANYONE_WITH_LINKEnumリンクを知っている全員がアクセスできます。
DOMAINEnumドメイン内のユーザーが検索、アクセスできます。
DOMAIN_WITH_LINKEnumリンクを知っているドメイン内のユーザーがアクセスできます。
PRIVATEEnum明示的に権限を付与されたユーザーだけがアクセスできます。

DriveApp

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

File

Methods

方法戻り値の型概要
addCommenter(emailAddress)File特定のユーザーを File の閲覧者(コメント可)のリストに追加します。
addCommenter(user)File特定のユーザーを File の閲覧者(コメント可)のリストに追加します。
addCommenters(emailAddresses)FileFile の指定されたユーザーをコメント投稿者のリストに追加します。
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()DateFile の作成日を取得します。
getDescription()StringFile の説明を取得します。
getDownloadUrl()Stringファイルのダウンロードに使用できる URL を取得します。
getEditors()User[]この File の編集者のリストを取得します。
getId()StringFile の ID を取得します。
getLastUpdated()DateFile の最終更新日を取得します。
getMimeType()Stringファイルの MIME タイプを取得します。
getName()StringFile の名前を取得します。
getOwner()UserFile のオーナーを取得します。
getParents()FolderIteratorFile の直接の親であるフォルダのコレクションを取得します。
getResourceKey()Stringリンクを使用して共有されたアイテムにアクセスするために必要な File のリソースキーを取得します。
getSecurityUpdateEligible()Booleanこの File が、リンクを使用して共有するときにアクセスにリソースキーを必要とするセキュリティ アップデートを適用するかどうかを示します。
getSecurityUpdateEnabled()Booleanリンクを使用して共有するときに、この File がアクセスにリソースキーを必要とするかどうかを取得します。
getSharingAccess()Access明示的にアクセス権を付与されている個々のユーザーを除き、File にアクセスできるユーザークラスを取得します。
getSharingPermission()PermissionFile にアクセスできるユーザーに付与された権限を取得します。明示的にアクセス権を付与された個々のユーザーを除きます。
getSize()IntegerFile をドライブに保存するために使用されるバイト数を取得します。
getTargetId()Stringショートカットの場合は、そのアイテムの ID を返します。
getTargetMimeType()Stringショートカットの場合は、参照しているアイテムの MIME タイプを返します。
getTargetResourceKey()Stringファイルがショートカットの場合は、そのアイテムが指すアイテムのリソースキーを返します。
getThumbnail()Blobファイルのサムネイル画像を取得します。サムネイルが存在しない場合は null を取得します。
getUrl()Stringドライブやドキュメントなどの Google アプリで File を開くために使用できる URL を取得します。
getViewers()User[]この File の閲覧者とコメント投稿者のリストを取得します。
isShareableByEditors()BooleanFile の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを指定します。
isStarred()Booleanユーザーのドライブで File にスターが付いているかどうかを判断します。
isTrashed()BooleanFile がユーザーのドライブのゴミ箱にあるかどうかを判断します。
makeCopy()Fileファイルのコピーを作成します。
makeCopy(destination)Fileコピー先ディレクトリにファイルのコピーを作成します。
makeCopy(name)Fileファイルのコピーを作成し、指定した名前を付けます。
makeCopy(name, destination)Fileコピー先ディレクトリにファイルのコピーを作成し、指定された名前を付けます。
moveTo(destination)Fileこのアイテムを指定したフォルダに移動します。
removeCommenter(emailAddress)FileFile の閲覧者(コメント可)のリストから、指定したユーザーを削除します。
removeCommenter(user)FileFile の閲覧者(コメント可)のリストから、指定したユーザーを削除します。
removeEditor(emailAddress)File指定されたユーザーを File の編集者のリストから削除します。
removeEditor(user)File指定されたユーザーを File の編集者のリストから削除します。
removeViewer(emailAddress)FileFile の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
removeViewer(user)FileFile の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
revokePermissions(user)File指定されたユーザーに付与された File へのアクセス権を取り消します。
revokePermissions(user)File指定されたユーザーに付与された File へのアクセス権を取り消します。
setContent(content)File特定の置換でファイルの内容を上書きします。
setDescription(description)FileFile の説明を設定します。
setName(name)FileFile の名前を設定します。
setOwner(emailAddress)FileFile の所有者を変更します。
setOwner(user)FileFile の所有者を変更します。
setSecurityUpdateEnabled(enabled)Fileリンクを使用してアクセスする場合に、File がアクセスにリソースキーを必要とするかどうかを設定します。
setShareableByEditors(shareable)FileFile の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを設定します。
setSharing(accessType, permissionType)FileFile にアクセスできるユーザークラスと、それらのユーザーに付与する権限(明示的にアクセス権を付与されたユーザーを除く)を設定します。
setStarred(starred)Fileユーザーのドライブで File にスターを付けるかどうかを設定します。
setTrashed(trashed)FileFile がユーザーのドライブのゴミ箱にあるかどうかを設定します。

FileIterator

Methods

方法戻り値の型概要
getContinuationToken()Stringこのイテレーションを後で再開するために使用できるトークンを取得します。
hasNext()Booleannext() を呼び出すとアイテムが返されるかどうかを決定します。
next()Fileファイルまたはフォルダのコレクションに含まれる次のアイテムを取得します。

Folder

Methods

方法戻り値の型概要
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()DateFolder の作成日を取得します。
getDescription()StringFolder の説明を取得します。
getEditors()User[]この Folder の編集者のリストを取得します。
getFiles()FileIterator現在のフォルダの子であるすべてのファイルのコレクションを取得します。
getFilesByName(name)FileIterator現在のフォルダの子であり、指定された名前を持つすべてのファイルのコレクションを取得します。
getFilesByType(mimeType)FileIterator現在のフォルダの子で、指定された MIME タイプを持つすべてのファイルのコレクションを取得します。
getFolders()FolderIterator現在のフォルダの子であるすべてのフォルダのコレクションを取得します。
getFoldersByName(name)FolderIterator現在のフォルダの子であり、指定された名前を持つすべてのフォルダのコレクションを取得します。
getId()StringFolder の ID を取得します。
getLastUpdated()DateFolder の最終更新日を取得します。
getName()StringFolder の名前を取得します。
getOwner()UserFolder のオーナーを取得します。
getParents()FolderIteratorFolder の直接の親であるフォルダのコレクションを取得します。
getResourceKey()Stringリンクを使用して共有されたアイテムにアクセスするために必要な Folder のリソースキーを取得します。
getSecurityUpdateEligible()Booleanこの Folder が、リンクを使用して共有するときにアクセスにリソースキーを必要とするセキュリティ アップデートを適用するかどうかを示します。
getSecurityUpdateEnabled()Booleanリンクを使用して共有するときに、この Folder がアクセスにリソースキーを必要とするかどうかを取得します。
getSharingAccess()Access明示的にアクセス権を付与されている個々のユーザーを除き、Folder にアクセスできるユーザークラスを取得します。
getSharingPermission()PermissionFolder にアクセスできるユーザーに付与された権限を取得します。明示的にアクセス権を付与された個々のユーザーを除きます。
getSize()IntegerFolder をドライブに保存するために使用されるバイト数を取得します。
getUrl()Stringドライブやドキュメントなどの Google アプリで Folder を開くために使用できる URL を取得します。
getViewers()User[]この Folder の閲覧者とコメント投稿者のリストを取得します。
isShareableByEditors()BooleanFolder の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを指定します。
isStarred()Booleanユーザーのドライブで Folder にスターが付いているかどうかを判断します。
isTrashed()BooleanFolder がユーザーのドライブのゴミ箱にあるかどうかを判断します。
moveTo(destination)Folderこのアイテムを指定したフォルダに移動します。
removeEditor(emailAddress)Folder指定されたユーザーを Folder の編集者のリストから削除します。
removeEditor(user)Folder指定されたユーザーを Folder の編集者のリストから削除します。
removeViewer(emailAddress)FolderFolder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
removeViewer(user)FolderFolder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
revokePermissions(user)Folder指定されたユーザーに付与された Folder へのアクセス権を取り消します。
revokePermissions(user)Folder指定されたユーザーに付与された Folder へのアクセス権を取り消します。
searchFiles(params)FileIterator現在のフォルダの子であり、指定した検索条件に一致するすべてのファイルのコレクションを取得します。
searchFolders(params)FolderIterator現在のフォルダの子であり、指定した検索条件に一致するすべてのフォルダのコレクションを取得します。
setDescription(description)FolderFolder の説明を設定します。
setName(name)FolderFolder の名前を設定します。
setOwner(emailAddress)FolderFolder の所有者を変更します。
setOwner(user)FolderFolder の所有者を変更します。
setSecurityUpdateEnabled(enabled)Folderリンクを使用してアクセスする場合に、Folder がアクセスにリソースキーを必要とするかどうかを設定します。
setShareableByEditors(shareable)FolderFolder の編集権限を持つユーザーに、他のユーザーとの共有や権限の変更を許可するかどうかを設定します。
setSharing(accessType, permissionType)FolderFolder にアクセスできるユーザークラスと、それらのユーザーに付与する権限(明示的にアクセス権を付与されたユーザーを除く)を設定します。
setStarred(starred)Folderユーザーのドライブで Folder にスターを付けるかどうかを設定します。
setTrashed(trashed)FolderFolder がユーザーのドライブのゴミ箱にあるかどうかを設定します。

FolderIterator

Methods

方法戻り値の型概要
getContinuationToken()Stringこのイテレーションを後で再開するために使用できるトークンを取得します。
hasNext()Booleannext() を呼び出すとアイテムが返されるかどうかを決定します。
next()Folderファイルまたはフォルダのコレクションに含まれる次のアイテムを取得します。

Permission

Properties

プロパティ種類説明
VIEWEnumファイルまたはフォルダにアクセスできるユーザーは、そのファイルまたはフォルダの表示またはコピーのみを行えます。
EDITEnumファイルまたはフォルダにアクセスできるユーザーは、そのファイルまたはフォルダを編集できます。
COMMENTEnumファイルまたはフォルダにアクセスできるユーザーは、ファイルの閲覧、コピー、コメント追加のみ行えます。
OWNEREnumユーザーがそのファイルまたはフォルダのオーナーになります。
ORGANIZEREnum共有ドライブ内のファイルやフォルダを整理できるユーザー。
FILE_ORGANIZEREnum共有ドライブ内のコンテンツを編集、ゴミ箱に移動、移動できるユーザー。
NONEEnumユーザーには、ファイルまたはフォルダに対する権限がありません。

User

Methods

方法戻り値の型概要
getDomain()Stringユーザーのアカウントに関連付けられたドメイン名を取得します。
getEmail()Stringユーザーのメールアドレスを取得します。
getName()Stringユーザー名を取得します。
getPhotoUrl()Stringユーザーの写真の URL を取得します。