Drive Service

Google Drive

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

// Log the name of every file in the user's Drive.
var files = DriveApp.getFiles();
while (files.hasNext()) {
  var file = files.next();
  Logger.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يُفعِّل أو يُعطِّل سلوك فرض SingleParent لجميع المكالمات التي تؤثر على عناصر العنصر الرئيسي.
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اعرض البيانات داخل هذا الكائن كائن كائن ثنائي كبير.
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 أو المستندات.
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 أو المستندات.
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المستخدمون الذين يمكنهم تنظيم الملفات والمجلدات في مساحة Drive مشتركة.
FILE_ORGANIZEREnumالمستخدمون الذين يمكنهم تعديل المحتوى وإضافته إلى المهملات ونقله ضمن مساحة Drive مشتركة.
NONEEnumلا يمتلك المستخدم أي أذونات للملف أو المجلد.

User

الطُرق

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