Class Folder

پوشه

پوشه ای در گوگل درایو از DriveApp می توان به پوشه ها دسترسی پیدا کرد یا ایجاد کرد. 

// Log the name of every folder in the user's Drive.
var folders = DriveApp.getFolders();
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

روش ها

روش نوع برگشت شرح مختصر
addEditor(emailAddress) Folder کاربر داده شده را به لیست ویرایشگرهای Folder اضافه می کند.
addEditor(user) Folder کاربر داده شده را به لیست ویرایشگرهای Folder اضافه می کند.
addEditors(emailAddresses) Folder آرایه داده شده از کاربران را به لیست ویرایشگرهای Folder اضافه می کند.
addViewer(emailAddress) Folder کاربر داده شده را به لیست بینندگان Folder اضافه می کند.
addViewer(user) Folder کاربر داده شده را به لیست بینندگان Folder اضافه می کند.
addViewers(emailAddresses) Folder آرایه داده شده از کاربران را به لیست بینندگان Folder اضافه می کند.
createFile(blob) File یک فایل در پوشه فعلی از یک Blob داده دلخواه ایجاد می کند.
createFile(name, content) File یک فایل متنی در پوشه فعلی با نام و محتوای داده شده ایجاد می کند.
createFile(name, content, mimeType) File فایلی با نام، محتویات و نوع MIME در پوشه فعلی ایجاد می کند.
createFolder(name) Folder یک پوشه در پوشه فعلی با نام داده شده ایجاد می کند.
createShortcut(targetId) File یک میانبر برای شناسه مورد ارائه شده Drive ایجاد می کند و آن را برمی گرداند.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey) File یک میانبر برای شناسه مورد و کلید منبع ارائه شده Drive ایجاد می کند و آن را برمی گرداند.
getAccess(email) Permission مجوز اعطا شده به کاربر را دریافت می کند.
getAccess(user) Permission مجوز اعطا شده به کاربر را دریافت می کند.
getDateCreated() Date تاریخ ایجاد Folder دریافت می کند.
getDescription() String توضیحات مربوط به Folder را دریافت می کند.
getEditors() User[] لیست ویرایشگرهای این Folder را دریافت می کند.
getFiles() FileIterator مجموعه ای از تمام فایل هایی را که فرزندان پوشه فعلی هستند دریافت می کند.
getFilesByName(name) FileIterator مجموعه ای از تمام فایل هایی را که فرزندان پوشه فعلی هستند و نام مشخص شده دارند را دریافت می کند.
getFilesByType(mimeType) FileIterator مجموعه ای از تمام فایل هایی را که فرزندان پوشه فعلی هستند و دارای نوع MIME هستند دریافت می کند.
getFolders() FolderIterator مجموعه ای از تمام پوشه هایی را که فرزندان پوشه فعلی هستند دریافت می کند.
getFoldersByName(name) FolderIterator مجموعه ای از تمام پوشه هایی را که فرزندان پوشه فعلی هستند و نام مشخص شده دارند را دریافت می کند.
getId() String شناسه Folder را می گیرد.
getLastUpdated() Date تاریخ آخرین به روز رسانی Folder دریافت می کند.
getName() String نام Folder را دریافت می کند.
getOwner() User صاحب این Folder می گیرد.
getParents() FolderIterator مجموعه ای از پوشه ها را دریافت می کند که والدین فوری Folder هستند.
getResourceKey() String کلید منبع Folder را که برای دسترسی به مواردی که با استفاده از پیوند به اشتراک گذاشته شده اند، مورد نیاز است.
getSecurityUpdateEligible() Boolean دریافت که آیا این Folder واجد شرایط اعمال به‌روزرسانی امنیتی است که برای دسترسی به آن نیاز به کلید منبع دارد یا خیر.
getSecurityUpdateEnabled() Boolean دریافت می کند که آیا این Folder برای دسترسی به یک کلید منبع نیاز دارد یا خیر.
getSharingAccess() Access مشخص می‌کند که کدام دسته از کاربران می‌توانند به Folder دسترسی داشته باشند، علاوه بر هر کاربر فردی که به صراحت به آنها دسترسی داده شده است.
getSharingPermission() Permission این مجوز را به آن دسته از کاربرانی که می توانند به Folder دسترسی داشته باشند، اعطا می کند، علاوه بر هر کاربر فردی که صراحتاً به آنها دسترسی داده شده است.
getSize() Integer تعداد بایت های مورد استفاده برای ذخیره Folder در Drive را دریافت می کند.
getUrl() String نشانی اینترنتی را دریافت می کند که می تواند برای باز کردن Folder در برنامه Google مانند Drive یا Docs استفاده شود.
getViewers() User[] لیست بینندگان و نظر دهندگان را برای این Folder دریافت می کند.
isShareableByEditors() Boolean تعیین می کند که آیا کاربرانی که مجوزهای ویرایش Folder را دارند مجاز به اشتراک گذاری با سایر کاربران یا تغییر مجوزها هستند یا خیر.
isStarred() Boolean تعیین می کند که آیا Folder در Drive کاربر ستاره گذاری شده است یا خیر.
isTrashed() Boolean تعیین می کند که آیا Folder در سطل زباله درایو کاربر قرار دارد یا خیر.
moveTo(destination) Folder این مورد را به پوشه مقصد ارائه شده منتقل می کند.
removeEditor(emailAddress) Folder کاربر داده شده را از لیست ویرایشگرهای Folder حذف می کند.
removeEditor(user) Folder کاربر داده شده را از لیست ویرایشگرهای Folder حذف می کند.
removeViewer(emailAddress) Folder کاربر داده شده را از لیست بینندگان و نظردهندگان Folder حذف می کند.
removeViewer(user) Folder کاربر داده شده را از لیست بینندگان و نظردهندگان Folder حذف می کند.
revokePermissions(emailAddress) Folder دسترسی به Folder که به کاربر داده شده داده شده را لغو می کند.
revokePermissions(user) Folder دسترسی به Folder که به کاربر داده شده داده شده را لغو می کند.
searchFiles(params) FileIterator مجموعه‌ای از تمام فایل‌هایی را دریافت می‌کند که فرزندان پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند.
searchFolders(params) FolderIterator مجموعه‌ای از تمام پوشه‌هایی را دریافت می‌کند که فرزندان پوشه فعلی هستند و با معیارهای جستجوی داده شده مطابقت دارند.
setDescription(description) Folder توضیحات را برای Folder تنظیم می کند.
setName(name) Folder نام Folder را تنظیم می کند.
setOwner(emailAddress) Folder مالک Folder را تغییر می دهد.
setOwner(user) Folder مالک Folder را تغییر می دهد.
setSecurityUpdateEnabled(enabled) Folder تنظیم می کند که آیا Folder برای دسترسی به کلید منبع در هنگام اشتراک گذاری با استفاده از پیوند نیاز دارد یا خیر.
setShareableByEditors(shareable) Folder تعیین می کند که آیا کاربرانی که مجوز ویرایش در Folder را دارند، مجاز به اشتراک گذاری با سایر کاربران یا تغییر مجوزها باشند.
setSharing(accessType, permissionType) Folder تعیین می کند که کدام دسته از کاربران می توانند به Folder دسترسی داشته باشند و چه مجوزهایی به آن کاربران داده می شود، علاوه بر هر کاربر فردی که به طور صریح به آنها دسترسی داده شده است.
setStarred(starred) Folder تعیین می‌کند که Folder در Drive کاربر ستاره‌دار شود یا خیر.
setTrashed(trashed) Folder تعیین می کند که آیا Folder در سطل زباله درایو کاربر باشد.

