Class DriveApp

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

تسمح للنصوص البرمجية بإنشاء الملفات والمجلدات والعثور عليها وتعديلها في Google Drive.

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

أماكن إقامة

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

الطُرق

الطريقةنوع الإرجاعوصف قصير
continueFileIterator(continuationToken)FileIteratorاستئناف تكرار الملف باستخدام رمز مميز للمتابعة من مُكرر سابق.
continueFolderIterator(continuationToken)FolderIteratorاستئناف تكرار المجلد باستخدام رمز مميّز للمتابعة من مكرّر سابق
createFile(blob)Fileتنشئ ملفًا في جذر مساحة تخزين Drive للمستخدم من Blob لبيانات عشوائية.
createFile(name, content)Fileيُنشئ ملفًا نصيًا في جذر مساحة تخزين Drive للمستخدم.
createFile(name, content, mimeType)Fileيُنشئ ملفًا في جذر مساحة تخزين Drive للمستخدم.
createFolder(name)Folderيُنشئ مجلدًا في جذر مساحة تخزين Drive للمستخدم.
createShortcut(targetId)Fileيتم إنشاء اختصار لمعرّف عنصر Drive الذي تم تقديمه، ثم عرضه.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)Fileيتم إنشاء اختصار لرقم تعريف عنصر Drive ومفتاح المورد المتوفّرين، ويتم عرضه.
enforceSingleParent(value)voidتفعِّل هذه السياسة أو توقف تنفيذها كسلوك أحد الوالدين لكل المكالمات التي تؤثر على العنصر الرئيسي.
getFileById(id)Fileالحصول على الملف بالمعرف المحدد.
getFileByIdAndResourceKey(id, resourceKey)Fileالحصول على الملف باستخدام رقم التعريف ومفتاح المفتاح للمورد
getFiles()FileIteratorالحصول على مجموعة من جميع الملفات في Drive التابع للمستخدم.
getFilesByName(name)FileIteratorالحصول على مجموعة من جميع الملفات في مساحة المستخدم على Drive التي تحمل الاسم المحدد.
getFilesByType(mimeType)FileIteratorالحصول على مجموعة من جميع الملفات في Drive التابع للمستخدم والتي لها نوع MIME المحدد.
getFolderById(id)Folderللحصول على المجلد الذي يحمل رقم التعريف المحدد.
getFolderByIdAndResourceKey(id, resourceKey)Folderللحصول على المجلد الذي يحمل المعرّف ومفتاح المفتاح المتوفّرين.
getFolders()FolderIteratorالحصول على مجموعة من جميع المجلدات في Drive للمستخدم.
getFoldersByName(name)FolderIteratorيحصل على مجموعة من جميع المجلدات في Drive التابع للمستخدم والتي تحمل الاسم نفسه.
getRootFolder()Folderللحصول على المجلد في جذر حساب المستخدم في Drive.
getStorageLimit()Integerيحصل على عدد وحدات البايت التي يُسمح للمستخدم بتخزينها في Drive.
getStorageUsed()Integerيحصل على عدد وحدات البايت التي يخزّنها المستخدم حاليًا في Drive.
getTrashedFiles()FileIteratorالحصول على مجموعة من جميع الملفات في مهملات المستخدم على Drive.
getTrashedFolders()FolderIteratorالحصول على مجموعة من جميع المجلدات في مهملات المستخدم على Drive.
searchFiles(params)FileIteratorيحصل على مجموعة من جميع الملفات في Drive التابع للمستخدم والتي تطابق معايير البحث المحددة.
searchFolders(params)FolderIteratorيحصل على مجموعة من جميع المجلدات في Drive التابع للمستخدم والتي تطابق معايير البحث المحددة.

المستندات التفصيلية

continueFileIterator(continuationToken)

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

المعلّمات

الاسمالنوعالوصف
continuationTokenStringرمز مميز للمتابعة من أداة تكرار ملف سابقة

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

