Class Folder

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
مجلد

مجلد في Google Drive. يمكن الوصول إلى المجلدات أو إنشاؤها من 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يحصل على عنوان URL الذي يمكن استخدامه لفتح Folder في أحد تطبيقات Google مثل Drive أو المستندات.
getViewers()User[]لعرض قائمة المشاهدين والمعلقين على Folder.
isShareableByEditors()Booleanيحدِّد هذا الإعداد ما إذا كان يُسمَح للمستخدمين الذين لديهم أذونات تعديل في Folder بالمشاركة مع مستخدمين آخرين أو تغيير الأذونات.
isStarred()Booleanلتحديد ما إذا كان قد تم تمييز Folder بنجمة في Drive للمستخدم أم لا.
isTrashed()Booleanلتحديد ما إذا كان Folder في مهملات Drive للمستخدم.
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 في مهملات Drive للمستخدم أم لا.

الوثائق التفصيلية

addEditor(emailAddress)

إضافة المستخدم المحدد إلى قائمة محرِّري Folder. إذا كان المستخدم مدرجًا بالفعل في قائمة المشاهدين، فإن هذه الطريقة تروّج للمستخدم خارج قائمة المشاهدين.

المعلَمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم المراد إضافته.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

addEditor(user)

إضافة المستخدم المحدد إلى قائمة محرِّري Folder. إذا كان المستخدم مدرجًا بالفعل في قائمة المشاهدين، فإن هذه الطريقة تروّج للمستخدم خارج قائمة المشاهدين.

المعلَمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم لإضافته.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

addEditors(emailAddresses)

لإضافة الصفيف المحدد من المستخدمين إلى قائمة المحررين لـ Folder. وإذا كان أي من المستخدمين مدرجًا في قائمة المشاهدين، ستنقلهم هذه الطريقة من قائمة المشاهدين.

المعلَمات

الاسمالنوعالوصف
emailAddressesString[]مصفوفة من عناوين البريد الإلكتروني للمستخدمين المطلوب إضافتهم.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

addViewer(emailAddress)

لإضافة المستخدم المحدد إلى قائمة مشاهدي Folder. إذا كان المستخدم مدرجًا من قبل في قائمة المحررين، فلن يكون لهذه الطريقة أي تأثير.

المعلَمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم المراد إضافته.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

addViewer(user)

لإضافة المستخدم المحدد إلى قائمة مشاهدي Folder. إذا كان المستخدم مدرجًا من قبل في قائمة المحررين، فلن يكون لهذه الطريقة أي تأثير.

المعلَمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم لإضافته.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

addViewers(emailAddresses)

لإضافة الصفيف المحدد من المستخدمين إلى قائمة مشاهدي Folder. إذا كان أي من المستخدمين مدرجًا من قبل في قائمة المحررين، فلن يكون لهذه الطريقة أي تأثير عليهم.

المعلَمات

الاسمالنوعالوصف
emailAddressesString[]مصفوفة من عناوين البريد الإلكتروني للمستخدمين المطلوب إضافتهم.

تذكرة ذهاب وعودة

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

المعلَمات

الاسمالنوعالوصف
blobBlobSourceبيانات الملف الجديد.

تذكرة ذهاب وعودة

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!');

المعلَمات

الاسمالنوعالوصف
nameStringاسم الملف الجديد.
contentStringمحتوى الملف الجديد.

تذكرة ذهاب وعودة

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

المعلَمات

الاسمالنوعالوصف
nameStringاسم الملف الجديد.
contentStringمحتوى الملف الجديد.
mimeTypeStringنوع MIME للملف الجديد.

تذكرة ذهاب وعودة

File — الملف الجديد.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

createFolder(name)

لإنشاء مجلد في المجلد الحالي بالاسم المحدد.

المعلَمات

الاسمالنوعالوصف
nameStringاسم المجلد الجديد.

تذكرة ذهاب وعودة

Folder — المجلد الجديد.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

createShortcut(targetId)

ينشئ اختصارًا لمعرّف عنصر Drive المُقدَّم ويعرضه.

المعلَمات

الاسمالنوعالوصف
targetIdStringمعرّف الملف أو المجلد الهدف.

