Drive Service

من Drive

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

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

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

يعرض نموذج الرمز التالي كيفية تسجيل أسماء كل ملف في مجلد "ملفاتي" للمستخدم:
// 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تعداد فئات تمثّل فئات المستخدمين الذين يمكنهم الوصول إلى ملف أو مجلد، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول صراحةً.
DriveAppيتيح هذا الخيار للنصوص البرمجية إنشاء ملفات ومجلدات والعثور عليها وتعديلها في Google Drive.
Fileملف في Google Drive.
FileIteratorمُكرِّر يسمح بتكرار النصوص البرمجية فوق مجموعة كبيرة من الملفات التي يُحتمل أن تكون كبيرة.
Folderمجلّد في Google Drive
FolderIteratorيشير هذا المصطلح إلى عنصر يسمح بتكرار النصوص البرمجية فوق مجموعة كبيرة من المجلدات.
Permissionتعداد يمثّل الأذونات الممنوحة للمستخدمين الذين يمكنهم الوصول إلى ملف أو مجلد، إلى جانب أي مستخدمين فرديين تم منحهم إذن الوصول صراحةً.
Userمستخدم مرتبط بملف في Google Drive

Access

أماكن إقامة

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

DriveApp

أماكن إقامة

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

الطُرق

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

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عرض البيانات داخل هذا الكائن ككائنات الثنائية الثنائية (blob) التي تم تحويلها إلى نوع المحتوى المحدَّد
getBlob()Blobاعرض البيانات داخل هذا الكائن ككائنات ثنائية (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، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول صراحةً.
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، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول صراحةً.
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

أماكن إقامة

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

User

الطُرق

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