یک فایل در گوگل درایو. فایلها را میتوان از طریق Drive App مشاهده یا ایجاد کرد.
// 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); } }
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Commenter(emailAddress) | File | کاربر داده شده را به لیست نظردهندگان File اضافه کنید. |
add Commenter(user) | File | کاربر داده شده را به لیست نظردهندگان File اضافه کنید. |
add Commenters(emailAddresses) | File | آرایه داده شده از کاربران را به لیست نظردهندگان File اضافه کنید. |
add Editor(emailAddress) | File | کاربر داده شده را به لیست ویرایشگرهای File اضافه میکند. |
add Editor(user) | File | کاربر داده شده را به لیست ویرایشگرهای File اضافه میکند. |
add Editors(emailAddresses) | File | آرایهی داده شده از کاربران را به لیست ویرایشگرهای File اضافه میکند. |
add Viewer(emailAddress) | File | کاربر داده شده را به لیست بینندگان File اضافه میکند. |
add Viewer(user) | File | کاربر داده شده را به لیست بینندگان File اضافه میکند. |
add Viewers(emailAddresses) | File | آرایهی داده شده از کاربران را به لیست بینندگان File اضافه میکند. |
get Access(email) | Permission | مجوز اعطا شده به یک کاربر خاص را دریافت میکند. |
get Access(user) | Permission | مجوز اعطا شده به یک کاربر خاص را دریافت میکند. |
get As(contentType) | Blob | دادههای درون این شیء را به صورت یک blob تبدیلشده به نوع محتوای مشخصشده، برمیگرداند. |
get Blob() | Blob | دادههای درون این شیء را به صورت یک blob برمیگرداند. |
get Date Created() | Date | تاریخ ایجاد File دریافت میکند. |
get Description() | String | توضیحات مربوط به File را دریافت میکند. |
get Download Url() | String | آدرس اینترنتی (URL) مورد استفاده برای دانلود فایل را دریافت میکند. |
get Editors() | User[] | لیست ویرایشگرهای این File را دریافت میکند. |
get Id() | String | شناسه File را دریافت میکند. |
get Last Updated() | Date | تاریخ آخرین بهروزرسانی File دریافت میکند. |
get Mime Type() | String | نوع MIME فایل را دریافت میکند. |
get Name() | String | نام File را دریافت میکند. |
get Owner() | User | مالک فایل را دریافت میکند. |
get Parents() | Folder Iterator | مجموعهای از پوشههایی را که والدهای بلافصل File هستند، برمیگرداند. |
get Resource Key() | String | کلید منبع File را که برای دسترسی به مواردی که با استفاده از یک لینک به اشتراک گذاشته شدهاند، مورد نیاز است، دریافت میکند. |
get Security Update Eligible() | Boolean | مشخص میکند که آیا این File واجد شرایط اعمال بهروزرسانی امنیتی است که برای دسترسی به آن، هنگام اشتراکگذاری با استفاده از یک لینک، به کلید منبع نیاز دارد یا خیر. |
get Security Update Enabled() | Boolean | مشخص میکند که آیا این File هنگام اشتراکگذاری با استفاده از یک لینک، برای دسترسی به کلید منبع نیاز دارد یا خیر. |
get Sharing Access() | Access | مشخص میکند که کدام دسته از کاربران میتوانند به File دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است. |
get Sharing Permission() | Permission | مجوزهای اعطا شده به کاربرانی که میتوانند به File دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است، را دریافت میکند. |
get Size() | Integer | تعداد بایتهای مورد استفاده برای ذخیره File در درایو را برمیگرداند. |
get Target Id() | String | اگر این یک میانبر (Shortcut) باشد، شناسه (ID) آیتمی که به آن اشاره میکند را برمیگرداند. |
get Target Mime Type() | String | اگر این یک Shortcut باشد، نوع MIME آیتمی که به آن اشاره میکند را برمیگرداند. |
get Target Resource Key() | String | اگر فایل یک میانبر باشد، کلید منبع آیتمی که به آن اشاره میکند را برمیگرداند. |
get Thumbnail() | Blob |null | یک تصویر کوچک برای فایل برمیگرداند، یا اگر هیچ تصویر کوچکی وجود نداشته باشد، null برمیگرداند. |
get Url() | String | آدرس اینترنتی (URL) مورد استفاده برای باز کردن File در یک برنامه گوگل مانند Drive یا Docs را دریافت میکند. |
get Viewers() | User[] | لیست بینندگان و نظردهندگان این File را دریافت میکند. |
is Shareable By Editors() | Boolean | تعیین میکند که آیا کاربرانی که مجوزهای ویرایش File را دارند، مجاز به اشتراکگذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر. |
is Starred() | Boolean | تعیین میکند که آیا File در درایو کاربر ستارهدار شده است یا خیر. |
is Trashed() | Boolean | تعیین میکند که آیا File در سطل زباله درایو کاربر قرار دارد یا خیر. |
make Copy() | File | یک کپی از فایل ایجاد میکند. |
make Copy(destination) | File | یک کپی از فایل را در دایرکتوری مقصد ایجاد میکند. |
make Copy(name) | File | یک کپی از فایل ایجاد میکند و آن را با نام ارائه شده نامگذاری میکند. |
make Copy(name, destination) | File | یک کپی از فایل را در دایرکتوری مقصد ایجاد میکند و آن را با نام ارائه شده نامگذاری میکند. |
move To(destination) | File | این مورد را به پوشه مقصد ارائه شده منتقل میکند. |
remove Commenter(emailAddress) | File | کاربر داده شده را از لیست نظردهندگان File حذف میکند. |
remove Commenter(user) | File | کاربر داده شده را از لیست نظردهندگان File حذف میکند. |
remove Editor(emailAddress) | File | کاربر داده شده را از لیست ویرایشگرهای File حذف میکند. |
remove Editor(user) | File | کاربر داده شده را از لیست ویرایشگرهای File حذف میکند. |
remove Viewer(emailAddress) | File | کاربر داده شده را از لیست بینندگان و نظردهندگان File حذف میکند. |
remove Viewer(user) | File | کاربر داده شده را از لیست بینندگان و نظردهندگان File حذف میکند. |
revoke Permissions(emailAddress) | File | دسترسی اعطا شده به کاربر داده شده به File را لغو میکند. |
revoke Permissions(user) | File | دسترسی اعطا شده به کاربر داده شده به File را لغو میکند. |
set Content(content) | File | محتوای فایل را با یک جایگزین داده شده رونویسی میکند. |
set Description(description) | File | توضیحات مربوط به File را تنظیم میکند. |
set Name(name) | File | نام File را تنظیم میکند. |
set Owner(emailAddress) | File | مالک File را تغییر میدهد. |
set Owner(user) | File | مالک File را تغییر میدهد. |
set Security Update Enabled(enabled) | File | تعیین میکند که آیا File هنگام اشتراکگذاری با استفاده از لینک، برای دسترسی به کلید منبع نیاز دارد یا خیر. |
set Shareable By Editors(shareable) | File | تعیین میکند که آیا کاربرانی که مجوزهای ویرایش File را دارند، مجاز به اشتراکگذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر. |
set Sharing(accessType, permissionType) | File | تعیین میکند که کدام دسته از کاربران میتوانند به File دسترسی داشته باشند و چه مجوزهایی به آن کاربران اعطا میشود، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است. |
set Starred(starred) | File | تعیین میکند که آیا File در درایو کاربر ستارهدار باشد یا خیر. |
set Trashed(trashed) | File | تعیین میکند که آیا File در سطل زباله درایو کاربر قرار دارد یا خیر. |
مستندات دقیق
add Commenter(emailAddress)
کاربر داده شده را به لیست نظردهندگان File اضافه کنید. اگر کاربر از قبل در لیست بینندگان بود، این متد کاربر را از لیست بینندگان خارج میکند.
const files = DriveApp.getFilesByName('Test'); // Loops through the files while (files.hasNext()) { const file = files.next(); file.addCommenter('hello@example.com'); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای اضافه کردن. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Commenter(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
add Commenters(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)); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Addresses | String[] | آرایهای از آدرسهای ایمیل کاربران برای اضافه کردن. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Editor(emailAddress)
کاربر داده شده را به لیست ویرایشگرهای File اضافه میکند. اگر کاربر از قبل در لیست بینندگان باشد، این متد کاربر را از لیست بینندگان خارج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای اضافه کردن. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Editor(user)
کاربر داده شده را به لیست ویرایشگرهای File اضافه میکند. اگر کاربر از قبل در لیست بینندگان باشد، این متد کاربر را از لیست بینندگان خارج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایشی از کاربر برای اضافه کردن. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Editors(emailAddresses)
آرایه داده شده از کاربران را به لیست ویرایشگرهای File اضافه میکند. اگر هر یک از کاربران از قبل در لیست بینندگان بودند، این متد آنها را از لیست بینندگان خارج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Addresses | String[] | آرایهای از آدرسهای ایمیل کاربران برای اضافه کردن. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Viewer(emailAddress)
کاربر داده شده را به لیست مشاهدهکنندگان File اضافه میکند. اگر کاربر از قبل در لیست ویرایشگران باشد، این متد هیچ تاثیری ندارد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای اضافه کردن. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Viewer(user)
کاربر داده شده را به لیست مشاهدهکنندگان File اضافه میکند. اگر کاربر از قبل در لیست ویرایشگران باشد، این متد هیچ تاثیری ندارد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایشی از کاربر برای اضافه کردن. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Viewers(emailAddresses)
آرایهی داده شده از کاربران را به لیست مشاهدهکنندگان File اضافه میکند. اگر هر یک از کاربران از قبل در لیست ویرایشگران باشند، این متد هیچ تاثیری روی آنها ندارد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Addresses | String[] | آرایهای از آدرسهای ایمیل کاربران برای اضافه کردن. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
get Access(email)
مجوزهای اعطا شده به یک کاربر خاص را دریافت میکند. این متد از بازگرداندن مجوزهای یک گروه گوگل یا مجوزهای به ارث رسیده از طریق گروههای گوگل پشتیبانی نمیکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email | String | آدرس ایمیل کاربری که مجوزهایش باید بررسی شود. گروههای گوگل پشتیبانی نمیشوند. |
بازگشت
Permission - مجوزهایی که به کاربر اعطا میشود.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Access(user)
مجوزهای اعطا شده به یک کاربر خاص را دریافت میکند. این متد از بازگرداندن مجوزهای یک گروه گوگل یا مجوزهای به ارث رسیده از طریق گروههای گوگل پشتیبانی نمیکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایشی از کاربری که مجوزهایش باید بررسی شود. |
بازگشت
Permission - مجوزهایی که به کاربر اعطا میشود.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get As(contentType)
دادههای درون این شیء را به صورت یک blob تبدیلشده به نوع محتوای مشخصشده برمیگرداند. این متد پسوند مناسب را به نام فایل اضافه میکند - برای مثال، "myfile.pdf". با این حال، فرض میکند که بخشی از نام فایل که پس از آخرین نقطه (در صورت وجود) میآید، یک پسوند موجود است که باید جایگزین شود. در نتیجه، "ShoppingList.12.25.2014" به "ShoppingList.12.25.pdf" تبدیل میشود.
برای مشاهده سهمیههای روزانه برای تبدیلها، به سهمیههای سرویسهای گوگل مراجعه کنید. دامنههای جدید Google Workspace ممکن است موقتاً مشمول سهمیههای سختگیرانهتری باشند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
content Type | String | نوع MIME برای تبدیل. برای اکثر blobها، 'application/pdf' تنها گزینه معتبر است. برای تصاویر با فرمت BMP، GIF، JPEG یا PNG، هر یک از 'image/bmp' ، 'image/gif' ، 'image/jpeg' یا 'image/png' نیز معتبر هستند. برای یک سند Google Docs، 'text/markdown' نیز معتبر است. |
بازگشت
Blob - دادهها به عنوان یک حباب.
get Blob()
get Date Created()
get Description()
get Download Url()
URL ای را که میتوان برای دانلود فایل استفاده کرد، دریافت میکند. فقط کاربرانی که مجوز باز کردن فایل در گوگل درایو را دارند میتوانند به URL دسترسی داشته باشند. میتوانید از این URL در مرورگر برای دانلود فایل استفاده کنید، اما نمیتوانید از آن برای دریافت فایل با استفاده از Url Fetch App استفاده کنید. اگر میخواهید محتوای فایل در اسکریپت باشد، get Blob() استفاده کنید.
// 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
get Editors()
لیست ویرایشگرهای این 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
get Id()
get Last Updated()
get Mime Type()
نوع 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
get Name()
get Owner()
مالک فایل را دریافت میکند.
// 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
get Parents()
مجموعهای از پوشههایی را که والدهای بلافصل File هستند، برمیگرداند.
بازگشت
Folder Iterator - مجموعهای از پوشهها که والد بلافصل File هستند
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Resource Key()
کلید منبع File را که برای دسترسی به مواردی که با استفاده از یک لینک به اشتراک گذاشته شدهاند، مورد نیاز است، دریافت میکند.
بازگشت
String - کلید منبع File .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Security Update Eligible()
مشخص میکند که آیا این File واجد شرایط اعمال بهروزرسانی امنیتی است که برای دسترسی به آن، هنگام اشتراکگذاری با استفاده از یک لینک، به کلید منبع نیاز دارد یا خیر.
درایو برای دسترسی به برخی از فایلها یا پوشههایی که با استفاده از یک لینک به اشتراک گذاشته شدهاند، به یک کلید منبع نیاز دارد. این تغییر بخشی از یک بهروزرسانی امنیتی است. بهروزرسانی به طور پیشفرض برای فایلها و پوشههای واجد شرایط فعال است. برای فعال یا غیرفعال کردن الزام کلید منبع برای فایلهای واجد شرایط، set Security Update Enabled استفاده کنید.
درباره بهروزرسانی امنیتی گوگل درایو بیشتر بدانید.
بازگشت
Boolean - آیا میتوان الزام کلید منبع را برای File اعمال کرد یا خیر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Security Update Enabled()
مشخص میکند که آیا این File هنگام اشتراکگذاری با استفاده از یک لینک، برای دسترسی به کلید منبع نیاز دارد یا خیر. این الزام به طور پیشفرض برای فایلها و پوشههای واجد شرایط فعال است. برای فعال یا غیرفعال کردن الزام کلید منبع برای فایلهای واجد شرایط، از setSecurityUpdateEnabled استفاده کنید.
درباره بهروزرسانی امنیتی گوگل درایو بیشتر بدانید.
بازگشت
Boolean - آیا الزام کلید منبع برای این File فعال شده است یا خیر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Sharing Access()
مشخص میکند که کدام دسته از کاربران میتوانند به File دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است.
بازگشت
Access - کدام دسته از کاربران میتوانند به File دسترسی داشته باشند
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Sharing Permission()
مجوزهای اعطا شده به کاربرانی که میتوانند به File دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است، را دریافت میکند.
بازگشت
Permission - مجوزهایی که به کاربرانی که میتوانند به File دسترسی داشته باشند، اعطا میشود.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Size()
تعداد بایتهای مورد استفاده برای ذخیره File در درایو را برمیگرداند. توجه داشته باشید که فایلهای برنامه Google Workspace جزو محدودیتهای ذخیرهسازی درایو محسوب نمیشوند و بنابراین 0 بایت برمیگردانند.
بازگشت
Integer - تعداد بایتهای مورد استفاده برای ذخیره File در درایو
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Target Id()
اگر این یک میانبر (Shortcut) باشد، شناسه (ID) آیتمی که به آن اشاره میکند را برمیگرداند.
در غیر این صورت 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 - شناسهی آیتم هدف.
get Target Mime Type()
اگر این یک Shortcut باشد، نوع 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 — نوع MIME آیتم هدف.
get Target Resource Key()
اگر فایل یک میانبر باشد، کلید منبع آیتمی که به آن اشاره میکند را برمیگرداند. کلید منبع یک پارامتر اضافی است که برای دسترسی به فایلهایی که با استفاده از یک لینک به اشتراک گذاشته شدهاند، باید ارسال کنید.
اگر فایل یک میانبر نباشد، 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
get Thumbnail()
یک تصویر کوچک برای فایل برمیگرداند، یا اگر هیچ تصویر کوچکی وجود نداشته باشد، 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 |null — تصویر کوچک مربوط به فایل.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Url()
آدرس اینترنتی (URL) مورد استفاده برای باز کردن File در یک برنامه گوگل مانند Drive یا Docs را دریافت میکند.
بازگشت
String - آدرس اینترنتی (URL) که میتوان از آن برای مشاهده این File در یک برنامه گوگل مانند Drive یا Docs استفاده کرد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Viewers()
لیست بینندگان و نظردهندگان این 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
is Starred()
تعیین میکند که آیا File در درایو کاربر ستارهدار شده است یا خیر.
بازگشت
Boolean - اگر File در درایو کاربر ستارهدار باشد، true و در غیر این صورت، false برمیگرداند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
is Trashed()
تعیین میکند که آیا File در سطل زباله درایو کاربر قرار دارد یا خیر.
بازگشت
Boolean - اگر File در سطل زباله درایو کاربر باشد، true و در غیر این صورت، false
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
make Copy()
یک کپی از فایل ایجاد میکند.
// 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
make Copy(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
make Copy(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
make Copy(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
move To(destination)
این مورد را به پوشه مقصد ارائه شده منتقل میکند.
کاربر فعلی باید مالک فایل باشد یا حداقل دسترسی ویرایش به پوشه والد فعلی آیتم را داشته باشد تا بتواند آیتم را به پوشه مقصد منتقل کند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
destination | Folder | پوشهای که به پوشهی والد جدید تبدیل میشود. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Commenter(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'); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای حذف. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Commenter(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
remove Editor(emailAddress)
کاربر داده شده را از لیست ویرایشگرهای File حذف میکند. این روش، دسترسی کاربران به File را در صورتی که به کلاسی از کاربران با دسترسی عمومی تعلق داشته باشند، مسدود نمیکند - برای مثال، اگر File با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر File در یک درایو مشترک باشد که کاربر میتواند به آن دسترسی داشته باشد.
برای فایلهای درایو، این کار کاربر را از فهرست مشاهدهکنندگان نیز حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای حذف. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Editor(user)
کاربر داده شده را از لیست ویرایشگرهای File حذف میکند. این روش، دسترسی کاربران به File را در صورتی که به کلاسی از کاربران با دسترسی عمومی تعلق داشته باشند، مسدود نمیکند - برای مثال، اگر File با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر File در یک درایو مشترک باشد که کاربر میتواند به آن دسترسی داشته باشد.
برای فایلهای درایو، این کار کاربر را از فهرست مشاهدهکنندگان نیز حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایندهای از کاربر که باید حذف شود. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Viewer(emailAddress)
کاربر داده شده را از لیست بینندگان و نظردهندگان File حذف میکند. این روش در صورتی که کاربر ویرایشگر باشد، نه بیننده یا نظردهنده، هیچ تاثیری ندارد. این روش همچنین دسترسی کاربران به File را در صورتی که متعلق به کلاسی از کاربران با دسترسی عمومی باشند، مسدود نمیکند - به عنوان مثال، اگر File با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر File در یک درایو مشترک باشد که کاربر میتواند به آن دسترسی داشته باشد.
برای فایلهای درایو، این کار کاربر را از فهرست ویرایشگرها نیز حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای حذف. |
بازگشت
File — این File برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Viewer(user)
کاربر داده شده را از لیست بینندگان و نظردهندگان File حذف میکند. اگر کاربر ویرایشگر باشد، نه بیننده، این روش هیچ تاثیری ندارد. این روش همچنین دسترسی کاربران به File را در صورتی که متعلق به کلاسی از کاربران با دسترسی عمومی باشند، مسدود نمیکند - برای مثال، اگر File با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر File در یک درایو مشترک باشد که کاربر میتواند به آن دسترسی داشته باشد.
برای فایلهای درایو، این کار کاربر را از فهرست ویرایشگرها نیز حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایندهای از کاربر که باید حذف شود. |
بازگشت
File — این File برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
revoke Permissions(emailAddress)
دسترسی اعطا شده به کاربر داده شده به File را لغو میکند. این روش، دسترسی کاربران به File را در صورتی که به کلاسی از کاربران با دسترسی عمومی تعلق داشته باشند، مسدود نمیکند - برای مثال، اگر File با کل دامنه کاربر به اشتراک گذاشته شده باشد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربری که دسترسی او باید لغو شود. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
revoke Permissions(user)
دسترسی اعطا شده به کاربر داده شده به File را لغو میکند. این روش، دسترسی کاربران به File را در صورتی که به کلاسی از کاربران با دسترسی عمومی تعلق داشته باشند، مسدود نمیکند - برای مثال، اگر File با کل دامنه کاربر به اشتراک گذاشته شده باشد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایشی از کاربری که دسترسیاش باید لغو شود. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Content(content)
محتوای فایل را با یک جایگزین مشخص رونویسی میکند. اگر content بزرگتر از ۱۰ مگابایت باشد، استثنا ایجاد میکند.
// 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
set Description(description)
set Name(name)
set Owner(emailAddress)
مالک File را تغییر میدهد. این روش همچنین به مالک قبلی دسترسی ویرایش صریح به File را میدهد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربری که باید مالک جدید شود |
بازگشت
File — این File ، برای زنجیرهسازی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Owner(user)
مالک File را تغییر میدهد. این روش همچنین به مالک قبلی دسترسی ویرایش صریح به File را میدهد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایندهای از کاربری که باید مالک جدید شود |
بازگشت
File — این File ، برای زنجیرهسازی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Security Update Enabled(enabled)
تعیین میکند که آیا File هنگام اشتراکگذاری با استفاده از لینک، برای دسترسی به کلید منبع نیاز دارد یا خیر. فایلها و پوشههای واجد شرایط به طور پیشفرض فعال هستند.
درباره بهروزرسانی امنیتی گوگل درایو بیشتر بدانید.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
enabled | Boolean | آیا الزام کلید منبع برای File فعال شود یا خیر. |
بازگشت
File — این File ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Sharing(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);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
access Type | Access | کدام دسته از کاربران باید بتوانند به File دسترسی داشته باشند؟ |
permission Type | Permission | مجوزهایی که باید به کاربرانی که میتوانند به File دسترسی داشته باشند، اعطا شود |
بازگشت
File — این File ، برای زنجیرهسازی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Starred(starred)
تعیین میکند که آیا File در درایو کاربر ستارهدار باشد یا خیر. مقدار پیشفرض برای new File ، false است.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
starred | Boolean | اگر File باید در درایو کاربر ستارهدار باشد، true و در غیر این صورت false برمیگرداند. |
بازگشت
File — این File ، برای زنجیرهسازی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Trashed(trashed)
تعیین میکند که آیا File در سطل زباله درایو کاربر قرار دارد یا خیر. فقط مالک میتواند File حذف کند. مقدار پیشفرض برای new File false است.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
trashed | Boolean | اگر File باید به سطل زباله درایو کاربر منتقل شود، true و در غیر این صورت false |
بازگشت
File — این File ، برای زنجیرهسازی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive