تتيح هذه الخدمة للنصوص البرمجية إنشاء الملفات والمجلدات والبحث عنها وتعديلها في Google Drive.
إذا كان النص البرمجي يستخدم مشروعًا عاديًا على السحابة الإلكترونية بدلاً من مشروع تلقائي على السحابة الإلكترونية، عليك تفعيل Drive API يدويًا. في مشروعك العادي على Google Cloud، فعِّل 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 | الوصف |
---|---|---|
ANYONE | Enum | تتوفر إمكانية البحث والدخول لأي شخص على الإنترنت. |
ANYONE_WITH_LINK | Enum | تتوفر إمكانية الوصول لأي شخص لديه الرابط. |
DOMAIN | Enum | يمكن للمستخدمين في نطاقك العثور على العنصر والوصول إليه. |
DOMAIN_WITH_LINK | Enum | يمكن للأشخاص الذين لديهم الرابط في نطاقك الدخول. |
PRIVATE | Enum | تتوفر إمكانية الدخول للأشخاص الذين تم منحهم إذنًا صريحًا بذلك. |
DriveApp
أماكن إقامة
الموقع | Type | الوصف |
---|---|---|
Access | Access | تعداد يمثل فئات المستخدمين الذين يمكنهم الوصول إلى ملف أو مجلد، إلى جانب أي مستخدمين فرديين تم منحهم حق الوصول بشكلٍ صريح. |
Permission | Permission | تعداد يمثّل الأذونات الممنوحة للمستخدمين الذين يمكنهم الوصول إلى ملف أو مجلد، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول بشكلٍ صريح. |
الطُرق
الطريقة | نوع القيمة التي يتم إرجاعها | وصف قصير |
---|---|---|
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 | الوصف |
---|---|---|
VIEW | Enum | لا يتمكن المستخدمون الذين يمكنهم الوصول إلى الملف أو المجلد إلا من عرضه أو نسخه. |
EDIT | Enum | ويمكن للمستخدمين الذين يمكنهم الوصول إلى الملف أو المجلد تعديله. |
COMMENT | Enum | يمكن للمستخدمين الذين يمكنهم الوصول إلى الملف أو المجلد عرضه أو نسخه أو التعليق عليه فقط. |
OWNER | Enum | يملك المستخدم الملف أو المجلد. |
ORGANIZER | Enum | المستخدمون الذين يمكنهم تنظيم الملفات والمجلدات في مساحة تخزين سحابي مشتركة |
FILE_ORGANIZER | Enum | المستخدمون الذين يمكنهم تعديل المحتوى وإضافته إلى المهملات ونقله في مساحة تخزين سحابي مشتركة |
NONE | Enum | لا يمتلك المستخدم أي أذونات للملف أو المجلد. |
User
الطُرق
الطريقة | نوع القيمة التي يتم إرجاعها | وصف قصير |
---|---|---|
getDomain() | String | الحصول على اسم النطاق المرتبط بحساب المستخدم. |
getEmail() | String | تحصل على عنوان البريد الإلكتروني للمستخدم. |
getName() | String | يحصل على اسم المستخدم. |
getPhotoUrl() | String | يحصل على عنوان URL لصورة المستخدم. |