FileIterator - مجموعة من الملفات التي بقيت في مكرّر سابق عند إنشاء الرمز المميّز للمتابعة


continueFolderIterator(continuationToken)

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

المعلّمات

الاسمالنوعالوصف
continuationTokenStringرمز مميز للمتابعة من مكرر مجلد سابق

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

FolderIterator - مجموعة من المجلدات التي بقيت في مكرِّر سابق عند إنشاء الرمز المميّز للمتابعة


createFile(blob)

تنشئ ملفًا في جذر مساحة تخزين Drive للمستخدم من 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.createFile(blob);

المعلّمات

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

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

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

التفويض

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

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

createFile(name, content)

يُنشئ ملفًا نصيًا في جذر مساحة تخزين Drive للمستخدم. يتم طرح استثناء في حال كان حجم content أكبر من 50 ميغابايت.

// Create a text file with the content "Hello, world!"
DriveApp.createFile('New Text File', 'Hello, world!');

المعلّمات

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

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

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

التفويض

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

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

createFile(name, content, mimeType)

يُنشئ ملفًا في جذر مساحة تخزين Drive للمستخدم. ويتم طرح استثناء في حال كان حجم content أكبر من 10 ميغابايت.

// Create an HTML file with the content "Hello, world!"
DriveApp.createFile('New HTML File', '<b>Hello, world!</b>', MimeType.HTML);

المعلّمات

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

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

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

التفويض

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

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

createFolder(name)

يُنشئ مجلدًا في جذر مساحة تخزين Drive للمستخدم.

المعلّمات

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

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

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

التفويض

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

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

createShortcut(targetId)

يتم إنشاء اختصار لمعرّف عنصر Drive الذي تم تقديمه، ثم عرضه.

المعلّمات

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

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

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

التفويض

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

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

createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)

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

المعلّمات

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

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

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

التفويض

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

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

enforceSingleParent(value)

تفعِّل هذه السياسة أو توقف تنفيذها كسلوك أحد الوالدين لكل المكالمات التي تؤثر على العنصر الرئيسي.

اطلع على مدونة تبسيط بنية مجلد Google Drive ونماذج المشاركة للحصول على المزيد من التفاصيل.

المعلّمات

الاسمالنوعالوصف
valueBooleanالحالة الجديدة لعلامةEnforceOne

التفويض

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

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

getFileById(id)

الحصول على الملف بالمعرف المحدد. عرض استثناء للنص البرمجي إذا لم يكن الملف متوفّرًا أو إذا لم يكن لدى المستخدم إذن بالوصول إليه.

المعلّمات

الاسمالنوعالوصف
idStringرقم تعريف الملف

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

File - الملف الذي يحمل المعرّف المحدّد

التفويض

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

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

getFileByIdAndResourceKey(id, resourceKey)

الحصول على الملف باستخدام رقم التعريف ومفتاح المفتاح للمورد مفاتيح الموارد هي معلَمة إضافية يجب تمريرها للوصول إلى الملفات التي تمت مشاركتها باستخدام رابط.

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

المعلّمات

الاسمالنوعالوصف
idStringرقم تعريف الملف.
resourceKeyStringمفتاح المورد للمجلد.

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

File — الملف الذي يحمل المعرّف المحدّد.

التفويض

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

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

getFiles()

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

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

FileIterator — مجموعة من كل الملفات في Drive الخاص بالمستخدم.

التفويض

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

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

getFilesByName(name)

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

المعلّمات

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

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

FileIterator — مجموعة من كل الملفات في مساحة التخزين السحابي للمستخدم.

التفويض

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

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

getFilesByType(mimeType)

الحصول على مجموعة من جميع الملفات في Drive التابع للمستخدم والتي لها نوع MIME المحدد.

المعلّمات

الاسمالنوعالوصف
mimeTypeStringنوع MIME للملفات التي يمكن العثور عليها.

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

FileIterator - مجموعة من كل الملفات في مساحة التخزين السحابي للمستخدم

التفويض

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

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

