Drive Service

Google ドライブ

このサービスを使用すると、スクリプトでファイルとフォルダを Google ドライブ。

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

<ph type="x-smartling-placeholder"></ph> 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ファイルやフォルダにアクセスできるユーザーに付与された権限を表す列挙型。 個人ユーザーに適用されます。

メソッド

メソッド戻り値の型概要
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

メソッド

メソッド戻り値の型概要
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()AccessFile にアクセスできるユーザーのクラスを取得します。また、個々のクラスも取得します。 ユーザーが含まれます。
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)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)FileFile のアクセスにリソースキーが必要かどうかを設定します リンクを使用して共有しています。
setShareableByEditors(shareable)FileFile の編集権限を持つユーザーに共有を許可するかどうかを設定します 権限を変更したりできます。
setSharing(accessType, permissionType)FileFile にアクセスできるユーザーのクラスと権限を設定します。 明示的に許可された個々のユーザーを除き、これらのユーザーにも付与されます。
setStarred(starred)Fileユーザーのドライブで File にスターを付けるかどうかを設定します。
setTrashed(trashed)FileFile をユーザーのドライブのゴミ箱に入れるかどうかを設定します。

FileIterator

メソッド

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

Folder

メソッド

メソッド戻り値の型概要
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()AccessFolder にアクセスできるユーザーのクラスを取得します。また、個々のクラスも取得します。 ユーザーが含まれます。
getSharingPermission()PermissionFolder にアクセスできるユーザーに付与されている権限を取得します。 明示的にアクセス権を付与された個々のユーザーは含まれません。
getSize()IntegerFolder をドライブに保存するために使用されているバイト数を取得します。
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)FolderFolder のアクセスにリソースキーが必要かどうかを設定します リンクを使用して共有しています。
setShareableByEditors(shareable)FolderFolder の編集権限を持つユーザーに共有を許可するかどうかを設定します 権限を変更したりできます。
setSharing(accessType, permissionType)FolderFolder にアクセスできるユーザーのクラスと権限を設定します。 明示的に許可された個々のユーザーを除き、これらのユーザーにも付与されます。
setStarred(starred)Folderユーザーのドライブで Folder にスターを付けるかどうかを設定します。
setTrashed(trashed)FolderFolder をユーザーのドライブのゴミ箱に入れるかどうかを設定します。

FolderIterator

メソッド

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

Permission

プロパティ

プロパティタイプ説明
VIEWEnumファイルやフォルダにアクセスできるユーザーは、閲覧とコピーのみ可能です。
EDITEnumファイルやフォルダにアクセスできるユーザーは、そのファイルやフォルダを編集できます。
COMMENTEnumファイルやフォルダにアクセスできるユーザーは、閲覧、コピー、コメントのみ可能です。
OWNEREnumユーザーがファイルやフォルダを所有している。
ORGANIZEREnum共有ドライブ内のファイルやフォルダを整理できるユーザー。
FILE_ORGANIZEREnum共有ドライブ内のコンテンツを編集、ゴミ箱に移動、移動できるユーザー。
NONEEnumユーザーにファイルまたはフォルダに対する権限がない。

User

メソッド

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