یک پوشه در گوگل درایو. پوشهها را میتوان از طریق Drive App ایجاد یا به آنها دسترسی پیدا کرد.
// Log the name of every folder in the user's Drive. const folders = DriveApp.getFolders(); while (folders.hasNext()) { const folder = folders.next(); Logger.log(folder.getName()); }
روشها
| روش | نوع بازگشتی | شرح مختصر |
|---|---|---|
add Editor(emailAddress) | Folder | کاربر داده شده را به لیست ویرایشگرهای Folder اضافه میکند. |
add Editor(user) | Folder | کاربر داده شده را به لیست ویرایشگرهای Folder اضافه میکند. |
add Editors(emailAddresses) | Folder | آرایهی داده شده از کاربران را به لیست ویرایشگرهای Folder اضافه میکند. |
add Viewer(emailAddress) | Folder | کاربر داده شده را به لیست بینندگان Folder اضافه میکند. |
add Viewer(user) | Folder | کاربر داده شده را به لیست بینندگان Folder اضافه میکند. |
add Viewers(emailAddresses) | Folder | آرایهی داده شده از کاربران را به لیست بینندگان Folder اضافه میکند. |
create File(blob) | File | یک فایل در پوشه فعلی از یک Blob داده دلخواه ایجاد میکند. |
create File(name, content) | File | یک فایل متنی در پوشه فعلی با نام و محتوای مشخص شده ایجاد میکند. |
create File(name, content, mimeType) | File | یک فایل در پوشه فعلی با نام، محتویات و نوع MIME داده شده ایجاد میکند. |
create Folder(name) | Folder | یک پوشه در پوشه فعلی با نام داده شده ایجاد میکند. |
create Shortcut(targetId) | File | یک میانبر برای شناسهی آیتم درایو ارائه شده ایجاد میکند و آن را برمیگرداند. |
create Shortcut For Target Id And Resource Key(targetId, targetResourceKey) | File | یک میانبر برای شناسه آیتم درایو و کلید منبع ارائه شده ایجاد میکند و آن را برمیگرداند. |
get Access(email) | Permission | مجوز اعطا شده به یک کاربر خاص را دریافت میکند. |
get Access(user) | Permission | مجوز اعطا شده به یک کاربر خاص را دریافت میکند. |
get Date Created() | Date | تاریخ ایجاد Folder را دریافت میکند. |
get Description() | String | توضیحات مربوط به Folder را دریافت میکند. |
get Editors() | User[] | لیست ویرایشگرهای این Folder را دریافت میکند. |
get Files() | File Iterator | مجموعهای از تمام فایلهایی که فرزند پوشهی فعلی هستند را برمیگرداند. |
get Files By Name(name) | File Iterator | مجموعهای از تمام فایلهایی که فرزند پوشهی فعلی هستند و نام داده شده را دارند، دریافت میکند. |
get Files By Type(mimeType) | File Iterator | مجموعهای از تمام فایلهایی که فرزند پوشهی فعلی هستند و نوع MIME داده شده را دارند، دریافت میکند. |
get Folders() | Folder Iterator | مجموعهای از تمام پوشههایی که فرزند پوشه فعلی هستند را برمیگرداند. |
get Folders By Name(name) | Folder Iterator | مجموعهای از تمام پوشههایی که فرزند پوشه فعلی هستند و نام داده شده را دارند، دریافت میکند. |
get Id() | String | شناسه Folder را دریافت میکند. |
get Last Updated() | Date | تاریخ آخرین بهروزرسانی Folder را دریافت میکند. |
get Name() | String | نام Folder را دریافت میکند. |
get Owner() | User | مالک این Folder را دریافت میکند. |
get Parents() | Folder Iterator | مجموعهای از پوشههایی را که والد بیواسطهی Folder هستند، برمیگرداند. |
get Resource Key() | String | کلید منبع Folder را که برای دسترسی به مواردی که با استفاده از یک لینک به اشتراک گذاشته شدهاند، لازم است، دریافت میکند. |
get Security Update Eligible() | Boolean | مشخص میکند که آیا این Folder واجد شرایط اعمال بهروزرسانی امنیتی است که برای دسترسی به آن، هنگام اشتراکگذاری با استفاده از یک لینک، به کلید منبع نیاز دارد یا خیر. |
get Security Update Enabled() | Boolean | مشخص میکند که آیا این Folder هنگام اشتراکگذاری با استفاده از یک لینک، برای دسترسی به کلید منبع نیاز دارد یا خیر. |
get Sharing Access() | Access | مشخص میکند که کدام دسته از کاربران میتوانند به Folder دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است. |
get Sharing Permission() | Permission | مجوزهای اعطا شده به کاربرانی که میتوانند به Folder دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است، را دریافت میکند. |
get Size() | Integer | تعداد بایتهای مورد استفاده برای ذخیره Folder در درایو را برمیگرداند. |
get Url() | String | آدرس اینترنتی (URL) مورد استفاده برای باز کردن Folder در یک برنامه گوگل مانند Drive یا Docs را دریافت میکند. |
get Viewers() | User[] | لیست بینندگان و نظردهندگان این Folder را دریافت میکند. |
is Shareable By Editors() | Boolean | تعیین میکند که آیا کاربرانی که مجوزهای ویرایش Folder را دارند، مجاز به اشتراکگذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر. |
is Starred() | Boolean | تعیین میکند که آیا Folder در درایو کاربر ستارهدار شده است یا خیر. |
is Trashed() | Boolean | تعیین میکند که آیا Folder در سطل زباله درایو کاربر قرار دارد یا خیر. |
move To(destination) | Folder | این مورد را به پوشه مقصد ارائه شده منتقل میکند. |
remove Editor(emailAddress) | Folder | کاربر داده شده را از لیست ویرایشگرهای Folder حذف میکند. |
remove Editor(user) | Folder | کاربر داده شده را از لیست ویرایشگرهای Folder حذف میکند. |
remove Viewer(emailAddress) | Folder | کاربر داده شده را از لیست بینندگان و نظردهندگان Folder حذف میکند. |
remove Viewer(user) | Folder | کاربر داده شده را از لیست بینندگان و نظردهندگان Folder حذف میکند. |
revoke Permissions(emailAddress) | Folder | دسترسی اعطا شده به کاربر داده شده به Folder را لغو میکند. |
revoke Permissions(user) | Folder | دسترسی اعطا شده به کاربر داده شده به Folder را لغو میکند. |
search Files(params) | File Iterator | مجموعهای از تمام فایلهایی که فرزند پوشهی فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند را برمیگرداند. |
search Folders(params) | Folder Iterator | مجموعهای از تمام پوشههایی که زیرمجموعه پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند را دریافت میکند. |
set Description(description) | Folder | توضیحات مربوط به Folder را تنظیم میکند. |
set Name(name) | Folder | نام Folder را تنظیم میکند. |
set Owner(emailAddress) | Folder | مالک Folder را تغییر میدهد. |
set Owner(user) | Folder | مالک Folder را تغییر میدهد. |
set Security Update Enabled(enabled) | Folder | تعیین میکند که آیا Folder هنگام اشتراکگذاری با استفاده از یک لینک، برای دسترسی به کلید منبع نیاز دارد یا خیر. |
set Shareable By Editors(shareable) | Folder | تعیین میکند که آیا کاربرانی که مجوزهای ویرایش Folder را دارند، مجاز به اشتراکگذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر. |
set Sharing(accessType, permissionType) | Folder | تعیین میکند که کدام دسته از کاربران میتوانند به Folder دسترسی داشته باشند و چه مجوزهایی به آن کاربران اعطا میشود، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است. |
set Starred(starred) | Folder | تعیین میکند که آیا Folder در درایو کاربر ستارهدار باشد یا خیر. |
set Trashed(trashed) | Folder | تعیین میکند که آیا Folder در سطل زباله درایو کاربر قرار دارد یا خیر. |
مستندات دقیق
add Editor(emailAddress)
کاربر داده شده را به لیست ویرایشگران Folder اضافه میکند. اگر کاربر از قبل در لیست بینندگان باشد، این متد کاربر را از لیست بینندگان خارج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای اضافه کردن. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Editor(user)
کاربر داده شده را به لیست ویرایشگران Folder اضافه میکند. اگر کاربر از قبل در لیست بینندگان باشد، این متد کاربر را از لیست بینندگان خارج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایشی از کاربر برای اضافه کردن. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Editors(emailAddresses)
آرایه داده شده از کاربران را به لیست ویرایشگرهای Folder اضافه میکند. اگر هر یک از کاربران از قبل در لیست بینندگان بودند، این متد آنها را از لیست بینندگان خارج میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Addresses | String[] | آرایهای از آدرسهای ایمیل کاربران برای اضافه کردن. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Viewer(emailAddress)
کاربر داده شده را به لیست مشاهدهکنندگان Folder اضافه میکند. اگر کاربر از قبل در لیست ویرایشگران باشد، این متد هیچ تاثیری ندارد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای اضافه کردن. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Viewer(user)
کاربر داده شده را به لیست مشاهدهکنندگان Folder اضافه میکند. اگر کاربر از قبل در لیست ویرایشگران باشد، این متد هیچ تاثیری ندارد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایشی از کاربر برای اضافه کردن. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
add Viewers(emailAddresses)
آرایه داده شده از کاربران را به لیست بینندگان Folder اضافه میکند. اگر هر یک از کاربران از قبل در لیست ویرایشگران بودند، این متد هیچ تاثیری روی آنها ندارد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Addresses | String[] | آرایهای از آدرسهای ایمیل کاربران برای اضافه کردن. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
create File(blob)
یک فایل در پوشه فعلی از یک Blob داده دلخواه ایجاد میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
blob | Blob Source | دادههای مربوط به فایل جدید. |
بازگشت
File — فایل جدید.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
create File(name, content)
یک فایل متنی در پوشه فعلی با نام و محتوای مشخص شده ایجاد میکند. اگر content بزرگتر از ۵۰ مگابایت باشد، استثنا ایجاد میکند.
// Create a text file with the content "Hello, world!" DriveApp.getRootFolder().createFile('New Text File', 'Hello, world!');
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
name | String | نام فایل جدید. |
content | String | محتوای فایل جدید. |
بازگشت
File — فایل جدید.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
create File(name, content, mimeType)
یک فایل در پوشه فعلی با نام، محتویات و نوع MIME داده شده ایجاد میکند. اگر content بزرگتر از 10 مگابایت باشد، استثنا ایجاد میکند.
// Create an HTML file with the content "Hello, world!" DriveApp.getRootFolder().createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
name | String | نام فایل جدید. |
content | String | محتوای فایل جدید. |
mime Type | String | نوع MIME فایل جدید. |
بازگشت
File — فایل جدید.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
create Folder(name)
create Shortcut(targetId)
یک میانبر برای شناسهی آیتم درایو ارائه شده ایجاد میکند و آن را برمیگرداند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
target Id | String | شناسه فایل یا پوشه هدف. |
بازگشت
File — میانبر جدید.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
create Shortcut For Target Id And Resource Key(targetId, targetResourceKey)
یک میانبر برای شناسه آیتم درایو و کلید منبع ارائه شده ایجاد میکند و آن را برمیگرداند. کلید منبع یک پارامتر اضافی است که برای دسترسی به فایل یا پوشه هدف که با استفاده از یک لینک به اشتراک گذاشته شده است، باید ارسال شود.
// Creates shortcuts for all folders in the user's drive that have a specific // name. // TODO(developer): Replace 'Test-Folder' with a valid folder name in your // drive. const folders = DriveApp.getFoldersByName('Test-Folder'); // Iterates through all folders named 'Test-Folder'. while (folders.hasNext()) { const folder = folders.next(); // Creates a shortcut to the provided Drive item ID and resource key, and // returns it. DriveApp.createShortcutForTargetIdAndResourceKey( folder.getId(), folder.getResourceKey(), ); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
target Id | String | شناسه فایل یا پوشه هدف. |
target Resource Key | String | کلید منبع فایل یا پوشهی هدف. |
بازگشت
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 Date Created()
get Description()
get Editors()
لیست ویرایشگرهای این Folder را دریافت میکند. اگر کاربری که اسکریپت را اجرا میکند، دسترسی ویرایش به Folder را نداشته باشد، این متد یک آرایه خالی برمیگرداند.
// Gets a folder by its ID. // TODO(developer): Replace the folder ID with your own. const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz'); // Gets the list of editors and logs their names to the console. const editors = folder.getEditors(); for (const editor of editors) { console.log(editor.getName()); }
بازگشت
User[] — فهرست ویرایشگرهای این Folder در صورتی که کاربر دسترسی ویرایش داشته باشد یا در غیر این صورت یک آرایه خالی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Files()
مجموعهای از تمام فایلهایی که فرزند پوشهی فعلی هستند را برمیگرداند.
بازگشت
File Iterator - مجموعهای از تمام فایلهایی که فرزندان پوشه فعلی هستند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Files By Name(name)
مجموعهای از تمام فایلهایی که فرزند پوشهی فعلی هستند و نام داده شده را دارند، دریافت میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
name | String | نام فایلهایی که باید پیدا شوند. |
بازگشت
File Iterator - مجموعهای از تمام فایلهایی که فرزندان پوشه فعلی هستند و نام داده شده را دارند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Files By Type(mimeType)
مجموعهای از تمام فایلهایی که فرزند پوشهی فعلی هستند و نوع MIME داده شده را دارند، دریافت میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
mime Type | String | نوع MIME فایلهایی که باید پیدا شوند. |
بازگشت
File Iterator - مجموعهای از تمام فایلهایی که فرزند پوشه فعلی هستند و نوع MIME داده شده را دارند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Folders()
مجموعهای از تمام پوشههایی که فرزند پوشه فعلی هستند را برمیگرداند.
بازگشت
Folder Iterator - مجموعهای از تمام پوشههایی که فرزند پوشه فعلی هستند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Folders By Name(name)
مجموعهای از تمام پوشههایی که فرزند پوشه فعلی هستند و نام داده شده را دارند، دریافت میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
name | String | نام پوشههایی که باید پیدا شوند. |
بازگشت
Folder Iterator - مجموعهای از تمام پوشههایی که فرزند پوشه فعلی هستند و نام داده شده را دارند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Id()
get Last Updated()
get Name()
get Owner()
مالک این Folder را دریافت میکند.
// Gets a folder by its ID. // TODO(developer): Replace the folder ID with your own. const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz'); // Gets the owner of the folder and logs the name to the console. const folderOwner = folder.getOwner(); console.log(folderOwner.getName());
بازگشت
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Parents()
مجموعهای از پوشههایی را که والد بیواسطهی Folder هستند، برمیگرداند.
بازگشت
Folder Iterator - مجموعهای از پوشهها که والد بلافصل Folder هستند
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Resource Key()
کلید منبع Folder را که برای دسترسی به مواردی که با استفاده از یک لینک به اشتراک گذاشته شدهاند، لازم است، دریافت میکند.
بازگشت
String - کلید منبع Folder .
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Security Update Eligible()
مشخص میکند که آیا این Folder واجد شرایط اعمال بهروزرسانی امنیتی است که برای دسترسی به آن، هنگام اشتراکگذاری با استفاده از یک لینک، به کلید منبع نیاز دارد یا خیر.
درایو برای دسترسی به برخی از فایلها یا پوشههایی که با استفاده از یک لینک به اشتراک گذاشته شدهاند، به یک کلید منبع نیاز دارد. این تغییر بخشی از یک بهروزرسانی امنیتی است. بهروزرسانی بهطور پیشفرض برای فایلها و پوشههای واجد شرایط فعال است. برای فعال یا غیرفعال کردن الزام کلید منبع برای فایلهای واجد شرایط، set Security Update Enabled استفاده کنید.
درباره بهروزرسانی امنیتی گوگل درایو بیشتر بدانید.
بازگشت
Boolean - آیا میتوان الزام کلید منبع را برای Folder اعمال کرد یا خیر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Security Update Enabled()
مشخص میکند که آیا این Folder هنگام اشتراکگذاری با استفاده از یک لینک، برای دسترسی به کلید منبع نیاز دارد یا خیر. این الزام به طور پیشفرض برای فایلها و پوشههای واجد شرایط فعال است. برای فعال یا غیرفعال کردن الزام کلید منبع برای فایلهای واجد شرایط، از setSecurityUpdateEnabled استفاده کنید.
درباره بهروزرسانی امنیتی گوگل درایو بیشتر بدانید.
بازگشت
Boolean - آیا الزام کلید منبع برای این Folder فعال شده است یا خیر.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Sharing Access()
مشخص میکند که کدام دسته از کاربران میتوانند به Folder دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است.
بازگشت
Access - کدام دسته از کاربران میتوانند به Folder دسترسی داشته باشند
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Sharing Permission()
مجوزهای اعطا شده به کاربرانی که میتوانند به Folder دسترسی داشته باشند، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است، را دریافت میکند.
بازگشت
Permission - مجوزهایی که به کاربرانی که میتوانند به Folder دسترسی داشته باشند، اعطا میشود
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Size()
تعداد بایتهای مورد استفاده برای ذخیره Folder در درایو را برمیگرداند. توجه داشته باشید که فایلهای برنامه Google Workspace جزو محدودیتهای ذخیرهسازی درایو محسوب نمیشوند و بنابراین 0 بایت را برمیگردانند.
بازگشت
Integer - تعداد بایتهای مورد استفاده برای ذخیره Folder در درایو
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Url()
آدرس اینترنتی (URL) مورد استفاده برای باز کردن Folder در یک برنامه گوگل مانند Drive یا Docs را دریافت میکند.
بازگشت
String - آدرس اینترنتی (URL) که میتوان از آن برای مشاهده این Folder در یک برنامه گوگل مانند Drive یا Docs استفاده کرد.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
get Viewers()
لیست بینندگان و نظردهندگان این Folder را دریافت میکند. اگر کاربری که اسکریپت را اجرا میکند، دسترسی ویرایش Folder را نداشته باشد، این متد یک آرایه خالی برمیگرداند.
// Gets a folder by its ID. // TODO(developer): Replace the folder ID with your own. const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz'); // Gets the list of viewers and logs their names to the console. const viewers = folder.getViewers(); for (const viewer of viewers) { console.log(viewer.getName()); }
بازگشت
User[] — فهرست بینندگان و نظردهندگان این Folder در صورتی که کاربر دسترسی ویرایش داشته باشد یا در غیر این صورت یک آرایه خالی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
is Starred()
تعیین میکند که آیا Folder در درایو کاربر ستارهدار شده است یا خیر.
بازگشت
Boolean - اگر Folder در درایو کاربر ستارهدار باشد، true و در غیر این صورت، false برمیگرداند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
is Trashed()
تعیین میکند که آیا Folder در سطل زباله درایو کاربر قرار دارد یا خیر.
بازگشت
Boolean - اگر Folder در سطل زباله درایو کاربر باشد، true و در غیر این صورت، false
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
move To(destination)
این مورد را به پوشه مقصد ارائه شده منتقل میکند.
کاربر فعلی باید مالک فایل باشد یا حداقل دسترسی ویرایش به پوشه والد فعلی آیتم را داشته باشد تا بتواند آیتم را به پوشه مقصد منتقل کند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
destination | Folder | پوشهای که به پوشهی والد جدید تبدیل میشود. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Editor(emailAddress)
کاربر داده شده را از لیست ویرایشگرهای Folder حذف میکند. این روش، دسترسی کاربران به Folder را در صورتی که متعلق به دستهای از کاربران با دسترسی عمومی باشند، مسدود نمیکند - برای مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Folder در یک درایو مشترک باشد که کاربر میتواند به آن دسترسی داشته باشد.
برای فایلهای درایو، این کار کاربر را از فهرست مشاهدهکنندگان نیز حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای حذف. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Editor(user)
کاربر داده شده را از لیست ویرایشگرهای Folder حذف میکند. این روش، دسترسی کاربران به Folder را در صورتی که متعلق به دستهای از کاربران با دسترسی عمومی باشند، مسدود نمیکند - برای مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Folder در یک درایو مشترک باشد که کاربر میتواند به آن دسترسی داشته باشد.
برای فایلهای درایو، این کار کاربر را از فهرست مشاهدهکنندگان نیز حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایندهای از کاربر که باید حذف شود. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Viewer(emailAddress)
کاربر داده شده را از لیست بینندگان و نظردهندگان Folder حذف میکند. این روش در صورتی که کاربر ویرایشگر باشد، نه بیننده یا نظردهنده، هیچ تاثیری ندارد. این روش همچنین دسترسی کاربران به Folder را در صورتی که متعلق به دستهای از کاربران با دسترسی عمومی باشند، مسدود نمیکند - به عنوان مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Folder در یک درایو مشترک باشد که کاربر میتواند به آن دسترسی داشته باشد.
برای فایلهای درایو، این کار کاربر را از فهرست ویرایشگرها نیز حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربر برای حذف. |
بازگشت
Folder — این Folder برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
remove Viewer(user)
کاربر داده شده را از لیست بینندگان و نظردهندگان Folder حذف میکند. اگر کاربر ویرایشگر باشد، نه بیننده، این روش هیچ تاثیری ندارد. این روش همچنین دسترسی کاربران به Folder را در صورتی که متعلق به کلاسی از کاربران با دسترسی عمومی باشند، مسدود نمیکند - به عنوان مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Folder در یک درایو مشترک باشد که کاربر میتواند به آن دسترسی داشته باشد.
برای فایلهای درایو، این کار کاربر را از فهرست ویرایشگرها نیز حذف میکند.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایندهای از کاربر که باید حذف شود. |
بازگشت
Folder — این Folder برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
revoke Permissions(emailAddress)
دسترسی اعطا شده به کاربر داده شده به Folder را لغو میکند. این روش، دسترسی کاربران به Folder را در صورتی که متعلق به کلاسی از کاربران با دسترسی عمومی باشند، مسدود نمیکند - برای مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربری که دسترسی او باید لغو شود. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
revoke Permissions(user)
دسترسی اعطا شده به کاربر داده شده به Folder را لغو میکند. این روش، دسترسی کاربران به Folder را در صورتی که متعلق به کلاسی از کاربران با دسترسی عمومی باشند، مسدود نمیکند - برای مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایشی از کاربری که دسترسیاش باید لغو شود. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
search Files(params)
مجموعهای از تمام فایلهایی را که فرزند پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند، دریافت میکند. معیارهای جستجو در مستندات SDK گوگل درایو به تفصیل شرح داده شده است. توجه داشته باشید که سرویس درایو از نسخه ۲ رابط برنامهنویسی کاربردی درایو استفاده میکند و برخی از فیلدهای پرسوجو با نسخه ۳ متفاوت هستند. تفاوتهای فیلدها بین نسخه ۲ و ۳ را بررسی کنید.
آرگومان params یک رشته پرسوجو است که میتواند شامل مقادیر رشتهای باشد، بنابراین مراقب باشید که علامتهای نقل قول را به درستی قرار دهید (برای مثال "title contains 'Gulliver\\'s Travels'" یا 'title contains "Gulliver\'s Travels"' ).
// Logs the name of every file that are children of the current folder and modified after February 28, // 2022 whose name contains "untitled."" const files = DriveApp.getRootFolder().searchFiles( 'modifiedDate > "2022-02-28" and title contains "untitled"'); while (files.hasNext()) { const file = files.next(); console.log(file.getName()); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
params | String | معیارهای جستجو، همانطور که در مستندات SDK گوگل درایو به تفصیل آمده است. |
بازگشت
File Iterator - مجموعهای از تمام فایلهایی که فرزندان پوشه فعلی هستند و با معیارهای جستجو مطابقت دارند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
search Folders(params)
مجموعهای از تمام پوشههایی که فرزند پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند را دریافت میکند. معیارهای جستجو در مستندات SDK گوگل درایو به تفصیل شرح داده شده است. توجه داشته باشید که سرویس درایو از نسخه ۲ رابط برنامهنویسی کاربردی درایو استفاده میکند و برخی از فیلدهای پرسوجو با نسخه ۳ متفاوت هستند. تفاوتهای فیلدها بین نسخه ۲ و ۳ را بررسی کنید.
آرگومان params یک رشته پرسوجو است که میتواند شامل مقادیر رشتهای باشد، بنابراین مراقب باشید که علامتهای نقل قول را به درستی قرار دهید (برای مثال "title contains 'Gulliver\\'s Travels'" یا 'title contains "Gulliver\'s Travels"' ).
// Logs the name of every folder that are children of the current folder and you own and is starred. const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners'); while (folders.hasNext()) { const folder = folders.next(); console.log(folder.getName()); }
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
params | String | معیارهای جستجو، همانطور که در مستندات SDK گوگل درایو به تفصیل آمده است. |
بازگشت
Folder Iterator - مجموعهای از تمام پوشههایی که فرزندان پوشه فعلی هستند و با معیارهای جستجو مطابقت دارند.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive.readonly -
https://www.googleapis.com/auth/drive
set Description(description)
set Name(name)
set Owner(emailAddress)
مالک Folder را تغییر میدهد. این روش همچنین به مالک قبلی دسترسی ویرایش صریح به Folder را میدهد.
درایو از تغییر مالکیت مواردی که متعلق به حسابهای gmail.com هستند پشتیبانی نمیکند؛ اما برای حسابهای Workspace پشتیبانی میشود.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
email Address | String | آدرس ایمیل کاربری که قرار است مالک جدید شود. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Owner(user)
مالک Folder را تغییر میدهد. این روش همچنین به مالک قبلی دسترسی ویرایش صریح به Folder را میدهد.
درایو از تغییر مالکیت مواردی که متعلق به حسابهای gmail.com هستند پشتیبانی نمیکند؛ اما برای حسابهای Workspace پشتیبانی میشود.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
user | User | نمایندهای از کاربری که باید مالک جدید شود. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Security Update Enabled(enabled)
تنظیم میکند که آیا Folder هنگام اشتراکگذاری با استفاده از لینک، برای دسترسی به کلید منبع نیاز دارد یا خیر. فایلها و پوشههای واجد شرایط به طور پیشفرض فعال هستند.
درباره بهروزرسانی امنیتی گوگل درایو بیشتر بدانید.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
enabled | Boolean | آیا الزام کلید منبع برای Folder فعال شود یا خیر. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی.
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Sharing(accessType, permissionType)
تعیین میکند که کدام دسته از کاربران میتوانند به Folder دسترسی داشته باشند و چه مجوزهایی به آن کاربران اعطا میشود، علاوه بر هر کاربر شخصی که صراحتاً به او دسترسی داده شده است.
// 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 | کدام دسته از کاربران باید بتوانند به Folder دسترسی داشته باشند؟ |
permission Type | Permission | مجوزهایی که باید به کاربرانی که میتوانند به Folder دسترسی داشته باشند، اعطا شود |
بازگشت
Folder — این Folder ، برای زنجیرهسازی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Starred(starred)
تنظیم میکند که آیا Folder در درایو کاربر ستارهدار باشد یا خیر. مقدار پیشفرض برای new Folder s، false است.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
starred | Boolean | اگر Folder باید در درایو کاربر ستارهدار باشد، true و در غیر این صورت false برمیگرداند. |
بازگشت
Folder — این Folder ، برای زنجیرهسازی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive
set Trashed(trashed)
تعیین میکند که آیا Folder در سطل زباله درایو کاربر قرار دارد یا خیر. فقط مالک میتواند Folder به سطل زباله بفرستد. مقدار پیشفرض برای new Folder s false است.
پارامترها
| نام | نوع | توضیحات |
|---|---|---|
trashed | Boolean | اگر Folder باید به سطل زباله درایو کاربر منتقل شود، true و در غیر این صورت false |
بازگشت
Folder — این Folder ، برای زنجیرهسازی
مجوز
اسکریپتهایی که از این روش استفاده میکنند، نیاز به مجوز با یک یا چند مورد از حوزههای زیر دارند:
-
https://www.googleapis.com/auth/drive