getFolderById(id)

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

المعلّمات

الاسمالنوعالوصف
idStringرقم تعريف المجلد

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

Folder - المجلد الذي يحمل المعرّف المحدّد

التفويض

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

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

getFolderByIdAndResourceKey(id, resourceKey)

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

يتم عرض استثناء للنص البرمجي، إذا لم يكن المجلد متوفّرًا أو لم يكن لدى المستخدم إذن بالوصول إليه.

المعلّمات

الاسمالنوعالوصف
idStringرقم تعريف المجلد.
resourceKeyStringمفتاح المورد للمجلد.

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

Folder — المجلد الذي يحمل المعرّف المحدّد.

التفويض

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

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

getFolders()

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

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

FolderIterator — مجموعة من المجلدات في حساب المستخدم على Drive.

التفويض

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

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

getFoldersByName(name)

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

المعلّمات

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

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

FolderIterator - مجموعة من كل المجلدات في Drive للمستخدم الذي يحمل الاسم نفسه.

التفويض

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

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

getRootFolder()

للحصول على المجلد في جذر حساب المستخدم في Drive.

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

Folder — المجلد الجذر للمستخدم على Drive

التفويض

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

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

getStorageLimit()

يحصل على عدد وحدات البايت التي يُسمح للمستخدم بتخزينها في Drive.

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

Integer — عدد وحدات البايت التي يُسمح للمستخدم بتخزينها في Drive

التفويض

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

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

getStorageUsed()

يحصل على عدد وحدات البايت التي يخزّنها المستخدم حاليًا في Drive.

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

Integer — عدد وحدات البايت التي يخزِّنها المستخدم حاليًا في Drive

التفويض

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

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

getTrashedFiles()

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

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

FileIterator: مجموعة من الملفات في"المهملات"

التفويض

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

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

getTrashedFolders()

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

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

FolderIterator - مجموعة من المجلدات في المهملات

التفويض

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

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

searchFiles(params)

يحصل على مجموعة من جميع الملفات في Drive التابع للمستخدم والتي تطابق معايير البحث المحددة. يتم شرح معايير البحث بالتفصيل في مستندات Google Drive SDK. يُرجى العِلم أنّ وسيطة params هي سلسلة طلب بحث قد تحتوي على قيم سلسلة، لذا يجب الحرص على تجنّب علامات الاقتباس ذات الصلة بشكل صحيح (على سبيل المثال "title contains 'Gulliver\\'s Travels'" أو 'title contains "Gulliver\'s Travels"').

// Log the name of every file in the user's Drive that modified after February 28,
// 2013 whose name contains "untitled".
var files = DriveApp.searchFiles(
    'modifiedDate > "2013-02-28" and title contains "untitled"');
while (files.hasNext()) {
  var file = files.next();
  Logger.log(file.getName());
}

المعلّمات

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

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

FileIterator - مجموعة من كل الملفات في مساحة التخزين السحابي الخاصة بالمستخدم والمرتبطة بمعايير البحث.

التفويض

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

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

searchFolders(params)

يحصل على مجموعة من جميع المجلدات في Drive التابع للمستخدم والتي تطابق معايير البحث المحددة. يتم شرح معايير البحث بالتفصيل في مستندات Google Drive SDK. يُرجى العِلم أنّ وسيطة params هي سلسلة طلب بحث قد تحتوي على قيم سلسلة، لذا يجب الحرص على تجنّب علامات الاقتباس ذات الصلة بشكل صحيح (على سبيل المثال "title contains 'Gulliver\\'s Travels'" أو 'title contains "Gulliver\'s Travels"').

// Log the name of every folder in the user's Drive that you own and is starred.
var folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  var folder = folders.next();
  Logger.log(folder.getName());
}

المعلّمات

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

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

FolderIterator — مجموعة من كل المجلدات في Drive للمستخدم والتي تطابق معايير البحث.

التفويض

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

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

الطرق التي تم إيقافها نهائيًا