Drive Service

Google Drive

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

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