Class Folder

پوشه

پوشه ای در گوگل درایو پوشه ها را می توان از 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 یک میانبر برای شناسه مورد ارائه شده Drive ایجاد می کند و آن را برمی گرداند.
create Shortcut For Target Id And Resource Key(targetId, targetResourceKey) File یک میانبر برای شناسه مورد و کلید منبع ارائه شده Drive ایجاد می کند و آن را برمی گرداند.
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 در Drive را دریافت می کند.
get Url() String نشانی اینترنتی را دریافت می کند که می تواند برای باز کردن Folder در برنامه Google مانند Drive یا Docs استفاده شود.
get Viewers() User[] لیست بینندگان و نظر دهندگان را برای این Folder دریافت می کند.
is Shareable By Editors() Boolean تعیین می کند که آیا کاربرانی که مجوزهای ویرایش Folder را دارند مجاز به اشتراک گذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر.
is Starred() Boolean تعیین می کند که آیا Folder در Drive کاربر ستاره گذاری شده است یا خیر.
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 در Drive کاربر ستاره‌دار شود یا خیر.
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 بزرگتر از 50 مگابایت باشد، یک استثنا ایجاد می کند. 

// 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)

یک پوشه در پوشه فعلی با نام داده شده ایجاد می کند.

پارامترها

نام تایپ کنید توضیحات
name String نام پوشه جدید.

بازگشت

Folder - پوشه جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

create Shortcut(targetId)

یک میانبر برای شناسه مورد ارائه شده Drive ایجاد می کند و آن را برمی گرداند.

پارامترها

نام تایپ کنید توضیحات
target Id String شناسه فایل فایل یا پوشه مورد نظر.

بازگشت

File - میانبر جدید.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

create Shortcut For Target Id And Resource Key(targetId, targetResourceKey)

یک میانبر برای شناسه مورد و کلید منبع ارائه شده Drive ایجاد می کند و آن را برمی گرداند. کلید منبع یک پارامتر اضافی است که باید برای دسترسی به فایل یا پوشه مورد نظر که با استفاده از یک پیوند به اشتراک گذاشته شده است، ارسال شود. 

// 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)

مجوز اعطا شده به یک کاربر خاص را دریافت می کند. این روش از بازگرداندن مجوزهای یک گروه Google یا مجوزهای به ارث رسیده از طریق Google Groups پشتیبانی نمی کند.

پارامترها

نام تایپ کنید توضیحات
email String آدرس ایمیل کاربری که مجوزهایش باید بررسی شود. Google Groups پشتیبانی نمی شود.

بازگشت

Permission - مجوزهایی که به کاربر داده می شود.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

get Access(user)

مجوز اعطا شده به یک کاربر خاص را دریافت می کند. این روش از بازگرداندن مجوزهای یک گروه Google یا مجوزهای به ارث رسیده از طریق Google Groups پشتیبانی نمی کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایش کاربری که مجوزهایش باید بررسی شود.

بازگشت

Permission - مجوزهایی که به کاربر داده می شود.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

get Date Created()

تاریخ ایجاد Folder را دریافت می کند.

بازگشت

Date - تاریخی که Folder ایجاد شد

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

get Description()

توضیحات مربوط به Folder را دریافت می کند.

بازگشت

String - توضیحات مربوط به Folder

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

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()

شناسه Folder را می گیرد.

بازگشت

String - شناسه Folder

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

get Last Updated()

تاریخ آخرین به روز رسانی Folder را دریافت می کند.

بازگشت

Date - تاریخی که Folder آخرین به روز رسانی شد

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

get Name()

نام Folder را دریافت می کند.

بازگشت

String - نام Folder

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

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());

بازگشت

User - صاحب این Folder .

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • 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 واجد شرایط اعمال به‌روزرسانی امنیتی است که برای دسترسی به آن نیاز به کلید منبع دارد یا خیر.

Drive برای دسترسی به برخی فایل‌ها یا پوشه‌هایی که با استفاده از پیوند به اشتراک گذاشته شده‌اند، به یک کلید منبع نیاز دارد. این تغییر بخشی از یک به‌روزرسانی امنیتی است. به‌روزرسانی به‌طور پیش‌فرض برای فایل‌ها و پوشه‌های واجد شرایط روشن است. برای روشن یا خاموش کردن نیاز کلید منبع برای فایل‌های واجد شرایط، set Security Update Enabled استفاده کنید.

