Class DriveApp

DriveApp

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

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

أماكن إقامة

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

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
continueFileIterator(continuationToken)FileIteratorتستأنف تكرار ملف باستخدام رمز مواصلة من أداة تكرار سابقة.
continueFolderIterator(continuationToken)FolderIteratorتستأنف تكرار مجلد باستخدام رمز مميّز للمتابعة من أداة تكرار سابقة.
createFile(blob)Fileلإنشاء ملف في جذر مساحة التخزين على Drive الخاصة بالمستخدم من Blob معيّن من البيانات العشوائية
createFile(name, content)Fileلإنشاء ملف نصي في جذر مساحة التخزين على Drive الخاصة بالمستخدم بالاسم والمحتوى المحدَّدَين
createFile(name, content, mimeType)Fileلإنشاء ملف في جذر مساحة التخزين السحابي Drive الخاصة بالمستخدم بالاسم والمحتوى ونوع MIME المحدَّدَين
createFolder(name)Folderلإنشاء مجلد في جذر مساحة التخزين على Drive الخاصة بالمستخدم بالاسم المحدّد
createShortcut(targetId)Fileتُنشئ هذه الوظيفة اختصارًا لرقم تعريف عنصر Drive المقدَّم، وتُعيده.
createShortcutForTargetIdAndResourceKey(targetId, targetResourceKey)Fileتُنشئ هذه الدالة اختصارًا لمعرّف عنصر Drive ومفتاح المورد المقدَّمين، وتُعيده.
enforceSingleParent(value)voidتفعيل سلوك enforceSingleParent أو إيقافه لجميع طلبات البيانات التي تؤثّر في العناصر الرئيسية
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)

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

// Continues getting a list of all 'Untitled document' files in the user's
// Drive. Creates a file iterator named 'previousIterator'.
const previousIterator = DriveApp.getFilesByName('Untitled document');

// Gets continuation token from the previous file iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous file
// iterator.
const newIterator = DriveApp.continueFileIterator(continuationToken);

// Resumes the file iteration using a continuation token from 'firstIterator'
// and logs the file name.
if (newIterator.hasNext()) {
  const file = newIterator.next();
  console.log(file.getName());
}

المعلمات

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

الإرجاع

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


continueFolderIterator(continuationToken)

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

// Continues getting a list of all folders in user's Drive.
// Creates a folder iterator named 'previousIterator'.
const previousIterator = DriveApp.getFolders();

// Gets continuation token from the previous folder iterator.
const continuationToken = previousIterator.getContinuationToken();

// Creates a new iterator using the continuation token from the previous folder
// iterator.
const newIterator = DriveApp.continueFolderIterator(continuationToken);

// Resumes the folder iteration using a continuation token from the previous
// iterator and logs the folder name.
if (newIterator.hasNext()) {
  const folder = newIterator.next();
  console.log(folder.getName());
}

المعلمات

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

الإرجاع

FolderIterator: مجموعة من المجلدات التي بقيت في أداة تكرار سابقة عند إنشاء رمز المتابعة.


createFile(blob)

لإنشاء ملف في جذر مساحة التخزين على Drive الخاصة بالمستخدم من 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 الخاصة بالمستخدم بالاسم والمحتوى ونوع MIME المحدَّدَين. يُلقي استثناءً إذا كان 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 ومفتاح المورد المقدَّمين، وتُعيده. مفتاح المرجع هو مَعلمة إضافية يجب تمريرها للوصول إلى الملف أو المجلد المستهدفين التي تمت مشاركتهما باستخدام رابط.

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

enforceSingleParent(value)

تفعيل سلوك enforceSingleParent أو إيقافه لجميع طلبات البيانات التي تؤثّر في العناصر الرئيسية

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

// Enables enforceSingleParent behavior for all calls affecting item parents.
DriveApp.enforceSingleParent(true);

المعلمات

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

التفويض

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

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

getFileById(id)

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

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace 'Test' with your file name.
const files = DriveApp.getFilesByName('Test');

if (files.hasNext()) {
  // Gets the ID of each file in the list.
  const fileId = files.next().getId();

  // Gets the file name using its ID and logs it to the console.
  console.log(DriveApp.getFileById(fileId).getName());
}

المعلمات

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

الإرجاع

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

التفويض

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

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

getFileByIdAndResourceKey(id, resourceKey)

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

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

// Gets a list of all files in Drive with the given name.
// TODO(developer): Replace 'Test' with your file name.
const files = DriveApp.getFilesByName('Test');
if (files.hasNext()) {
  // Gets the first file in the list.
  const file = files.next();

  // Gets the ID and resource key.
  const key = file.getResourceKey();
  const id = file.getId();

  // Logs the file name to the console using its ID and resource key.
  console.log(DriveApp.getFileByIdAndResourceKey(id, key).getName());
}

المعلمات

الاسمالنوعالوصف
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: مجموعة من جميع الملفات في مساحة التخزين على Drive الخاصة بالمستخدم والتي تحمل الاسم المحدّد

التفويض

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

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

getFilesByType(mimeType)

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

المعلمات

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

الإرجاع

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

التفويض

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

  • 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 للمستخدم

// Gets the user's My Drive folder and logs its name to the console.
console.log(DriveApp.getRootFolder().getName());

// Logs the Drive owner's name to the console.
console.log(DriveApp.getRootFolder().getOwner().getName());

الإرجاع

Folder: المجلد الجذر في Drive الخاص بالمستخدم

التفويض

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

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

getStorageLimit()

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

// Gets the number of bytes the user can store in Drive and logs it to the
// console.
console.log(DriveApp.getStorageLimit());

الإرجاع

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

التفويض

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

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

getStorageUsed()

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

// Gets the number of bytes the user is currently storing in Drive and logs it
// to the console.
console.log(DriveApp.getStorageUsed());

الإرجاع

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

التفويض

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

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

getTrashedFiles()

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

// Gets a list of all the files in the trash of the user's Drive.
const trashFiles = DriveApp.getTrashedFiles();

// Logs the trash file names to the console.
while (trashFiles.hasNext()) {
  const file = trashFiles.next();
  console.log(file.getName());
}

الإرجاع

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

التفويض

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

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

getTrashedFolders()

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

// Gets a collection of all the folders in the trash of the user's Drive.
const trashFolders = DriveApp.getTrashedFolders();

// Logs the trash folder names to the console.
while (trashFolders.hasNext()) {
  const folder = trashFolders.next();
  console.log(folder.getName());
}

الإرجاع

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

التفويض

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

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

searchFiles(params)

تحصل على مجموعة من جميع الملفات في Drive الخاصة بالمستخدم والتي تتطابق مع معايير البحث المُقدَّمة. يمكنك الاطّلاع على تفاصيل معايير البحث في مستندات 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 in the user's Drive that modified after February 28,
// 2022 whose name contains "untitled.""
const files = DriveApp.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: مجموعة من جميع الملفات في مساحة التخزين السحابي Drive الخاصة بالمستخدم والتي تتطابق مع معايير البحث

التفويض

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

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

searchFolders(params)

تحصل على مجموعة من جميع المجلدات في Drive الخاصة بالمستخدم التي تتطابق مع معايير البحث المُقدَّمة. يمكنك الاطّلاع على تفاصيل معايير البحث في مستندات 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 in the user's Drive that you own and is starred.
const folders = DriveApp.searchFolders('starred = true and "me" in owners');
while (folders.hasNext()) {
  const folder = folders.next();
  console.log(folder.getName());
}

المعلمات

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

الإرجاع

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

التفويض

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

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

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