مستندات دقیق

addEditor(emailAddress)

کاربر داده شده را به لیست ویرایشگرهای Folder اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
emailAddress String آدرس ایمیل کاربر برای افزودن

بازگشت

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

مجوز

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

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

addEditor(user)

کاربر داده شده را به لیست ویرایشگرهای Folder اضافه می کند. اگر کاربر قبلاً در لیست بینندگان بوده است، این روش کاربر را از لیست بینندگان خارج می کند.

پارامترها

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

بازگشت

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

مجوز

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

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

addEditors(emailAddresses)

آرایه داده شده از کاربران را به لیست ویرایشگرهای Folder اضافه می کند. اگر هر یک از کاربران قبلاً در لیست بینندگان بودند، این روش آنها را از لیست بینندگان خارج می کند.

پارامترها

نام تایپ کنید توضیحات
emailAddresses String[] مجموعه ای از آدرس های ایمیل کاربران برای افزودن.

بازگشت

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

مجوز

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

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

addViewer(emailAddress)

کاربر داده شده را به لیست بینندگان Folder اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
emailAddress String آدرس ایمیل کاربر برای افزودن

بازگشت

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

مجوز

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

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

addViewer(user)

کاربر داده شده را به لیست بینندگان Folder اضافه می کند. اگر کاربر قبلاً در لیست ویرایشگرها بوده است، این روش هیچ تاثیری ندارد.

پارامترها

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

بازگشت

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

مجوز

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

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