درباره به‌روزرسانی امنیتی Google Drive بیشتر بیاموزید.

بازگشت

Boolean - اینکه آیا می توان مورد نیاز کلید منبع را برای Folder اعمال کرد یا خیر.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

get Security Update Enabled()

دریافت می کند که آیا این Folder برای دسترسی به یک کلید منبع نیاز دارد یا خیر. این نیاز به طور پیش‌فرض برای فایل‌ها و پوشه‌های واجد شرایط روشن است. برای روشن یا خاموش کردن نیاز کلید منبع برای فایل‌های واجد شرایط، از setSecurityUpdateEnabled استفاده کنید.

درباره به‌روزرسانی امنیتی Google Drive بیشتر بیاموزید.

بازگشت

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 در Drive را دریافت می کند. توجه داشته باشید که فایل‌های برنامه Google Workspace جزو محدودیت‌های فضای ذخیره‌سازی Drive حساب نمی‌شوند و بنابراین 0 بایت برمی‌گردانند.

بازگشت

Integer - تعداد بایت هایی که برای ذخیره Folder در Drive استفاده می شود

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

get Url()

نشانی اینترنتی را دریافت می کند که می تواند برای باز کردن Folder در برنامه Google مانند Drive یا Docs استفاده شود.

بازگشت

String - نشانی اینترنتی است که می توان برای مشاهده این Folder در یک برنامه Google مانند 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 Shareable By Editors()

تعیین می کند که آیا کاربرانی که مجوزهای ویرایش Folder را دارند مجاز به اشتراک گذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر.

بازگشت

Boolean - true اگر کاربران با مجوز ویرایش اجازه داشته باشند با سایر کاربران به اشتراک بگذارند یا مجوزها را تغییر دهند. false اگر نه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

is Starred()

تعیین می کند که آیا Folder در Drive کاربر ستاره گذاری شده است یا خیر.

بازگشت

Boolean - true اگر Folder در درایو کاربر ستاره‌دار باشد. false اگر نه

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

is Trashed()

تعیین می کند که آیا Folder در سطل زباله درایو کاربر قرار دارد یا خیر.

بازگشت

Boolean - true اگر Folder در سطل زباله درایو کاربر باشد. 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 در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست بینندگان حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای حذف.

بازگشت

Folder - این Folder ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

remove Editor(user)

کاربر داده شده را از لیست ویرایشگرهای Folder حذف می کند. اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، این روش دسترسی به Folder را مسدود نمی‌کند - به عنوان مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Folder در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست بینندگان حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
user User نمایشی از کاربر برای حذف.

بازگشت

Folder - این Folder ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

remove Viewer(emailAddress)

کاربر داده شده را از لیست بینندگان و نظردهندگان Folder حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده یا نظر دهنده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به Folder را مسدود نمی‌کند - به عنوان مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Folder در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربر برای حذف.

بازگشت

Folder - این Folder برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

remove Viewer(user)

کاربر داده شده را از لیست بینندگان و نظردهندگان Folder حذف می کند. اگر کاربر ویرایشگر باشد، نه بیننده، این روش تاثیری ندارد. این روش همچنین اگر کاربران متعلق به دسته‌ای از کاربرانی هستند که دسترسی عمومی دارند، دسترسی به Folder را مسدود نمی‌کند - به عنوان مثال، اگر Folder با کل دامنه کاربر به اشتراک گذاشته شده باشد، یا اگر Folder در یک درایو مشترک است که کاربر می تواند دسترسی داشته باشد.

برای فایل‌های Drive، این کار همچنین کاربر را از لیست ویرایشگرها حذف می‌کند.

پارامترها

نام تایپ کنید توضیحات
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)

مجموعه‌ای از تمام فایل‌هایی را دریافت می‌کند که فرزندان پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند. معیارهای جستجو در مستندات Google Drive SDK به تفصیل آمده است. توجه داشته باشید که سرویس Drive از v2 از Drive API استفاده می کند و برخی از فیلدهای جستجو با v3 متفاوت است. تفاوت های زمینه بین v2 و v3 را مرور کنید.