تذكرة ذهاب وعودة

File — الاختصار الجديد.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

ينشئ اختصارًا لمعرّف عنصر Drive ومفتاح المورد المتوفّرَين ويعرضه. مفاتيح الموارد هي معلمة إضافية يجب تمريرها للوصول إلى الملف أو المجلد المستهدف الذي تمت مشاركته باستخدام رابط.

المعلَمات

الاسمالنوعالوصف
targetIdStringرقم تعريف الملف أو المجلد الهدف.
targetResourceKeyStringمفتاح المورد للملف أو المجلد الهدف.

تذكرة ذهاب وعودة

File — الاختصار الجديد.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

getAccess(email)

يحصل على الإذن الممنوح للمستخدم المُحدّد.

المعلَمات

الاسمالنوعالوصف
emailStringعنوان البريد الإلكتروني للمستخدم الذي يجب التحقق من أذوناته

تذكرة ذهاب وعودة

Permission — الأذونات الممنوحة للمستخدم

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

getAccess(user)

يحصل على الإذن الممنوح للمستخدم المُحدّد.

المعلَمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم يجب التحقّق من أذوناته

تذكرة ذهاب وعودة

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، ستعرض هذه الطريقة صفيفًا فارغًا.

تذكرة ذهاب وعودة

User[] — مصفوفة من المستخدمين الذين لديهم إذن تعديل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

الحصول على مجموعة من جميع الملفات التي هي عناصر فرعية للمجلد الحالي وتحمل الاسم الأول.

المعلَمات

الاسمالنوعالوصف
nameStringاسم الملفات المطلوب البحث عنها.

تذكرة ذهاب وعودة

FileIterator — مجموعة من جميع الملفات التي هي عناصر فرعية للمجلد الحالي وتحمل الاسم الأول.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

getFilesByType(mimeType)

الحصول على مجموعة من جميع الملفات التي تكون تابعة للمجلد الحالي وحاصلة على نوع MIME المحدد.

المعلَمات

الاسمالنوعالوصف
mimeTypeStringنوع 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)

للحصول على مجموعة من جميع المجلدات الفرعية في المجلد الحالي والتي تحمل الاسم نفسه.

المعلَمات

الاسمالنوعالوصف
nameStringاسم المجلدات التي سيتم العثور عليها.

تذكرة ذهاب وعودة

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.

تذكرة ذهاب وعودة

User — كائن User يمثل المالك

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

يحصل على عنوان URL الذي يمكن استخدامه لفتح Folder في أحد تطبيقات Google مثل Drive أو المستندات.

تذكرة ذهاب وعودة

String: عنوان URL الذي يمكن استخدامه لعرض هذا Folder في أحد تطبيقات Google، مثل Drive أو "مستندات Google"

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

getViewers()

لعرض قائمة المشاهدين والمعلقين على Folder. إذا كان المستخدم الذي نفّذ النص البرمجي ليس لديه الإذن بتعديل محتوى Folder، ستعرض هذه الطريقة صفيفًا فارغًا.

تذكرة ذهاب وعودة

User[] — مصفوفة من المستخدمين الذين لديهم إذن بعرض أو تعليق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • 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 بنجمة في Drive للمستخدم؛ false إذا لم يكن مميزًا

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

isTrashed()

لتحديد ما إذا كان Folder في مهملات Drive للمستخدم.

تذكرة ذهاب وعودة

Booleantrue إذا كانت Folder في مهملات Drive للمستخدم، false إذا لم تكن موجودة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

moveTo(destination)

لنقل هذا العنصر إلى مجلد الوجهة الذي تم تقديمه.

يجب أن يكون المستخدم الحالي هو مالك الملف أو يكون على الأقل لديه حق التعديل في المجلد الرئيسي الحالي للعنصر من أجل نقل العنصر إلى المجلد الوجهة.

المعلَمات

الاسمالنوعالوصف
destinationFolderالمجلد الذي سيصبح المجلد الرئيسي الجديد.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

removeEditor(emailAddress)

إزالة المستخدم المحدد من قائمة المحررين لـ Folder. لا تحظر هذه الطريقة المستخدمين من الوصول إلى Folder إذا كانوا ينتمون إلى فئة من المستخدمين الذين لديهم حق الوصول العام، مثلاً، إذا تمت مشاركة Folder مع نطاق المستخدم بالكامل، أو إذا كانت Folder في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

وبالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المشاهدين.

المعلَمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم المطلوب إزالته.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

removeEditor(user)

إزالة المستخدم المحدد من قائمة المحررين لـ Folder. لا تحظر هذه الطريقة المستخدمين من الوصول إلى Folder إذا كانوا ينتمون إلى فئة من المستخدمين الذين لديهم حق الوصول العام، مثلاً، إذا تمت مشاركة Folder مع نطاق المستخدم بالكامل، أو إذا كانت Folder في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

وبالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المشاهدين.

المعلَمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم لإزالته.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

removeViewer(emailAddress)

يزيل المستخدم المعين من قائمة المشاهدين والمعلقين في Folder. ليس لهذه الطريقة أي تأثير إذا كان المستخدم محررًا، وليس مشاهدًا أو معلقًا. ولا تمنع هذه الطريقة أيضًا المستخدمين من الوصول إلى Folder إذا كانوا ينتمون إلى فئة من المستخدمين الذين لديهم إذن بالوصول العام، مثلاً، إذا تمت مشاركة Folder مع نطاق المستخدم بأكمله، أو إذا كانت Folder في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

وبالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المحررين.

المعلَمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم المطلوب إزالته.

تذكرة ذهاب وعودة

Folder — هذا Folder للتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

removeViewer(user)

يزيل المستخدم المعين من قائمة المشاهدين والمعلقين في Folder. ليس لهذه الطريقة أي تأثير إذا كان المستخدم محررًا، وليس مشاهدًا. ولا تحظر هذه الطريقة أيضًا المستخدمين من الوصول إلى Folder إذا كانوا ينتمون إلى فئة من المستخدمين الذين لديهم إذن بالوصول العام، مثلاً، إذا تمت مشاركة Folder مع نطاق المستخدم بالكامل، أو إذا كانت Folder في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

وبالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المحررين.

المعلَمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم لإزالته.

تذكرة ذهاب وعودة

Folder — هذا Folder للتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

revokePermissions(emailAddress)

يُبطِل حق الوصول إلى Folder الممنوحة للمستخدم المُحدَّد. ولا تمنع هذه الطريقة المستخدمين من الوصول إلى Folder إذا كانوا ينتمون إلى فئة من المستخدمين الذين لديهم إذن بالوصول العام، مثلاً، إذا تمت مشاركة Folder مع نطاق المستخدم بأكمله.

المعلَمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي يجب إبطال إمكانية وصوله.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

revokePermissions(user)

يُبطِل حق الوصول إلى Folder الممنوحة للمستخدم المُحدَّد. ولا تمنع هذه الطريقة المستخدمين من الوصول إلى Folder إذا كانوا ينتمون إلى فئة من المستخدمين الذين لديهم إذن بالوصول العام، مثلاً، إذا تمت مشاركة Folder مع نطاق المستخدم بأكمله.

المعلَمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم الذي يجب إبطال إمكانية وصوله

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

searchFiles(params)

الحصول على مجموعة من جميع الملفات التي تكون عناصر فرعية للمجلد الحالي وتطابق معايير البحث المحددة. يتم شرح معايير البحث بالتفصيل في مستندات Google Drive SDK. لاحظ أن خدمة Drive تستخدم الإصدار 2 من Drive API وتختلف بعض حقول طلبات البحث عن الإصدار v3. راجع الاختلافات بين الحقول بين الإصدارين 2 و3.

الوسيطة 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());
}

المعلَمات

الاسمالنوعالوصف
paramsStringمعايير البحث، كما هو موضح بالتفصيل في وثائق Google Drive SDK.

تذكرة ذهاب وعودة

FileIterator — مجموعة من جميع الملفات التي هي عناصر ثانوية للمجلد الحالي وتطابق معايير البحث.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

searchFolders(params)

