یک فایل در گوگل درایو. فایل ها را می توان از DriveApp
دسترسی یا ایجاد کرد.
// Trash every untitled spreadsheet that hasn't been updated in a week. const files = DriveApp.getFilesByName('Untitled spreadsheet'); while (files.hasNext()) { const file = files.next(); if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) { file.setTrashed(true); } }
روش ها
روش | نوع برگشت | شرح مختصر |
---|---|---|
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 در سطل زباله درایو کاربر قرار دارد یا خیر. |
مستندات دقیق
addCommenter(emailAddress)
کاربر داده شده را به لیست نظر دهندگان File
اضافه کنید. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.
const files = DriveApp.getFilesByName('Test'); // Loops through the files while (files.hasNext()) { const file = files.next(); file.addCommenter('hello@example.com'); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای افزودن |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
addCommenter(user)
کاربر داده شده را به لیست نظر دهندگان File
اضافه کنید. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Adds the active user as a commenter. while (files.hasNext()) { const file = files.next(); file.addCommenter(Session.getActiveUser()); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایشی از کاربر برای اضافه کردن. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
addCommenters(emailAddresses)
آرایه داده شده از کاربران را به لیست نظر دهندگان File
اضافه کنید. اگر هر یک از کاربران قبلاً در لیست بینندگان بودند، این روش آنها را از لیست بینندگان خارج می کند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); while (files.hasNext()) { const file = files.next(); // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and // 'baklavainthebalkans@gmail.com' with the email addresses to add as // commenters. const emails = [ 'cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com', ]; console.log(file.addCommenters(emails)); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddresses | String[] | مجموعه ای از آدرس های ایمیل کاربران برای اضافه کردن. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
addEditor(emailAddress)
کاربر داده شده را به لیست ویرایشگرهای File
اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای افزودن |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
addEditor(user)
کاربر داده شده را به لیست ویرایشگرهای File
اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایشی از کاربر برای اضافه کردن. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
addEditors(emailAddresses)
آرایه داده شده از کاربران را به لیست ویرایشگرهای File
اضافه می کند. اگر هر یک از کاربران قبلاً در لیست بینندگان بودند، این روش آنها را از لیست بینندگان خارج می کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddresses | String[] | مجموعه ای از آدرس های ایمیل کاربران برای اضافه کردن. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
addViewer(emailAddress)
کاربر داده شده را به لیست بینندگان File
اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای افزودن |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
addViewer(user)
کاربر داده شده را به لیست بینندگان File
اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایشی از کاربر برای اضافه کردن. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
addViewers(emailAddresses)
آرایه داده شده از کاربران را به لیست بینندگان File
اضافه می کند. اگر هر یک از کاربران قبلاً در لیست ویرایشگرها بودند، این روش برای آنها تأثیری ندارد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddresses | String[] | مجموعه ای از آدرس های ایمیل کاربران برای اضافه کردن. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
getAccess(email)
مجوز اعطا شده به یک کاربر خاص را دریافت می کند. این روش از بازگرداندن مجوزهای یک گروه Google یا مجوزهای به ارث رسیده از طریق Google Groups پشتیبانی نمی کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
email | String | آدرس ایمیل کاربری که مجوزهایش باید بررسی شود. Google Groups پشتیبانی نمی شود. |
بازگشت
Permission
- مجوزهایی که به کاربر داده می شود.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAccess(user)
مجوز اعطا شده به یک کاربر خاص را دریافت می کند. این روش از بازگرداندن مجوزهای یک گروه Google یا مجوزهای به ارث رسیده از طریق Google Groups پشتیبانی نمی کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایش کاربری که مجوزهایش باید بررسی شود. |
بازگشت
Permission
- مجوزهایی که به کاربر داده می شود.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getAs(contentType)
داده های داخل این شی را به عنوان یک حباب تبدیل به نوع محتوای مشخص شده برگردانید. این روش پسوند مناسب را به نام فایل اضافه می کند - به عنوان مثال، "myfile.pdf". با این حال، فرض میکند که بخشی از نام فایل که پس از آخرین نقطه (در صورت وجود) یک پسوند موجود است که باید جایگزین شود. در نتیجه، "ShoppingList.12.25.2014" به "ShoppingList.12.25.pdf" تبدیل می شود.
برای مشاهده سهمیه های روزانه برای تبدیل، به سهمیه خدمات Google مراجعه کنید. دامنههای جدید Google Workspace ممکن است به طور موقت مشمول سهمیههای سختگیرانهتر شوند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
contentType | String | نوع MIME برای تبدیل. برای اکثر حبابها، 'application/pdf' تنها گزینه معتبر است. برای تصاویر با فرمت BMP، GIF، JPEG یا PNG، هر یک از 'image/bmp' ، 'image/gif' ، 'image/jpeg' یا 'image/png' نیز معتبر هستند. برای سند Google Docs، 'text/markdown' نیز معتبر است. |
بازگشت
Blob
- داده ها به عنوان یک لکه.
getBlob()
getDateCreated()
getDescription()
getDownloadUrl()
آدرس اینترنتی را دریافت می کند که می توان از آن برای دانلود فایل استفاده کرد. فقط کاربرانی که اجازه باز کردن فایل در Google Drive را دارند می توانند به URL دسترسی داشته باشند. میتوانید از این URL در مرورگر برای دانلود فایل استفاده کنید، اما نمیتوانید برای واکشی فایل با UrlFetchApp
استفاده کنید. اگر محتویات فایل را در اسکریپت می خواهید، از getBlob()
استفاده کنید.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the download URLs to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getDownloadUrl()); }
بازگشت
String
- URL که می تواند برای دانلود فایل استفاده شود.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getEditors()
لیست ویرایشگرهای این File
را دریافت می کند. اگر کاربری که اسکریپت را اجرا می کند دسترسی ویرایش به File
نداشته باشد، این روش یک آرایه خالی را برمی گرداند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Adds the email addresses in the array as editors of each file. // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' // and 'baklavainthebalkans@gmail.com' with valid email addresses. file.addEditors([ 'cloudysanfrancisco@gmail.com', 'baklavainthebalkans@gmail.com', ]); // Gets a list of the file editors. const editors = file.getEditors(); // For each file, logs the editors' email addresses to the console. for (const editor of editors) { console.log(editor.getEmail()); } }
بازگشت
User[]
- اگر کاربر برای این File
دسترسی ویرایش داشته باشد، لیست ویرایشگرها را برمی گرداند. اگر کاربر دسترسی ویرایش نداشته باشد، یک آرایه خالی برمی گرداند.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getId()
getLastUpdated()
getMimeType()
نوع MIME فایل را دریافت می کند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the MIME type to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getMimeType()); }
بازگشت
String
- نوع MIME فایل.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getName()
getOwner()
صاحب فایل را دریافت می کند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files and logs the names of the file owners to the console. while (files.hasNext()) { const file = files.next(); console.log(file.getOwner().getName()); }
بازگشت
User
- مالک فایل.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getParents()
مجموعه ای از پوشه ها را دریافت می کند که والدین مستقیم File
هستند.
بازگشت
FolderIterator
- مجموعه ای از پوشه ها که والدین مستقیم File
هستند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getResourceKey()
کلید منبع File
را دریافت می کند که برای دسترسی به مواردی که با استفاده از پیوند به اشتراک گذاشته شده اند مورد نیاز است.
بازگشت
String
- کلید منبع File
.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEligible()
دریافت که آیا این File
واجد شرایط اعمال بهروزرسانی امنیتی است که برای دسترسی به آن نیاز به کلید منبع دارد یا خیر.
Drive برای دسترسی به برخی فایلها یا پوشههایی که با استفاده از پیوند به اشتراک گذاشته شدهاند، به یک کلید منبع نیاز دارد. این تغییر بخشی از یک بهروزرسانی امنیتی است. بهروزرسانی بهطور پیشفرض برای فایلها و پوشههای واجد شرایط روشن است. برای روشن یا خاموش کردن نیاز کلید منبع برای فایلهای واجد شرایط، از setSecurityUpdateEnabled
استفاده کنید.
درباره بهروزرسانی امنیتی Google Drive بیشتر بیاموزید.
بازگشت
Boolean
- آیا میتوان مورد نیاز کلید منبع را برای File
اعمال کرد یا خیر.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSecurityUpdateEnabled()
دریافت می کند که آیا این File
برای دسترسی به یک کلید منبع نیاز دارد یا خیر. این نیاز به طور پیشفرض برای فایلها و پوشههای واجد شرایط روشن است. برای روشن یا خاموش کردن نیاز کلید منبع برای فایلهای واجد شرایط، از setSecurityUpdateEnabled
استفاده کنید.
درباره بهروزرسانی امنیتی Google Drive بیشتر بیاموزید.
بازگشت
Boolean
- اینکه آیا نیاز کلید منبع برای این File
فعال است یا خیر.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingAccess()
مشخص می کند که چه دسته ای از کاربران می توانند به File
دسترسی داشته باشند، علاوه بر هر کاربر فردی که به صراحت به آنها دسترسی داده شده است.
بازگشت
Access
- کدام دسته از کاربران می توانند به File
دسترسی داشته باشند
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSharingPermission()
به کاربرانی که میتوانند به File
دسترسی داشته باشند، مجوز اعطا میکند، علاوه بر هر کاربر فردی که صریحاً به آنها دسترسی داده شده است.
بازگشت
Permission
- مجوزهایی که به کاربرانی که می توانند به File
دسترسی داشته باشند داده می شود
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getSize()
تعداد بایت های مورد استفاده برای ذخیره File
در Drive را دریافت می کند. توجه داشته باشید که فایلهای برنامه Google Workspace جزو محدودیتهای فضای ذخیرهسازی Drive حساب نمیشوند و بنابراین 0
بایت برمیگردانند.
بازگشت
Integer
- تعداد بایت هایی که برای ذخیره File
در Drive استفاده می شود
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getTargetId()
اگر این یک میانبر است، شناسه موردی را که به آن اشاره می کند برمی گرداند.
در غیر این صورت null
برمی گرداند.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the target ID of the shortcut. console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);
بازگشت
String
- شناسه مورد هدف.
getTargetMimeType()
اگر این یک میانبر است، نوع mime موردی را که به آن اشاره می کند برمی گرداند.
در غیر این صورت null
برمی گرداند.
// The ID of the file for which to make a shortcut and the ID of // the folder to which you want to add the shortcut. // TODO(developer): Replace the file and folder IDs with your IDs. const fileId = 'abc123456'; const folderId = 'xyz987654'; // Gets the folder to add the shortcut to. const folder = DriveApp.getFolderById(folderId); // Creates a shortcut of the file and moves it to the specified folder. const shortcut = DriveApp.createShortcut(fileId).moveTo(folder); // Logs the MIME type of the file that the shortcut points to. console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);
بازگشت
String
- نوع میم مورد هدف.
getTargetResourceKey()
اگر فایل یک میانبر باشد، کلید منبع موردی را که به آن اشاره می کند برمی گرداند. کلید منبع یک پارامتر اضافی است که برای دسترسی به فایلهایی که با استفاده از پیوند به اشتراک گذاشته شدهاند، باید آن را پاس کنید.
اگر فایل میانبر نباشد، null
برمیگرداند.
// Gets a file by its ID. // TODO(developer): Replace 'abc123456' with your file ID. const file = DriveApp.getFileById('abc123456'); // If the file is a shortcut, returns the resource key of the file that it // points to. console.log(file.getTargetResourceKey());
بازگشت
String
- اگر فایل میانبر نباشد، کلید منبع مورد هدف یا null
.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getThumbnail()
یک تصویر بندانگشتی برای فایل دریافت میکند، یا اگر تصویر کوچکی وجود نداشته باشد، null
.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Logs the thumbnail image for each file to the console as a blob, // or null if no thumbnail exists. console.log(file.getThumbnail()); }
بازگشت
Blob
- تصویر کوچک برای فایل.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getUrl()
نشانی اینترنتی را دریافت میکند که میتوان از آن برای باز کردن File
در یک برنامه Google مانند Drive یا Docs استفاده کرد.
بازگشت
String
- نشانی اینترنتی است که می توان برای مشاهده این File
در یک برنامه Google مانند Drive یا Docs استفاده کرد
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
getViewers()
لیست بینندگان و نظر دهندگان این File
را دریافت می کند. اگر کاربری که اسکریپت را اجرا می کند دسترسی ویرایش به File
نداشته باشد، این روش یک آرایه خالی را برمی گرداند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // For each file, logs the viewers' email addresses to the console. const viewers = file.getViewers(); for (const viewer of viewers) { console.log(viewer.getEmail()); } }
بازگشت
User[]
- اگر کاربر برای این File
دسترسی ویرایش داشته باشد، لیست بینندگان و نظر دهندگان را برمی گرداند. اگر کاربر دسترسی ویرایش نداشته باشد، یک آرایه خالی برمی گرداند.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isStarred()
تعیین می کند که آیا File
در Drive کاربر ستاره گذاری شده است یا خیر.
بازگشت
Boolean
- true
اگر File
در درایو کاربر ستارهدار باشد. false
اگر نه
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
isTrashed()
تعیین می کند که آیا File
در سطل زباله درایو کاربر قرار دارد یا خیر.
بازگشت
Boolean
- true
اگر File
در سطل زباله درایو کاربر باشد. false
اگر نه
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly
-
https://www.googleapis.com/auth/drive
makeCopy()
یک کپی از فایل ایجاد می کند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and logs the file name to the console. console.log(file.makeCopy().getName()); }
بازگشت
File
- کپی جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
makeCopy(destination)
یک کپی از فایل در فهرست مقصد ایجاد می کند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and adds it to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy(destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
destination | Folder | دایرکتوری برای کپی کردن فایل |
بازگشت
File
- کپی جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
makeCopy(name)
یک کپی از فایل ایجاد می کند و آن را با نام ارائه شده نامگذاری می کند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file and sets the name to 'Test-Copy.' const filename = file.makeCopy('Test-Copy'); // Logs the copied file's name to the console. console.log(filename.getName()); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
name | String | نام فایلی که باید روی کپی جدید اعمال شود. |
بازگشت
File
- کپی جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
makeCopy(name, destination)
یک کپی از فایل در فهرست مقصد ایجاد می کند و آن را با نام ارائه شده نامگذاری می کند.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Creates a copy of each file, sets the file name, and adds the copied file // to the specified folder. // TODO(developer): Replace the folder ID with your own. const destination = DriveApp.getFolderById('123456abcxyz'); const copiedFile = file.makeCopy('Test-Copy', destination); // Logs the file names to the console. console.log(copiedFile.getName()); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
name | String | نام فایلی که باید روی کپی جدید اعمال شود. |
destination | Folder | دایرکتوری برای کپی کردن فایل |
بازگشت
File
- کپی جدید.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
moveTo(destination)
این مورد را به پوشه مقصد ارائه شده منتقل می کند.
کاربر فعلی باید مالک فایل باشد یا حداقل به پوشه والد فعلی مورد دسترسی ویرایش داشته باشد تا بتواند مورد را به پوشه مقصد منتقل کند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
destination | Folder | پوشه ای که به والد جدید تبدیل می شود. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
removeCommenter(emailAddress)
کاربر داده شده را از لیست نظر دهندگان File
حذف می کند. اگر کاربران به دستهای از کاربرانی تعلق دارند که دسترسی عمومی دارند - به عنوان مثال، اگر File
با کل دامنه کاربر به اشتراک گذاشته شده باشد، این روش مانع از دسترسی کاربران به File
نمیشود.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. // TODO(developer): Replace the email with the email of the user you want to // remove. file.removeCommenter('cloudysanfrancisco@gmail.com'); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای حذف. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
removeCommenter(user)
کاربر داده شده را از لیست نظر دهندگان File
حذف می کند. اگر کاربران به دستهای از کاربرانی تعلق دارند که دسترسی عمومی دارند - به عنوان مثال، اگر File
با کل دامنه کاربر به اشتراک گذاشته شده باشد، این روش مانع از دسترسی کاربران به File
نمیشود.
// Gets a list of all files in Google Drive with the given name. // TODO(developer): Replace the file name with your own. const files = DriveApp.getFilesByName('Test'); // Loops through the files. while (files.hasNext()) { const file = files.next(); // Removes the given user from the list of commenters for each file. console.log(file.removeCommenter(Session.getActiveUser())); }
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایشی از کاربر برای حذف. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
removeEditor(emailAddress)
کاربر داده شده را از لیست ویرایشگرهای File
حذف می کند. اگر کاربران به دستهای از کاربرانی که دسترسی عمومی دارند - برای مثال اگر File
با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر File
در یک درایو مشترک است، این روش دسترسی به File
را مسدود نمیکند. می تواند دسترسی داشته باشد.
برای فایلهای Drive، این کار همچنین کاربر را از لیست بینندگان حذف میکند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای حذف. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
removeEditor(user)
کاربر داده شده را از لیست ویرایشگرهای File
حذف می کند. اگر کاربران به دستهای از کاربرانی که دسترسی عمومی دارند - برای مثال اگر File
با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر File
در یک درایو مشترک است، این روش دسترسی به File
را مسدود نمیکند. می تواند دسترسی داشته باشد.
برای فایلهای Drive، این کار همچنین کاربر را از لیست بینندگان حذف میکند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایشی از کاربر برای حذف. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
removeViewer(emailAddress)
کاربر داده شده را از لیست بینندگان و نظر دهندگان File
حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده یا نظر دهنده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دستهای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به File
را مسدود نمیکند - برای مثال، اگر File
با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر File
در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.
برای فایلهای Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف میکند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربر برای حذف. |
بازگشت
File
- این File
برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
removeViewer(user)
کاربر داده شده را از لیست بینندگان و نظر دهندگان File
حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دستهای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به File
را مسدود نمیکند - برای مثال، اگر File
با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر File
در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.
برای فایلهای Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف میکند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایشی از کاربر برای حذف. |
بازگشت
File
- این File
برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
revokePermissions(emailAddress)
دسترسی به File
که به کاربر داده شده داده شده را لغو می کند. اگر کاربران به دستهای از کاربرانی تعلق دارند که دسترسی عمومی دارند - به عنوان مثال، اگر File
با کل دامنه کاربر به اشتراک گذاشته شده باشد، این روش دسترسی به File
را مسدود نمیکند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربری که دسترسی او باید لغو شود. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
revokePermissions(user)
دسترسی به File
که به کاربر داده شده داده شده را لغو می کند. اگر کاربران به دستهای از کاربرانی تعلق دارند که دسترسی عمومی دارند - به عنوان مثال، اگر File
با کل دامنه کاربر به اشتراک گذاشته شده باشد، این روش دسترسی به File
را مسدود نمیکند.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایندگی از کاربری که دسترسی او باید لغو شود. |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
setContent(content)
محتوای فایل را با یک جایگزین معین بازنویسی می کند. در صورتی که content
بزرگتر از 10 مگابایت باشد، یک استثنا ایجاد می کند.
// Creates a text file with the content 'Hello, world!' const file = DriveApp.createFile('New Text File', 'Hello, world!'); // Logs the content of the text file to the console. console.log(file.getBlob().getDataAsString()); // Updates the content of the text file to 'Updated text!' file.setContent('Updated text!'); // Logs content of the text file to the console. console.log(file.getBlob().getDataAsString());
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
content | String | محتوای جدید فایل |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
setDescription(description)
setName(name)
setOwner(emailAddress)
مالک File
را تغییر می دهد. این روش همچنین به مالک قبلی دسترسی ویرایش صریح به File
را می دهد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
emailAddress | String | آدرس ایمیل کاربری که باید مالک جدید شود |
بازگشت
File
- این File
، برای زنجیر کردن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
setOwner(user)
مالک File
را تغییر می دهد. این روش همچنین به مالک قبلی دسترسی ویرایش صریح به File
را می دهد.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
user | User | نمایش کاربری که باید مالک جدید شود |
بازگشت
File
- این File
، برای زنجیر کردن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
setSecurityUpdateEnabled(enabled)
تعیین می کند که آیا File
هنگام اشتراک گذاری با استفاده از پیوند، به کلید منبع برای دسترسی نیاز دارد یا خیر. فایل ها و پوشه های واجد شرایط به طور پیش فرض فعال هستند.
درباره بهروزرسانی امنیتی Google Drive بیشتر بیاموزید.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
enabled | Boolean | فعال کردن کلید منبع مورد نیاز برای File . |
بازگشت
File
- این File
، برای زنجیر کردن.
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
setSharing(accessType, permissionType)
تعیین می کند که کدام دسته از کاربران می توانند به File
دسترسی داشته باشند و چه مجوزهایی به آن کاربران اعطا می شود، علاوه بر هر کاربر فردی که به طور صریح به آنها دسترسی داده شده است.
// Creates a folder that anyone on the Internet can read from and write to. // (Domain administrators can prohibit this setting for users of a Google // Workspace domain.) const folder = DriveApp.createFolder('Shared Folder'); folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
accessType | Access | کدام دسته از کاربران باید بتوانند به File دسترسی داشته باشند |
permissionType | Permission | مجوزهایی که باید به کاربرانی که می توانند به File دسترسی داشته باشند داده شود |
بازگشت
File
- این File
، برای زنجیر کردن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
setStarred(starred)
تعیین میکند که آیا File
در Drive کاربر ستارهدار شود یا خیر. پیش فرض برای File
جدید false
است.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
starred | Boolean | true اگر File باید در درایو کاربر ستاره دار شود. false اگر نه |
بازگشت
File
- این File
، برای زنجیر کردن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive
setTrashed(trashed)
تعیین می کند که آیا File
در سطل زباله درایو کاربر قرار دارد یا خیر. فقط مالک میتواند File
را حذف کند. پیش فرض برای File
جدید false
است.
پارامترها
نام | تایپ کنید | توضیحات |
---|---|---|
trashed | Boolean | true اگر File باید به سطل زباله درایو کاربر منتقل شود. false اگر نه |
بازگشت
File
- این File
، برای زنجیر کردن
مجوز
اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:
-
https://www.googleapis.com/auth/drive