Drive Service

Drive

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

إذا كان النص البرمجي يستخدم مشروعًا عاديًا على Cloud بدلاً من مشروع تلقائي على Cloud، عليك تفعيل واجهة برمجة التطبيقات Drive API يدويًا. في مشروعك العادي على Cloud، فعِّل واجهة برمجة التطبيقات Drive API:

تفعيل واجهة برمجة التطبيقات Drive API

يوضّح نموذج الرمز البرمجي التالي كيفية تسجيل أسماء كل ملف في مجلد "ملفاتي" الخاص بالمستخدم:
// Logs the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  console.log(file.getName());
}

صفوف

الاسموصف قصير
Accessفهرس يمثّل فئات المستخدمين الذين يمكنهم الوصول إلى ملف أو مجلد، بالإضافة إلى أي مستخدمين individual تم منحهم إذن الوصول صراحةً
DriveAppالسماح للنصوص البرمجية بإنشاء الملفات والمجلدات والعثور عليها وتعديلها في Google Drive
Fileملف في Google Drive
FileIteratorأداة تكرار تسمح للنصوص البرمجية بالتكرار على مجموعة كبيرة من الملفات.
Folderمجلد في Google Drive
FolderIteratorعنصر يسمح للنصوص البرمجية بالتكرار على مجموعة كبيرة من المجلدات.
Permissionفهرس يمثّل الأذونات الممنوحة للمستخدمين الذين يمكنهم الوصول إلى ملف أو مجلد، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول صراحةً
Userمستخدم مرتبط بملف في Google Drive

Access

أماكن إقامة

الموقعالنوعالوصف
ANYONEEnumتتوفر إمكانية البحث والدخول لأي شخص على الإنترنت.
ANYONE_WITH_LINKEnumيمكن لأي شخص لديه الرابط الوصول إلى هذا التسجيل.
DOMAINEnumيمكن للأشخاص في نطاقك العثور على المستند والوصول إليه.
DOMAIN_WITH_LINKEnumيمكن للأشخاص في نطاقك الذين لديهم الرابط الوصول إليه.
PRIVATEEnumتتوفر إمكانية الدخول للأشخاص الذين تم منحهم إذنًا صريحًا بذلك.

DriveApp

أماكن إقامة

الموقعالنوعالوصف
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 الخاصة بالمستخدم التي تتطابق مع معايير البحث المُقدَّمة.