آرگومان 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 معیارهای جستجو، همانطور که در اسناد Google Drive SDK توضیح داده شده است.

بازگشت

File Iterator - مجموعه ای از تمام فایل هایی که فرزندان پوشه فعلی هستند و با معیارهای جستجو مطابقت دارند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

search Folders(params)

مجموعه‌ای از تمام پوشه‌هایی را دریافت می‌کند که فرزندان پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند. معیارهای جستجو در مستندات Google Drive SDK به تفصیل آمده است. توجه داشته باشید که سرویس Drive از v2 از Drive API استفاده می کند و برخی از فیلدهای جستجو با v3 متفاوت است. تفاوت های زمینه بین v2 و v3 را مرور کنید.

آرگومان 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 معیارهای جستجو، همانطور که در اسناد Google Drive SDK توضیح داده شده است.

بازگشت

Folder Iterator - مجموعه ای از تمام پوشه هایی که فرزندان پوشه فعلی هستند و با معیارهای جستجو مطابقت دارند.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

set Description(description)

توضیحات را برای Folder تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
description String توضیحات جدید برای Folder

بازگشت

Folder - این Folder ، برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

set Name(name)

نام Folder را تنظیم می کند.

پارامترها

نام تایپ کنید توضیحات
name String نام جدید Folder

بازگشت

Folder - این Folder ، برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

set Owner(emailAddress)

مالک Folder را تغییر می دهد. این روش همچنین به مالک قبلی دسترسی ویرایش صریح به Folder را می دهد.

پارامترها

نام تایپ کنید توضیحات
email Address String آدرس ایمیل کاربری که باید مالک جدید شود

بازگشت

Folder - این Folder ، برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

set Owner(user)

مالک Folder را تغییر می دهد. این روش همچنین به مالک قبلی دسترسی ویرایش صریح به Folder را می دهد.

پارامترها

نام تایپ کنید توضیحات
user User نمایش کاربری که باید مالک جدید شود

بازگشت

Folder - این Folder ، برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

set Security Update Enabled(enabled)

تنظیم می کند که آیا Folder برای دسترسی به کلید منبع در هنگام اشتراک گذاری با استفاده از پیوند نیاز دارد یا خیر. فایل ها و پوشه های واجد شرایط به طور پیش فرض فعال هستند.

درباره به‌روزرسانی امنیتی Google Drive بیشتر بیاموزید.

پارامترها

نام تایپ کنید توضیحات
enabled Boolean فعال کردن کلید منبع مورد نیاز برای Folder .

بازگشت

Folder - این Folder ، برای زنجیر کردن.

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

set Shareable By Editors(shareable)

تعیین می کند که آیا کاربرانی که مجوز ویرایش در Folder را دارند، مجاز به اشتراک گذاری با سایر کاربران یا تغییر مجوزها باشند. پیش فرض یک Folder جدید true است.

پارامترها

نام تایپ کنید توضیحات
shareable Boolean true اگر کاربرانی که دارای مجوز ویرایش هستند باید اجازه داشته باشند با سایر کاربران به اشتراک بگذارند یا مجوزها را تغییر دهند. false اگر نه

بازگشت

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 در Drive کاربر ستاره‌دار شود یا خیر. پیش‌فرض برای Folder جدید false است.

پارامترها

نام تایپ کنید توضیحات
starred Boolean true اگر Folder باید در درایو کاربر ستاره دار شود. false اگر نه

بازگشت

Folder - این Folder ، برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

set Trashed(trashed)

تعیین می کند که آیا Folder در سطل زباله درایو کاربر باشد. فقط مالک می‌تواند Folder را حذف کند. پیش‌فرض برای Folder جدید false است.

پارامترها

نام تایپ کنید توضیحات
trashed Boolean true اگر Folder باید به سطل زباله درایو کاربر منتقل شود. false اگر نه

بازگشت

Folder - این Folder ، برای زنجیر کردن

مجوز

اسکریپت هایی که از این روش استفاده می کنند نیاز به مجوز با یک یا چند مورد از حوزه های زیر دارند:

  • https://www.googleapis.com/auth/drive

روش های منسوخ شده