Drive Service

ドライブ

このサービスを使用すると、スクリプトで Google ドライブのファイルとフォルダを作成、検索、変更できます。

スクリプトで、デフォルトの Cloud プロジェクトではなく標準の Cloud プロジェクトを使用している場合は、Drive API を手動で有効にする必要があります。標準の Cloud プロジェクトで、Drive API を有効にします。

Drive API を有効にする

次のコードサンプルは、ユーザーのマイドライブ フォルダ内の各ファイルの名前をログに記録する方法を示しています。
// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

クラス

名前概要
Accessファイルまたはフォルダにアクセスできるユーザーのクラスと、明示的にアクセス権が付与されている個々のユーザーのクラスを表す列挙型。
DriveAppスクリプトを使用して Google ドライブのファイルとフォルダを作成、検索、変更できます。
FileGoogle ドライブ内のファイル。
FileIterator大量のファイルが存在する可能性があるコレクションをスクリプトが反復処理できるようにするイテレータです。
FolderGoogle ドライブ内のフォルダ。
FolderIterator大量のフォルダが存在する可能性があるコレクションに対してスクリプトで反復処理を行えるオブジェクト。
Permissionアクセス権を明示的に付与された個々のユーザーに加え、ファイルやフォルダにアクセスできるユーザーに付与される権限を表す列挙型。
UserGoogle ドライブのファイルに関連付けられているユーザー。

Access

プロパティ

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

DriveApp

プロパティ

プロパティ種類説明
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アイテムの親に影響するすべての呼び出しに対する enforcingSingleParent の動作を有効または無効にします。
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)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()DateFile が作成された日付を取得します。
getDescription()StringFile の説明を取得します。
getDownloadUrl()Stringファイルのダウンロードに使用できる URL を取得します。
getEditors()User[]この File の編集者のリストを取得します。
getId()StringFile の ID を取得します。
getLastUpdated()DateFile が最後に更新された日付を取得します。
getMimeType()Stringファイルの MIME タイプを取得します。
getName()StringFile の名前を取得します。
getOwner()Userファイルのオーナーを取得します。
getParents()FolderIteratorFile の直接の親であるフォルダのコレクションを取得します。
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()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)FileFile の編集者のリストから指定されたユーザーを削除します。
removeEditor(user)FileFile の編集者のリストから指定されたユーザーを削除します。
removeViewer(emailAddress)FileFile の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
removeViewer(user)FileFile の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
revokePermissions(emailAddress)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)File明示的にアクセス権を付与された個々のユーザーに加えて、File にアクセスできるユーザーのクラスと、これらのユーザーに付与される権限を設定します。
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()Userこの Folder のオーナーを取得します。
getParents()FolderIteratorFolder の直接の親であるフォルダのコレクションを取得します。
getResourceKey()Stringリンクを使用して共有されているアイテムにアクセスするために必要な Folder のリソースキーを取得します。
getSecurityUpdateEligible()Booleanこの Folder がリンクで共有されたときに、アクセスにリソースキーを必要とするセキュリティ アップデートの適用が可能かどうかを取得します。
getSecurityUpdateEnabled()Booleanこの Folder がリンクで共有される場合、アクセスのためにリソースキーが必要かどうかを取得します。
getSharingAccess()Access明示的にアクセス権が付与されている個々のユーザーに加えて、Folder にアクセスできるユーザーのクラスを取得します。
getSharingPermission()Permission明示的にアクセス権が付与されている個々のユーザーに加え、Folder にアクセスできるユーザーに付与されている権限を取得します。
getSize()Integerドライブに Folder を保存するために使用されるバイト数を取得します。
getUrl()Stringドライブやドキュメントなどの Google アプリで Folder を開くために使用できる URL を取得します。
getViewers()User[]この Folder の閲覧者とコメント投稿者のリストを取得します。
isShareableByEditors()BooleanFolder に対する編集権限を持つユーザーに、他のユーザーと共有したり、権限を変更したりできるかどうかを決定します。
isStarred()Booleanユーザーのドライブで Folder にスターが付いているかどうかを判断します。
isTrashed()BooleanFolder がユーザーのドライブのゴミ箱にあるかどうかを判断します。
moveTo(destination)Folder指定された移動先のフォルダにこのアイテムを移動します。
removeEditor(emailAddress)FolderFolder の編集者のリストから指定されたユーザーを削除します。
removeEditor(user)FolderFolder の編集者のリストから指定されたユーザーを削除します。
removeViewer(emailAddress)FolderFolder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
removeViewer(user)FolderFolder の閲覧者とコメント投稿者のリストから、指定されたユーザーを削除します。
revokePermissions(emailAddress)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)Folder明示的にアクセス権を付与された個々のユーザーに加えて、Folder にアクセスできるユーザーのクラスと、これらのユーザーに付与される権限を設定します。
setStarred(starred)Folderユーザーのドライブで Folder にスターを付けるかどうかを設定します。
setTrashed(trashed)FolderFolder がユーザーのドライブのゴミ箱にあるかどうかを設定します。

FolderIterator

Methods

メソッド戻り値の型概要
getContinuationToken()Stringこの反復処理を後で再開するために使用できるトークンを取得します。
hasNext()Booleannext() を呼び出してアイテムを返すかどうかを決定します。
next()Folderファイルまたはフォルダのコレクション内の次のアイテムを取得します。

Permission

プロパティ

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

User

Methods

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