File

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
addCommenter(emailAddress)Fileأضِف المستخدم المحدّد إلى قائمة المعلِقين في File.
addCommenter(user)Fileأضِف المستخدم المحدّد إلى قائمة المعلِقين في File.
addCommenters(emailAddresses)Fileأضِف الصفيف المحدَّد من المستخدمين إلى قائمة المعلِقين في File.
addEditor(emailAddress)Fileتُضيف هذه السمة المستخدم المحدَّد إلى قائمة المحرِّرين في File.
addEditor(user)Fileتُضيف هذه السمة المستخدم المحدَّد إلى قائمة المحرِّرين في File.
addEditors(emailAddresses)Fileتُضيف الصفيف المحدَّد من المستخدمين إلى قائمة المحرِّرين في File.
addViewer(emailAddress)Fileتُضيف هذه السمة المستخدم المحدّد إلى قائمة المشاهدين في File.
addViewer(user)Fileتُضيف هذه السمة المستخدم المحدّد إلى قائمة المشاهدين في File.
addViewers(emailAddresses)Fileتُضيف الصفيف المحدّد من المستخدِمين إلى قائمة المشاهدين في File.
getAccess(email)Permissionالحصول على الإذن الذي تم منحه لمستخدم معيّن
getAccess(user)Permissionالحصول على الإذن الممنوح لمستخدم معيّن
getAs(contentType)Blobعرض البيانات داخل هذا العنصر كبيانات ثنائية كبيرة تم تحويلها إلى نوع المحتوى المحدّد
getBlob()Blobعرض البيانات داخل هذا الكائن ككتلة بيانات
getDateCreated()Dateتحصل على تاريخ إنشاء File.
getDescription()Stringتحصل على وصف File.
getDownloadUrl()Stringتحصل على عنوان URL الذي يمكن استخدامه لتنزيل الملف.
getEditors()User[]تحصل على قائمة بالمحرِّرين لهذا File.
getId()Stringتحصل على معرّف File.
getLastUpdated()Dateتحصل على تاريخ آخر تعديل على File.
getMimeType()Stringتحصل على نوع MIME للملف.
getName()Stringتحصل على اسم File.
getOwner()Userالحصول على مالك الملف
getParents()FolderIteratorتحصل على مجموعة من المجلدات التي هي مجلدات رئيسية فورية للعنصر File.
getResourceKey()Stringتحصل على مفتاح المورد الخاص بـ File المطلوب للوصول إلى العناصر التي تمّت مشاركتها باستخدام رابط.
getSecurityUpdateEligible()Booleanتحصل على ما إذا كان هذا File مؤهلاً لتطبيق تحديث الأمان الذي يتطلب مفتاح مصدر للوصول عند مشاركته باستخدام رابط.
getSecurityUpdateEnabled()Booleanتحصل على ما إذا كان هذا File يتطلّب مفتاح مورد للوصول إليه عند مشاركته باستخدام رابط.
getSharingAccess()Accessتحصل على فئة المستخدمين الذين يمكنهم الوصول إلى File، بالإضافة إلى أي مستخدمين individual تم منحهم إذن الوصول بشكل صريح.
getSharingPermission()Permissionالحصول على الإذن الممنوح للمستخدمين الذين يمكنهم الوصول إلى File، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول صراحةً
getSize()Integerتحصل على عدد وحدات البايت المستخدَمة لتخزين File في Drive.
getTargetId()Stringإذا كان هذا العنصر اختصارًا، يتم عرض رقم تعريف العنصر الذي يشير إليه.
getTargetMimeType()Stringإذا كان هذا العنصر اختصارًا، يتم عرض نوع MIME للعنصر الذي يشير إليه.
getTargetResourceKey()Stringإذا كان الملف اختصارًا، يتم عرض مفتاح المرجع للعنصر الذي يشير إليه.
getThumbnail()Blobتحصل على صورة مصغّرة للملف، أو null إذا لم تكن هناك صورة مصغّرة.
getUrl()Stringتحصل على عنوان URL الذي يمكن استخدامه لفتح File في أحد تطبيقات Google، مثل Drive أو "مستندات Google".
getViewers()User[]تحصل على قائمة بالمشاهدين والمعلقين لهذا File.
isShareableByEditors()Booleanلتحديد ما إذا كان يُسمح للمستخدمين الذين لديهم أذونات تعديل على File بمشاركتها مع مستخدمين آخرين أو تغيير الأذونات
isStarred()Booleanلتحديد ما إذا تم وضع علامة "تمييز بعلامة النجمة" على File في Drive الخاص بالمستخدم.
isTrashed()Booleanيحدِّد ما إذا كان File في المهملات في Drive الخاص بالمستخدم.
makeCopy()Fileلإنشاء نسخة من الملف
makeCopy(destination)Fileلإنشاء نسخة من الملف في الدليل الوجهة
makeCopy(name)Fileيتم إنشاء نسخة من الملف وتسمية الملف بالاسم المقدَّم.
makeCopy(name, destination)Fileتُنشئ هذه الوظيفة نسخة من الملف في الدليل الوجهة وتُسميها بالاسم المقدَّم.
moveTo(destination)Fileتنقل هذه العملية هذا العنصر إلى المجلد الوجهة المقدَّم.
removeCommenter(emailAddress)Fileتزيل هذه السمة المستخدم المحدّد من قائمة المعلِقين في File.
removeCommenter(user)Fileتزيل هذه السمة المستخدم المحدّد من قائمة المعلِقين في File.
removeEditor(emailAddress)Fileتزيل هذه الدالة المستخدم المحدَّد من قائمة المحرِّرين في File.
removeEditor(user)Fileتزيل هذه الدالة المستخدم المحدَّد من قائمة المحرِّرين في File.
removeViewer(emailAddress)Fileتؤدي هذه العملية إلى إزالة المستخدم المحدّد من قائمة المشاهدين والمعلّقين في File.
removeViewer(user)Fileتؤدي هذه العملية إلى إزالة المستخدم المحدّد من قائمة المشاهدين والمعلّقين في File.
revokePermissions(emailAddress)Fileيؤدي ذلك إلى إبطال إذن الوصول إلى File الذي تم منحه للمستخدم المحدّد.
revokePermissions(user)Fileتؤدي هذه العملية إلى إبطال إذن الوصول إلى File الذي تم منحه للمستخدم المحدّد.
setContent(content)Fileتؤدي هذه العملية إلى استبدال محتوى الملف بمحتوى بديل.
setDescription(description)Fileلضبط وصف File.
setName(name)Fileلضبط اسم File.
setOwner(emailAddress)Fileتغيير مالك File
setOwner(user)Fileتغيير مالك File
setSecurityUpdateEnabled(enabled)Fileلتحديد ما إذا كان File يتطلّب مفتاح مورد للوصول إليه عند مشاركته باستخدام رابط
setShareableByEditors(shareable)Fileلتحديد ما إذا كان يُسمح للمستخدمين الذين لديهم أذونات تعديل على File بمشاركة مع مستخدمين آخرين أو تغيير الأذونات
setSharing(accessType, permissionType)Fileلتحديد فئة المستخدمين الذين يمكنهم الوصول إلى File والأذونات التي يتم منحها لهؤلاء المستخدمين، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول صراحةً.
setStarred(starred)Fileلضبط ما إذا كان File مميّزًا بنجمة في Drive الخاص بالمستخدم.
setTrashed(trashed)Fileلتحديد ما إذا كان File في المهملات في مساحة التخزين السحابي Drive الخاصة بالمستخدم.

