Class Folder

المجلد

مجلد في Google Drive يمكن الوصول إلى المجلدات أو إنشاؤها من DriveApp. 

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

الطُرق

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

المعلمات

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

الحصول على الإذن الممنوح لمستخدم معيّن لا تتيح الطريقة عرض أذونات "مجموعة Google" أو الأذونات المُكتسَبة من خلال "مجموعات Google".

المعلمات

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

الإرجاع

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

التفويض

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

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

getAccess(user)

الحصول على الإذن الممنوح لمستخدم معيّن لا تتيح الطريقة عرض أذونات "مجموعة Google" أو الأذونات المُكتسَبة من خلال "مجموعات Google".

المعلمات

الاسمالنوعالوصف
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 (const 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، بالإضافة إلى أي مستخدمين individual تم منحهم إذن الوصول بشكل صريح.

الإرجاع

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. إذا لم يكن لدى المستخدم الذي executes the script إذن وصول للتعديل إلى Folder، ستُعرِض هذه الطريقة صفيفًا فارغًا. 

//  Gets a folder by its ID.
//  TODO(developer): Replace the folder ID with your own.
const folder = DriveApp.getFolderById('1234567890abcdefghijklmnopqrstuvwxyz');

// Gets the list of viewers and logs their names to the console.
const viewers = folder.getViewers();
for (const viewer of viewers) {
  console.log(viewer.getName());
}

الإرجاع

User[]: قائمة المشاهدين والمعلّقين لهذا Folder إذا كان لدى المستخدم إذن تعديل أو صفيف فارغ في حال عدم توفّر هذا الإذن

التفويض

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

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

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 الخاص بالمستخدم.

الإرجاع

Boolean — true إذا كان 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 للمستخدم بالكامل، أو إذا كان Folder في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

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

المعلمات

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

الإرجاع

Folder — هذا الرمز Folder، لإنشاء سلسلة.

التفويض

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

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

removeEditor(user)

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

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

المعلمات

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

الإرجاع

Folder — هذا الرمز Folder، لإنشاء سلسلة.

التفويض

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

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

removeViewer(emailAddress)

تزيل هذه السمة المستخدم المحدّد من قائمة المشاهدين والمعلّقين في Folder. لا تؤثّر هذه الطريقة في حال كان المستخدم محرِّرًا وليس مشاهدًا أو معلِقًا. لا تحظر هذه الطريقة أيضًا المستخدمين من الوصول إلى 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 وتختلف بعض حقول طلبات البحث عن الإصدار 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.""
const files = DriveApp.getRootFolder().searchFiles(
    'modifiedDate > "2022-02-28" and title contains "untitled"');
while (files.hasNext()) {
  const 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 وتختلف بعض حقول طلبات البحث عن الإصدار 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.
const folders = DriveApp.getRootFolder().searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const 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.)
const 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

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