Drive Service

Google Drive

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

إذا كان النص يستخدم مشروع عادي على Google Cloud بدلاً من استخدام مشروع تلقائي على السحابة الإلكترونية، عليك تفعيل 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

أماكن إقامة

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

DriveApp

أماكن إقامة

الموقعالنوعالوصف
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تفعيل أو إيقاف فرض سلوك الأهل الوحيد لجميع المكالمات التي تؤثر في العناصر الرئيسية للعناصر.
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" بالإضافة إلى أي فرد المستخدمين الذين تم منحهم إذن الوصول بشكل صريح.
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

أماكن إقامة

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

User

الطُرق

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