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. إذا كان المستخدم مدرجًا في قائمة المشاهدين، تؤدي هذه الطريقة إلى إزالة المستخدم من قائمة المشاهدين.

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

addEditor(user)

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

addEditors(emailAddresses)

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

addViewer(emailAddress)

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

addViewer(user)

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

addViewers(emailAddresses)

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

المَعلمات

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

المَعلمات

الاسمTypeالوصف
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!');

المَعلمات

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

المَعلمات

الاسمTypeالوصف
nameStringاسم الملف الجديد
contentStringمحتوى الملف الجديد.
mimeTypeStringتمثّل هذه السمة نوع MIME للملف الجديد.

استرجاع الكرة

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

التفويض

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

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

createFolder(name)

لإنشاء مجلد في المجلد الحالي بالاسم الذي أدخلته.

المَعلمات

الاسمTypeالوصف
nameStringاسم المجلد الجديد

استرجاع الكرة

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

التفويض

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

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

createShortcut(targetId)

إنشاء اختصار لمعرّف عنصر Drive المقدَّم، وإرجاعه

المَعلمات

الاسمTypeالوصف
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());
}

المَعلمات

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

استرجاع الكرة

File: الاختصار الجديد

التفويض

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

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

getAccess(email)

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

المَعلمات

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

استرجاع الكرة

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

التفويض

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

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

getAccess(user)

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

المَعلمات

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

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

المَعلمات

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

استرجاع الكرة

FileIterator: مجموعة من كل الملفات الثانوية للمجلد الحالي والتي تحمل الاسم الأول

التفويض

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

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

getFilesByType(mimeType)

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

المَعلمات

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

للحصول على مجموعة من كل المجلدات الثانوية للمجلد الحالي والتي تحمل الاسم المعني.

المَعلمات

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

استرجاع الكرة

من Boolean إلى true إذا كانت Folder في مهملات Drive للمستخدم، وfalse إذا لم تكن كذلك

التفويض

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

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

moveTo(destination)

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

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

removeEditor(emailAddress)

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

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

removeEditor(user)

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

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

removeViewer(emailAddress)

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

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

removeViewer(user)

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

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

revokePermissions(emailAddress)

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

المَعلمات

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

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

revokePermissions(user)

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

المَعلمات

الاسمTypeالوصف
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());
}

المَعلمات

الاسمTypeالوصف
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());
}

المَعلمات

الاسمTypeالوصف
paramsStringمعايير البحث، كما هو موضَّح بالتفصيل في مستندات حزمة تطوير البرامج (SDK) في Google Drive.

استرجاع الكرة

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

التفويض

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

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

setDescription(description)

لضبط وصف Folder.

المَعلمات

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

استرجاع الكرة

Folder — جهاز Folder هذا للسلاسل

التفويض

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

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

setName(name)

لضبط اسم Folder.

المَعلمات

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

استرجاع الكرة

Folder — جهاز Folder هذا للسلاسل

التفويض

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

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

setOwner(emailAddress)

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

المَعلمات

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

استرجاع الكرة

Folder — جهاز Folder هذا للسلاسل

التفويض

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

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

setOwner(user)

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

المَعلمات

الاسمTypeالوصف
userUserتمثيل للمستخدم الذي يجب أن يصبح المالك الجديد

استرجاع الكرة

Folder — جهاز Folder هذا للسلاسل

التفويض

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

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

setSecurityUpdateEnabled(enabled)

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

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

المَعلمات

الاسمTypeالوصف
enabledBooleanيمكنك اختيار ما إذا كان سيتم تفعيل متطلبات مفتاح المورد لـ Folder.

استرجاع الكرة

Folder - جهاز Folder هذا للسلاسل

التفويض

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

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

setShareableByEditors(shareable)

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

المَعلمات

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

المَعلمات

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

استرجاع الكرة

Folder — جهاز Folder هذا للسلاسل

التفويض

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

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

setStarred(starred)

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

المَعلمات

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

استرجاع الكرة

Folder — جهاز Folder هذا للسلاسل

التفويض

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

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

setTrashed(trashed)

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

المَعلمات

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

استرجاع الكرة

Folder — جهاز Folder هذا للسلاسل

التفويض

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

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

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