للحصول على مجموعة من جميع المجلدات التي تكون عناصر فرعية للمجلد الحالي وتطابق معايير البحث المحددة. يتم شرح معايير البحث بالتفصيل في مستندات Google Drive SDK. لاحظ أن خدمة Drive تستخدم الإصدار 2 من Drive API وتختلف بعض حقول طلبات البحث عن الإصدار v3. راجع الاختلافات بين الحقول بين الإصدارين 2 و3.

الوسيطة 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());
}

المعلَمات

الاسمالنوعالوصف
paramsStringمعايير البحث، كما هو موضح بالتفصيل في وثائق Google Drive SDK.

تذكرة ذهاب وعودة

FolderIterator - مجموعة من جميع المجلدات التي تكون عناصر ثانوية للمجلد الحالي وتطابق معايير البحث.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

setDescription(description)

لتعيين وصف Folder.

المعلَمات

الاسمالنوعالوصف
descriptionStringالوصف الجديد لـ Folder

تذكرة ذهاب وعودة

Folder - هذا Folder، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

setName(name)

لتعيين اسم Folder.

المعلَمات

الاسمالنوعالوصف
nameStringالاسم الجديد لـ Folder

تذكرة ذهاب وعودة

Folder - هذا Folder، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

setOwner(emailAddress)

يغيّر مالك Folder. تمنح هذه الطريقة أيضًا المالك السابق إذنًا صريحًا بتعديل محتوى Folder.

المعلَمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي يجب أن يصبح المالك الجديد

تذكرة ذهاب وعودة

Folder - هذا Folder، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

setOwner(user)

يغيّر مالك Folder. تمنح هذه الطريقة أيضًا المالك السابق إذنًا صريحًا بتعديل محتوى Folder.

المعلَمات

الاسمالنوعالوصف
userUserإقرار للمستخدم الذي يجب أن يصبح المالك الجديد

تذكرة ذهاب وعودة

Folder - هذا Folder، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

setSecurityUpdateEnabled(enabled)

يحدِّد هذا الإعداد ما إذا كان Folder يتطلّب مفتاح وصول للوصول عند مشاركته باستخدام رابط. يتم تمكين الملفات والمجلدات المؤهلة بشكل افتراضي.

مزيد من المعلومات حول تحديث الأمان في Google Drive.

المعلَمات

الاسمالنوعالوصف
enabledBooleanيمكنك تفعيل شرط مفتاح المورد لـ Folder.

تذكرة ذهاب وعودة

Folder — هذا Folder، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

setShareableByEditors(shareable)

يحدّد هذا الإعداد ما إذا كان مسموحًا للمستخدمين الذين لديهم أذونات تعديل في Folder بالمشاركة مع مستخدمين آخرين أو تغيير الأذونات. يكون Folder التلقائي هو true.

المعلَمات

الاسمالنوعالوصف
shareableBooleantrue في حال كان مسموحًا للمستخدمين الذين لديهم أذونات تعديل بالمشاركة مع مستخدمين آخرين أو تغيير الأذونات، 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);

المعلَمات

الاسمالنوعالوصف
accessTypeAccessفئة المستخدمين الذين يجب أن يتمكنوا من الوصول إلى Folder
permissionTypePermissionالأذونات التي يجب منحها للمستخدمين الذين يمكنهم الوصول إلى Folder

تذكرة ذهاب وعودة

Folder - هذا Folder، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

setStarred(starred)

لتعيين ما إذا كان سيتم تمييز Folder بنجمة في Drive للمستخدم أم لا. الإعداد التلقائي للصفحات Folder الجديدة هو false.

المعلَمات

الاسمالنوعالوصف
starredBooleantrue إذا كان يجب تمييز Folder بنجمة في Drive للمستخدم، false إذا لم يكن مميزًا

تذكرة ذهاب وعودة

Folder - هذا Folder، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

setTrashed(trashed)

لتعيين ما إذا كان Folder في مهملات Drive للمستخدم أم لا. يمكن للمالك فقط نقل المهملات إلى Folder. الإعداد التلقائي في Folder الجديدة هو false.

المعلَمات

الاسمالنوعالوصف
trashedBooleantrue إذا كان يجب نقل Folder إلى مهملات Drive للمستخدم، false إذا لم يتم نقلها

تذكرة ذهاب وعودة

Folder - هذا Folder، للسلسلة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

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

الطرق المتوقّفة