FileIterator

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
getContinuationToken()Stringتحصل على رمز مميّز يمكن استخدامه لاستئناف هذه المحاولة في وقت لاحق.
hasNext()Booleanلتحديد ما إذا كانت المكالمة إلى next() ستؤدي إلى عرض عنصر
next()Fileالحصول على العنصر التالي في مجموعة الملفات أو المجلدات

Folder

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
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 الخاصة بالمستخدم.

FolderIterator

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
getContinuationToken()Stringتحصل على رمز مميّز يمكن استخدامه لاستئناف هذه المحاولة في وقت لاحق.
hasNext()Booleanلتحديد ما إذا كانت المكالمة إلى next() ستؤدي إلى عرض عنصر
next()Folderالحصول على العنصر التالي في مجموعة الملفات أو المجلدات

Permission

أماكن إقامة

الموقعالنوعالوصف
VIEWEnumيمكن للمستخدمين الذين يمكنهم الوصول إلى الملف أو المجلد الاطّلاع عليه أو نسخه فقط.
EDITEnumيمكن للمستخدمين الذين يمكنهم الوصول إلى الملف أو المجلد تعديله.
COMMENTEnumيمكن للمستخدمين الذين يمكنهم الوصول إلى الملف أو المجلد عرض الملف أو نسخه أو التعليق عليه فقط.
OWNEREnumيملك المستخدم الملف أو المجلد.
ORGANIZEREnumالمستخدمون الذين يمكنهم تنظيم الملفات والمجلدات في مساحة تخزين سحابي مشتركة
FILE_ORGANIZEREnumالمستخدمون الذين يمكنهم تعديل المحتوى وإرساله إلى المهملات ونقله داخل مساحة تخزين سحابي مشتركة
NONEEnumلا يملك المستخدم أي أذونات للملف أو المجلد.

User

الطُرق

الطريقةنوع القيمة التي يتم عرضهاوصف قصير
getDomain()Stringتحصل على اسم النطاق المرتبط بحساب المستخدم.
getEmail()Stringتحصل على عنوان البريد الإلكتروني للمستخدم.
getName()Stringالحصول على اسم المستخدم
getPhotoUrl()Stringتحصل على عنوان URL لصورة المستخدم.