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 أو "مستندات Google".
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 ومفتاح المورد المتوفّرين ويعرضهما. مفتاح المورد هو معلَمة إضافية يجب تمريرها للوصول إلى الملف أو المجلد المستهدف الذي تمت مشاركته باستخدام رابط.

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

المَعلمات

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

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

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

المَعلمات

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

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

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

رحلة العودة

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

التفويض

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

  • 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 بنجمة في 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)

للحصول على مجموعة من جميع الملفات التي تكون فرعية من المجلد الحالي وتتطابق مع معايير البحث المحدّدة. تتوفر معايير البحث بالتفصيل في مستندات حزمة تطوير البرامج (SDK) لخدمة Google Drive. تجدر الإشارة إلى أن خدمة Drive تستخدم الإصدار 2 من Drive API وأنّ بعض حقول طلبات البحث تختلف عن الإصدار 3. راجِع الاختلافات في الحقول بين الإصدار 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معايير البحث، كما هو موضح في مستندات حزمة تطوير البرامج (SDK) لخدمة Google Drive.

رحلة العودة

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

التفويض

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

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

searchFolders(params)

تحصل على مجموعة من جميع المجلدات التي تكون فرعية من المجلد الحالي وتتطابق مع معايير البحث المحدّدة. تتوفر معايير البحث بالتفصيل في مستندات حزمة تطوير البرامج (SDK) لخدمة Google Drive. تجدر الإشارة إلى أن خدمة Drive تستخدم الإصدار 2 من Drive API وأنّ بعض حقول طلبات البحث تختلف عن الإصدار 3. راجِع الاختلافات في الحقول بين الإصدار 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معايير البحث، كما هو موضح في مستندات حزمة تطوير البرامج (SDK) لخدمة Google Drive.

رحلة العودة

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

طرق متوقّفة نهائيًا