این سرویس به اسکریپتها اجازه میدهد فایلها و پوشهها را در Google Drive ایجاد، پیدا و تغییر دهند.
اگر اسکریپت شما از یک پروژه استاندارد Cloud به جای پروژه پیشفرض Cloud استفاده میکند، باید به صورت دستی Drive API را روشن کنید. در پروژه استاندارد Cloud خود، Drive API را روشن کنید:
نمونه کد زیر نحوه ثبت نام هر فایل را در پوشه My Drive کاربر نشان می دهد:// 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 Drive ایجاد، پیدا و تغییر دهند. |
File | یک فایل در گوگل درایو. |
FileIterator | تکرارکننده ای که به اسکریپت ها اجازه می دهد تا روی مجموعه بزرگی از فایل ها تکرار شوند. |
Folder | پوشه ای در گوگل درایو |
FolderIterator | یک شی که به اسکریپت ها اجازه می دهد تا روی مجموعه بزرگی از پوشه ها تکرار شوند. |
Permission | شماره ای که نشان دهنده مجوزهای اعطا شده به کاربرانی است که می توانند به یک فایل یا پوشه دسترسی داشته باشند، علاوه بر هر کاربر فردی که صراحتاً به آنها دسترسی داده شده است. |
User | کاربری مرتبط با یک فایل در Google Drive. |
Access
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
ANYONE | Enum | هر کسی در اینترنت می تواند پیدا کند و به آن دسترسی داشته باشد. |
ANYONE_WITH_LINK | Enum | هر کسی که پیوند را داشته باشد می تواند دسترسی داشته باشد. |
DOMAIN | Enum | افراد در دامنه شما می توانند پیدا کنند و به آن دسترسی داشته باشند. |
DOMAIN_WITH_LINK | Enum | افرادی در دامنه شما که پیوند را دارند می توانند دسترسی داشته باشند. |
PRIVATE | Enum | فقط افرادی که صراحتاً مجوز دارند می توانند دسترسی داشته باشند. |
DriveApp
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
Access | Access | فهرستی که نشاندهنده دستههایی از کاربرانی است که میتوانند به یک فایل یا پوشه دسترسی داشته باشند، علاوه بر هر کاربر فردی که صراحتاً به آنها دسترسی داده شده است. |
Permission | Permission | شماره ای که نشان دهنده مجوزهای اعطا شده به کاربرانی است که می توانند به یک فایل یا پوشه دسترسی داشته باشند، علاوه بر هر کاربر فردی که صراحتاً به آنها دسترسی داده شده است. |
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
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 | یک میانبر برای شناسه مورد ارائه شده Drive ایجاد می کند و آن را برمی گرداند. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | یک میانبر برای شناسه مورد و کلید منبع ارائه شده Drive ایجاد می کند و آن را برمی گرداند. |
enforceSingleParent(value) | void | اعمال رفتار SingleParent را برای همه تماسهایی که والدین مورد را تحت تأثیر قرار میدهند، فعال یا غیرفعال میکند. |
getFileById(id) | File | فایل را با شناسه داده شده دریافت می کند. |
getFileByIdAndResourceKey(id, resourceKey) | File | فایل را با شناسه و کلید منبع داده شده دریافت می کند. |
getFiles() | FileIterator | مجموعه ای از تمام فایل ها را در Drive کاربر دریافت می کند. |
getFilesByName(name) | FileIterator | مجموعهای از تمام فایلهای درایو کاربر را دریافت میکند که این نام را دارند. |
getFilesByType(mimeType) | FileIterator | مجموعه ای از تمام فایل های درایو کاربر را دریافت می کند که دارای نوع MIME هستند. |
getFolderById(id) | Folder | پوشه با شناسه داده شده را دریافت می کند. |
getFolderByIdAndResourceKey(id, resourceKey) | Folder | پوشه با شناسه و کلید منبع داده شده را دریافت می کند. |
getFolders() | FolderIterator | مجموعه ای از تمام پوشه ها را در Drive کاربر دریافت می کند. |
getFoldersByName(name) | FolderIterator | مجموعهای از تمام پوشههای درایو کاربر را که نام مشخص شده دارند، دریافت میکند. |
getRootFolder() | Folder | پوشه را در ریشه درایو کاربر دریافت می کند. |
getStorageLimit() | Integer | تعداد بایت هایی را که کاربر مجاز است در Drive ذخیره کند، دریافت می کند. |
getStorageUsed() | Integer | تعداد بایت هایی را که کاربر در حال حاضر در Drive ذخیره می کند دریافت می کند. |
getTrashedFiles() | FileIterator | مجموعه ای از تمام فایل های موجود در سطل زباله درایو کاربر را دریافت می کند. |
getTrashedFolders() | FolderIterator | مجموعه ای از تمام پوشه های موجود در سطل زباله درایو کاربر را دریافت می کند. |
searchFiles(params) | FileIterator | مجموعه ای از همه فایل ها را در Drive کاربر دریافت می کند که با معیارهای جستجوی داده شده مطابقت دارند. |
searchFolders(params) | FolderIterator | مجموعه ای از تمام پوشه ها را در Drive کاربر دریافت می کند که با معیارهای جستجوی داده شده مطابقت دارند. |
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 | داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید. |
getBlob() | Blob | داده های داخل این شی را به صورت حباب برگردانید. |
getDateCreated() | Date | تاریخ ایجاد File را دریافت می کند. |
getDescription() | String | توضیحات File را دریافت می کند. |
getDownloadUrl() | String | آدرس اینترنتی را دریافت می کند که می توان از آن برای دانلود فایل استفاده کرد. |
getEditors() | User[] | لیست ویرایشگرهای این File را دریافت می کند. |
getId() | String | شناسه File را می گیرد. |
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 در Drive را دریافت می کند. |
getTargetId() | String | اگر این یک میانبر است، شناسه موردی را که به آن اشاره می کند برمی گرداند. |
getTargetMimeType() | String | اگر این یک میانبر است، نوع mime موردی را که به آن اشاره می کند برمی گرداند. |
getTargetResourceKey() | String | اگر فایل یک میانبر باشد، کلید منبع موردی را که به آن اشاره می کند برمی گرداند. |
getThumbnail() | Blob | یک تصویر بندانگشتی برای فایل دریافت میکند، یا اگر تصویر کوچکی وجود نداشته باشد، null . |
getUrl() | String | نشانی اینترنتی را دریافت میکند که میتوان از آن برای باز کردن File در یک برنامه Google مانند Drive یا Docs استفاده کرد. |
getViewers() | User[] | لیست بینندگان و نظر دهندگان این File را دریافت می کند. |
isShareableByEditors() | Boolean | تعیین می کند که آیا کاربرانی که مجوز ویرایش File را دارند مجاز به اشتراک گذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر. |
isStarred() | Boolean | تعیین می کند که آیا File در Drive کاربر ستاره گذاری شده است یا خیر. |
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 در Drive کاربر ستارهدار شود یا خیر. |
setTrashed(trashed) | File | تعیین می کند که آیا File در سطل زباله درایو کاربر قرار دارد یا خیر. |
FileIterator
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getContinuationToken() | String | رمزی دریافت می کند که می تواند برای از سرگیری این تکرار در زمان دیگری استفاده شود. |
hasNext() | Boolean | تعیین می کند که آیا فراخوانی next() یک آیتم را برمی گرداند یا خیر. |
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 | یک میانبر برای شناسه مورد ارائه شده Drive ایجاد می کند و آن را برمی گرداند. |
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) | File | یک میانبر برای شناسه مورد و کلید منبع ارائه شده Drive ایجاد می کند و آن را برمی گرداند. |
getAccess(email) | Permission | مجوز اعطا شده به یک کاربر خاص را دریافت می کند. |
getAccess(user) | Permission | مجوز اعطا شده به یک کاربر خاص را دریافت می کند. |
getDateCreated() | Date | تاریخ ایجاد Folder را دریافت می کند. |
getDescription() | String | توضیحات مربوط به Folder را دریافت می کند. |
getEditors() | User[] | لیست ویرایشگرهای این Folder را دریافت می کند. |
getFiles() | FileIterator | مجموعه ای از تمام فایل هایی را که فرزندان پوشه فعلی هستند دریافت می کند. |
getFilesByName(name) | FileIterator | مجموعه ای از تمام فایل هایی را که فرزندان پوشه فعلی هستند و نام مشخص شده دارند را دریافت می کند. |
getFilesByType(mimeType) | FileIterator | مجموعه ای از تمام فایل هایی را که فرزندان پوشه فعلی هستند و دارای نوع MIME هستند دریافت می کند. |
getFolders() | FolderIterator | مجموعه ای از تمام پوشه هایی را که فرزندان پوشه فعلی هستند دریافت می کند. |
getFoldersByName(name) | FolderIterator | مجموعه ای از تمام پوشه هایی را که فرزندان پوشه فعلی هستند و نام مشخص شده دارند را دریافت می کند. |
getId() | String | شناسه Folder را می گیرد. |
getLastUpdated() | Date | تاریخ آخرین به روز رسانی Folder را دریافت می کند. |
getName() | String | نام Folder را دریافت می کند. |
getOwner() | User | صاحب این Folder را می گیرد. |
getParents() | FolderIterator | مجموعه ای از پوشه ها را دریافت می کند که والدین فوری Folder هستند. |
getResourceKey() | String | کلید منبع Folder را که برای دسترسی به مواردی که با استفاده از پیوند به اشتراک گذاشته شده اند، مورد نیاز است. |
getSecurityUpdateEligible() | Boolean | دریافت که آیا این Folder واجد شرایط اعمال بهروزرسانی امنیتی است که برای دسترسی به آن نیاز به کلید منبع دارد یا خیر. |
getSecurityUpdateEnabled() | Boolean | دریافت می کند که آیا این Folder برای دسترسی به یک کلید منبع نیاز دارد یا خیر. |
getSharingAccess() | Access | مشخص می کند که چه دسته ای از کاربران می توانند به Folder دسترسی داشته باشند، علاوه بر هر کاربر فردی که به صراحت به آنها دسترسی داده شده است. |
getSharingPermission() | Permission | اجازه میدهد به آن دسته از کاربرانی که میتوانند به Folder دسترسی داشته باشند، علاوه بر هر کاربر فردی که صراحتاً به آنها دسترسی داده شده است، مجوز داده میشود. |
getSize() | Integer | تعداد بایت های مورد استفاده برای ذخیره Folder در Drive را دریافت می کند. |
getUrl() | String | نشانی اینترنتی را دریافت میکند که میتوان از آن برای باز کردن Folder در یک برنامه Google مانند Drive یا Docs استفاده کرد. |
getViewers() | User[] | لیست بینندگان و نظر دهندگان را برای این Folder دریافت می کند. |
isShareableByEditors() | Boolean | تعیین می کند که آیا کاربرانی که مجوزهای ویرایش Folder را دارند مجاز به اشتراک گذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر. |
isStarred() | Boolean | تعیین می کند که آیا Folder در Drive کاربر ستاره گذاری شده است یا خیر. |
isTrashed() | Boolean | تعیین می کند که آیا Folder در سطل زباله درایو کاربر قرار دارد یا خیر. |
moveTo(destination) | Folder | این مورد را به پوشه مقصد ارائه شده منتقل می کند. |
removeEditor(emailAddress) | Folder | کاربر داده شده را از لیست ویرایشگرهای Folder حذف می کند. |
removeEditor(user) | Folder | کاربر داده شده را از لیست ویرایشگرهای Folder حذف می کند. |
removeViewer(emailAddress) | Folder | کاربر داده شده را از لیست بینندگان و نظر دهندگان Folder حذف می کند. |
removeViewer(user) | Folder | کاربر داده شده را از لیست بینندگان و نظر دهندگان Folder حذف می کند. |
revokePermissions(emailAddress) | Folder | دسترسی به Folder که به کاربر داده شده داده شده را لغو می کند. |
revokePermissions(user) | Folder | دسترسی به Folder که به کاربر داده شده داده شده را لغو می کند. |
searchFiles(params) | FileIterator | مجموعهای از تمام فایلهایی را دریافت میکند که فرزندان پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند. |
searchFolders(params) | FolderIterator | مجموعهای از تمام پوشههایی را دریافت میکند که فرزندان پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند. |
setDescription(description) | Folder | توضیحات را برای Folder تنظیم می کند. |
setName(name) | Folder | نام Folder را تنظیم می کند. |
setOwner(emailAddress) | Folder | مالک Folder را تغییر می دهد. |
setOwner(user) | Folder | مالک Folder را تغییر می دهد. |
setSecurityUpdateEnabled(enabled) | Folder | تنظیم می کند که آیا Folder برای دسترسی به کلید منبع در هنگام اشتراک گذاری با استفاده از پیوند نیاز دارد یا خیر. |
setShareableByEditors(shareable) | Folder | تعیین می کند که آیا کاربرانی که مجوز ویرایش در Folder را دارند، مجاز به اشتراک گذاری با سایر کاربران یا تغییر مجوزها باشند. |
setSharing(accessType, permissionType) | Folder | تعیین می کند که کدام دسته از کاربران می توانند به Folder دسترسی داشته باشند و چه مجوزهایی به آن کاربران داده می شود، علاوه بر هر کاربر فردی که به طور صریح به آنها دسترسی داده شده است. |
setStarred(starred) | Folder | تعیین میکند که Folder در Drive کاربر ستارهدار شود یا خیر. |
setTrashed(trashed) | Folder | تعیین می کند که آیا Folder در سطل زباله درایو کاربر باشد. |
FolderIterator
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getContinuationToken() | String | رمزی دریافت می کند که می تواند برای از سرگیری این تکرار در زمان دیگری استفاده شود. |
hasNext() | Boolean | تعیین می کند که آیا فراخوانی next() یک آیتم را برمی گرداند یا خیر. |
next() | Folder | مورد بعدی را در مجموعه فایل ها یا پوشه ها دریافت می کند. |
Permission
خواص
اموال | تایپ کنید | توضیحات |
---|---|---|
VIEW | Enum | کاربرانی که می توانند به فایل یا پوشه دسترسی داشته باشند فقط می توانند آن را مشاهده یا کپی کنند. |
EDIT | Enum | کاربرانی که می توانند به فایل یا پوشه دسترسی داشته باشند می توانند آن را ویرایش کنند. |
COMMENT | Enum | کاربرانی که می توانند به فایل یا پوشه دسترسی داشته باشند فقط می توانند آن را مشاهده کنند، آن را کپی کنند یا روی آن نظر بدهند. |
OWNER | Enum | کاربر مالک فایل یا پوشه است. |
ORGANIZER | Enum | کاربرانی که می توانند فایل ها و پوشه ها را در یک درایو مشترک سازماندهی کنند. |
FILE_ORGANIZER | Enum | کاربرانی که می توانند محتوا را در یک درایو مشترک ویرایش، حذف و انتقال دهند. |
NONE | Enum | کاربر هیچ مجوزی برای فایل یا پوشه ندارد. |
User
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
getDomain() | String | نام دامنه مرتبط با حساب کاربر را دریافت می کند. |
getEmail() | String | آدرس ایمیل کاربر را دریافت می کند. |
getName() | String | نام کاربر را دریافت می کند. |
getPhotoUrl() | String | نشانی اینترنتی عکس کاربر را دریافت می کند. |