تسمح هذه الخدمة للنصوص البرمجية بإنشاء الملفات والمجلدات والبحث عنها وتعديلها في Google Drive
إذا كان النص يستخدم مشروع عادي على Google Cloud بدلاً من استخدام مشروع تلقائي على السحابة الإلكترونية، عليك تفعيل 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
أماكن إقامة
الموقع | النوع | الوصف |
---|---|---|
ANYONE | Enum | تتوفر إمكانية البحث والدخول لأي شخص على الإنترنت. |
ANYONE_WITH_LINK | Enum | تتوفر إمكانية الوصول لأي شخص لديه الرابط. |
DOMAIN | Enum | يمكن للمستخدمين في نطاقك العثور على العنصر والوصول إليه. |
DOMAIN_WITH_LINK | Enum | تتوفر إمكانية الوصول للأشخاص الذين لديهم الرابط في نطاقك. |
PRIVATE | Enum | تتوفر إمكانية الدخول للأشخاص الذين تم منحهم إذنًا صريحًا بذلك. |
DriveApp
أماكن إقامة
الموقع | النوع | الوصف |
---|---|---|
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 | تفعيل أو إيقاف فرض سلوك الأهل الوحيد لجميع المكالمات التي تؤثر في العناصر الرئيسية للعناصر. |
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
أماكن إقامة
الموقع | النوع | الوصف |
---|---|---|
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 لصورة المستخدم |