addViewers(emailAddresses)

آرایه داده شده از کاربران را به لیست بینندگان Folder اضافه می کند. اگر هر یک از کاربران قبلاً در لیست ویرایشگرها بودند، این روش برای آنها تأثیری ندارد.

پارامترها

نام تایپ کنید توضیحات
emailAddresses String[] مجموعه ای از آدرس های ایمیل کاربران برای افزودن.

بازگشت

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

مجوز

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

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

createFile(blob)

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

// Create an image file in Google Drive using the Maps service.
var blob = Maps.newStaticMap().setCenter('76 9th Avenue, New York NY').getBlob();
DriveApp.getRootFolder().createFile(blob);

پارامترها

نام تایپ کنید توضیحات
blob BlobSource داده های فایل جدید

بازگشت

File - فایل جدید.

مجوز

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

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

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

createFile(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 محتوای فایل جدید
mimeType String نوع MIME فایل جدید.

بازگشت

File - فایل جدید.

مجوز

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

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

createFolder(name)

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

پارامترها

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

بازگشت

Folder - پوشه جدید.

مجوز

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

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

createShortcut(targetId)

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

پارامترها

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

بازگشت

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

مجوز

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

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

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

پارامترها

نام تایپ کنید توضیحات
targetId String شناسه فایل یا پوشه مورد نظر.
targetResourceKey String کلید منبع فایل یا پوشه مورد نظر.

بازگشت

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

مجوز

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

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

getAccess(email)

مجوز اعطا شده به کاربر را دریافت می کند.

پارامترها

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

بازگشت

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

مجوز

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

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

getAccess(user)

مجوز اعطا شده به کاربر را دریافت می کند.

پارامترها

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

بازگشت

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

مجوز

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

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

getDateCreated()

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

بازگشت

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

مجوز

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

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

getDescription()

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

بازگشت

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

مجوز

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

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

getEditors()

لیست ویرایشگرهای این 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 (editor of editors) {
  console.log(editor.getName());
}

بازگشت

User[] - لیست ویرایشگرهای این Folder در صورتی که کاربر دسترسی ویرایش داشته باشد یا در غیر این صورت یک آرایه خالی داشته باشد.

مجوز

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

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

getFiles()

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

بازگشت

FileIterator - مجموعه ای از تمام فایل هایی که فرزندان پوشه فعلی هستند.

مجوز

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

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

getFilesByName(name)

مجموعه ای از تمام فایل هایی را که فرزندان پوشه فعلی هستند و نام مشخص شده دارند را دریافت می کند.

پارامترها

نام تایپ کنید توضیحات
name String نام فایل هایی که باید پیدا کنید.

بازگشت

FileIterator - مجموعه ای از تمام فایل هایی که فرزندان پوشه فعلی هستند و نام مشخصی دارند.

مجوز

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

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

getFilesByType(mimeType)

مجموعه ای از تمام فایل هایی را که فرزندان پوشه فعلی هستند و دارای نوع MIME هستند دریافت می کند.

پارامترها

نام تایپ کنید توضیحات
mimeType String نوع MIME فایل هایی که باید پیدا کنید.

بازگشت

FileIterator - مجموعه ای از تمام فایل هایی که فرزندان پوشه فعلی هستند و دارای نوع MIME هستند.

مجوز

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

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

getFolders()

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

بازگشت

FolderIterator - مجموعه ای از تمام پوشه هایی که فرزندان پوشه فعلی هستند.

مجوز

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

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

getFoldersByName(name)

مجموعه ای از تمام پوشه هایی را که فرزندان پوشه فعلی هستند و نام مشخص شده دارند را دریافت می کند.

پارامترها

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

بازگشت

FolderIterator - مجموعه ای از تمام پوشه هایی که فرزندان پوشه فعلی هستند و نام داده شده را دارند.

مجوز

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

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

getId()

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

بازگشت

String - شناسه Folder

مجوز

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

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

getLastUpdated()

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

بازگشت

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

مجوز

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

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

getName()

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

بازگشت

String - نام Folder

مجوز

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

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

getOwner()

صاحب این 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

getParents()

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

بازگشت

FolderIterator - مجموعه ای از پوشه ها که والدین فوری Folder هستند

مجوز

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

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

getResourceKey()

کلید منبع Folder را که برای دسترسی به مواردی که با استفاده از پیوند به اشتراک گذاشته شده اند، مورد نیاز است.

بازگشت

String - کلید منبع Folder .

مجوز

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

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

getSecurityUpdateEligible()

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

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

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

بازگشت

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

مجوز

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

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

getSecurityUpdateEnabled()

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

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

بازگشت

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

مجوز

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

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

getSharingAccess()

مشخص می‌کند که کدام دسته از کاربران می‌توانند به Folder دسترسی داشته باشند، علاوه بر هر کاربر فردی که به صراحت به آنها دسترسی داده شده است.

بازگشت

Access - کدام دسته از کاربران می توانند به Folder دسترسی داشته باشند

مجوز

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

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

getSharingPermission()

این مجوز را به آن دسته از کاربرانی که می توانند به Folder دسترسی داشته باشند، اعطا می کند، علاوه بر هر کاربر فردی که صراحتاً به آنها دسترسی داده شده است.

بازگشت

Permission - مجوزهایی که به کاربرانی که می توانند به Folder دسترسی داشته باشند داده می شود

مجوز

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

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

getSize()

تعداد بایت های مورد استفاده برای ذخیره Folder در Drive را دریافت می کند. توجه داشته باشید که فایل‌های برنامه Google Workspace جزو محدودیت‌های فضای ذخیره‌سازی Drive حساب نمی‌شوند و بنابراین 0 بایت برمی‌گردانند.

بازگشت

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

مجوز

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

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

getUrl()

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

بازگشت

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

مجوز

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

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

getViewers()

لیست بینندگان و نظر دهندگان را برای این 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 (viewer of viewers) {
  console.log(viewer.getName());
}

بازگشت

User[] - لیستی از بینندگان و نظر دهندگان برای این Folder در صورتی که کاربر دسترسی ویرایش داشته باشد یا در غیر این صورت یک آرایه خالی داشته باشد.

مجوز

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

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

isShareableByEditors()

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

بازگشت

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

مجوز

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

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

isStarred()

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

بازگشت

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

مجوز

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

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

isTrashed()

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

بازگشت

Boolean - true اگر Folder در سطل زباله درایو کاربر باشد. false اگر نه

مجوز

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

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

moveTo(destination)

این مورد را به پوشه مقصد ارائه شده منتقل می کند.

کاربر فعلی باید مالک فایل باشد یا حداقل به پوشه والد فعلی مورد دسترسی ویرایش داشته باشد تا بتواند مورد را به پوشه مقصد منتقل کند.

پارامترها

نام تایپ کنید توضیحات
destination Folder پوشه ای که به والد جدید تبدیل می شود.

بازگشت

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

مجوز

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

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

removeEditor(emailAddress)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

removeEditor(user)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

removeViewer(emailAddress)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

removeViewer(user)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

revokePermissions(emailAddress)

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

پارامترها

نام تایپ کنید توضیحات
emailAddress String آدرس ایمیل کاربری که دسترسی او باید لغو شود.

بازگشت

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

مجوز

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

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

revokePermissions(user)

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

پارامترها

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

بازگشت

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

مجوز

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

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

searchFiles(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.""
var files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

پارامترها

نام تایپ کنید توضیحات
params String معیارهای جستجو، همانطور که در اسناد Google Drive SDK توضیح داده شده است.

بازگشت

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

مجوز

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

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

searchFolders(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.
var folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  console.log(folder.getName());
}

پارامترها

نام تایپ کنید توضیحات
params String معیارهای جستجو، همانطور که در اسناد Google Drive SDK توضیح داده شده است.

بازگشت

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

مجوز

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

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

setDescription(description)

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

پارامترها

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

بازگشت

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

مجوز

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

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

setName(name)

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

پارامترها

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

بازگشت

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

مجوز

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

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

setOwner(emailAddress)

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

پارامترها

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

بازگشت

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

مجوز

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

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

setOwner(user)

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

پارامترها

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

بازگشت

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

مجوز

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

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

setSecurityUpdateEnabled(enabled)

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

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

پارامترها

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

بازگشت

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

مجوز

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

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

setShareableByEditors(shareable)

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

پارامترها

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

بازگشت

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

مجوز

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

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

setSharing(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.)
var folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

پارامترها

نام تایپ کنید توضیحات
accessType Access کدام دسته از کاربران باید بتوانند به Folder دسترسی داشته باشند
permissionType Permission مجوزهایی که باید به کاربرانی که می توانند به Folder دسترسی داشته باشند داده شود

بازگشت

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

مجوز

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

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

setStarred(starred)

تعیین می‌کند که Folder در Drive کاربر ستاره‌دار شود یا خیر. پیش‌فرض برای Folder جدید false است.

پارامترها

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

بازگشت

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

مجوز

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

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

setTrashed(trashed)

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

پارامترها

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

بازگشت

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

مجوز

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

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

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