Class File

ملفّ

ملف في Google Drive يمكن الوصول إلى الملفات أو إنشاؤها من خلال DriveApp.

// Trash every untitled spreadsheet that hasn't been updated in a week.
const files = DriveApp.getFilesByName('Untitled spreadsheet');
while (files.hasNext()) {
  const file = files.next();
  if (new Date() - file.getLastUpdated() > 7 * 24 * 60 * 60 * 1000) {
    file.setTrashed(true);
  }
}

الطُرق

الطريقةنوع القيمة التي تم إرجاعهاوصف قصير
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|nullإذا كان هذا العنصر عبارة عن اختصار، تعرض هذه السمة رقم تعريف العنصر الذي يشير إليه.
getTargetMimeType()String|nullإذا كان هذا العنصر عبارة عن اختصار، تعرض هذه السمة نوع MIME الخاص بالعنصر الذي يشير إليه.
getTargetResourceKey()String|nullإذا كان الملف عبارة عن اختصار، يعرض مفتاح مصدر العنصر الذي يشير إليه.
getThumbnail()Blob|nullتعرض هذه السمة صورة مصغّرة للملف، أو 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.

مستندات تفصيلية

addCommenter(emailAddress)

أضِف المستخدم المحدّد إلى قائمة المعلّقين على File. إذا كان المستخدم مدرجًا في قائمة المشاهدين، يعمل هذا الإجراء على إزالة المستخدم من قائمة المشاهدين.

const files = DriveApp.getFilesByName('Test');

// Loops through the files
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter('hello@example.com');
}

المعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي تريد إضافته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

addCommenter(user)

أضِف المستخدم المحدّد إلى قائمة المعلّقين على File. إذا كان المستخدم مدرجًا في قائمة المشاهدين، يعمل هذا الإجراء على إزالة المستخدم من قائمة المشاهدين.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Adds the active user as a commenter.
while (files.hasNext()) {
  const file = files.next();
  file.addCommenter(Session.getActiveUser());
}

المعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم الذي تريد إضافته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

addCommenters(emailAddresses)

أضِف مصفوفة المستخدمين المحدّدة إلى قائمة المعلقين على File. إذا كان أي من المستخدمين مدرَجًا في قائمة المشاهدين، سيؤدي هذا الإجراء إلى إزالته من القائمة.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

while (files.hasNext()) {
  const file = files.next();
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com' and
  // 'baklavainthebalkans@gmail.com' with the email addresses to add as
  // commenters.
  const emails = [
    'cloudysanfrancisco@gmail.com',
    'baklavainthebalkans@gmail.com',
  ];
  console.log(file.addCommenters(emails));
}

المعلمات

الاسمالنوعالوصف
emailAddressesString[]مصفوفة من عناوين البريد الإلكتروني للمستخدمين الذين تريد إضافتهم

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

addEditor(emailAddress)

تضيف هذه الطريقة المستخدم المحدّد إلى قائمة المحرّرين في File. إذا كان المستخدم مدرَجًا في قائمة المشاهدين، سيؤدي هذا الإجراء إلى إزالته من القائمة.

المعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي تريد إضافته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

addEditor(user)

تضيف هذه الطريقة المستخدم المحدّد إلى قائمة المحرّرين في File. إذا كان المستخدم مدرَجًا في قائمة المشاهدين، سيؤدي هذا الإجراء إلى إزالته من القائمة.

المعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم الذي تريد إضافته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

addEditors(emailAddresses)

تضيف هذه الطريقة مصفوفة المستخدمين المحدّدة إلى قائمة المحرّرين في File. إذا كان أي من المستخدمين مدرجًا في قائمة المشاهدين، ستؤدي هذه الطريقة إلى إزالته من القائمة.

المعلمات

الاسمالنوعالوصف
emailAddressesString[]مصفوفة من عناوين البريد الإلكتروني للمستخدمين الذين تريد إضافتهم

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

addViewer(emailAddress)

تضيف هذه الطريقة المستخدم المحدّد إلى قائمة المشاهدين في File. إذا كان المستخدم مُدرجًا في قائمة المحرّرين، لن يكون لهذا الإجراء أي تأثير.

المعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي تريد إضافته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

addViewer(user)

تضيف هذه الطريقة المستخدم المحدّد إلى قائمة المشاهدين في File. إذا كان المستخدم مُدرجًا في قائمة المحرّرين، لن يكون لهذا الإجراء أي تأثير.

المعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم الذي تريد إضافته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

addViewers(emailAddresses)

تضيف هذه الطريقة مصفوفة المستخدمين المحدّدة إلى قائمة المشاهدين في File. إذا كان أي من المستخدمين مدرجًا في قائمة المحرّرين، لن يكون لهذا الإجراء أي تأثير عليهم.

المعلمات

الاسمالنوعالوصف
emailAddressesString[]مصفوفة من عناوين البريد الإلكتروني للمستخدمين الذين تريد إضافتهم

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

getAccess(email)

تعرض هذه الطريقة الإذن الممنوح لمستخدم معيّن. لا تتيح الطريقة عرض الأذونات الخاصة بمجموعة Google أو الأذونات الموروثة من خلال مجموعات Google.

المعلمات

الاسمالنوعالوصف
emailStringعنوان البريد الإلكتروني للمستخدم الذي يجب التحقّق من أذوناته. لا تتوافق هذه المجموعات مع "مجموعات Google".

الإرجاع

Permission: الأذونات الممنوحة للمستخدم

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAccess(user)

تعرض هذه الطريقة الإذن الممنوح لمستخدم معيّن. لا تتيح الطريقة عرض الأذونات الخاصة بمجموعة Google أو الأذونات الموروثة من خلال مجموعات Google.

المعلمات

الاسمالنوعالوصف
userUserتمثّل هذه السمة المستخدم الذي يجب التحقّق من أذوناته.

الإرجاع

Permission: الأذونات الممنوحة للمستخدم

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getAs(contentType)

لعرض البيانات داخل هذا العنصر ككائن ثنائي كبير تم تحويله إلى نوع المحتوى المحدّد تضيف هذه الطريقة الامتداد المناسب إلى اسم الملف، مثل "myfile.pdf". ومع ذلك، يفترض هذا الخيار أنّ الجزء من اسم الملف الذي يلي النقطة الأخيرة (إن وُجدت) هو امتداد حالي يجب استبداله. نتيجةً لذلك، يصبح اسم الملف "ShoppingList.12.25.2014" هو "ShoppingList.12.25.pdf".

للاطّلاع على الحصص اليومية للإحالات الناجحة، يُرجى الاطّلاع على حصص خدمات Google. قد تخضع نطاقات Google Workspace التي تم إنشاؤها حديثًا لحصص أكثر صرامة بشكل مؤقت.

المعلمات

الاسمالنوعالوصف
contentTypeStringنوع MIME الذي سيتم التحويل إليه. بالنسبة إلى معظم الكائنات الثنائية الكبيرة، 'application/pdf' هو الخيار الصالح الوحيد. بالنسبة إلى الصور بتنسيق BMP أو GIF أو JPEG أو PNG، يكون أي من 'image/bmp' أو 'image/gif' أو 'image/jpeg' أو 'image/png' صالحًا أيضًا. بالنسبة إلى مستند Google، يكون 'text/markdown' صالحًا أيضًا.

الإرجاع

Blob: البيانات ككائن ثنائي كبير.


getBlob()

لعرض البيانات داخل هذا العنصر ككائن ثنائي كبير.

الإرجاع

Blob: البيانات ككائن ثنائي كبير.


getDateCreated()

تعرض هذه السمة تاريخ إنشاء File.

الإرجاع

Date: تاريخ إنشاء File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDescription()

تعرض هذه السمة وصفًا لـ File.

الإرجاع

String: وصف File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getDownloadUrl()

تعرض هذه السمة عنوان URL الذي يمكن استخدامه لتنزيل الملف. يمكن فقط للمستخدمين الذين لديهم إذن بفتح الملف في Google Drive الوصول إلى عنوان URL. يمكنك استخدام عنوان URL هذا في متصفّح لتنزيل الملف، ولكن لا يمكنك استخدامه لجلب الملف باستخدام UrlFetchApp. إذا كنت تريد تضمين محتوى الملف في البرنامج النصي، استخدِم getBlob().

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the download URLs to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getDownloadUrl());
}

الإرجاع

String: عنوان URL الذي يمكن استخدامه لتنزيل الملف.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getEditors()

تعرض هذه الطريقة قائمة بالمحرّرين لـ File. إذا لم يكن لدى المستخدم الذي ينفّذ البرنامج النصي إذن بتعديل File، ستعرض هذه الطريقة مصفوفة فارغة.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Adds the email addresses in the array as editors of each file.
  // TODO(developer): Replace 'cloudysanfrancisco@gmail.com'
  // and 'baklavainthebalkans@gmail.com' with valid email addresses.
  file.addEditors([
    'cloudysanfrancisco@gmail.com',
    'baklavainthebalkans@gmail.com',
  ]);

  // Gets a list of the file editors.
  const editors = file.getEditors();

  // For each file, logs the editors' email addresses to the console.
  for (const editor of editors) {
    console.log(editor.getEmail());
  }
}

الإرجاع

User[]: إذا كان لدى المستخدم إذن بالتعديل على File، تعرض هذه السمة قائمة بالمحرّرين. إذا لم يكن لدى المستخدم إذن تعديل، سيتم عرض مصفوفة فارغة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getId()

تعرض هذه السمة رقم تعريف File.

الإرجاع

String: معرّف File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getLastUpdated()

تعرض هذه السمة تاريخ آخر تعديل على File.

الإرجاع

Date: تاريخ آخر تعديل على File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getMimeType()

تعرض هذه السمة نوع MIME للملف.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the MIME type to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getMimeType());
}

الإرجاع

استبدِل String بنوع MIME للملف.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getName()

تعرض هذه السمة اسم File.

الإرجاع

String: اسم File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getOwner()

تعرض هذه الطريقة مالك الملف.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files and logs the names of the file owners to the console.
while (files.hasNext()) {
  const file = files.next();
  console.log(file.getOwner().getName());
}

الإرجاع

User: مالك الملف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getParents()

تعرض هذه الطريقة مجموعة من المجلدات التي تمثّل المجلدات الرئيسية المباشرة للعنصر File.

الإرجاع

FolderIterator: مجموعة من المجلدات التي تمثّل المجلدات الرئيسية المباشرة لـ File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getResourceKey()

تعرض هذه السمة مفتاح المورد الخاص بـ File المطلوب للوصول إلى الملفات التي تمت مشاركتها باستخدام رابط.

الإرجاع

String: مفتاح المورد الخاص بـ File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEligible()

تعرض هذه السمة ما إذا كان File مؤهلاً لتطبيق تحديث الأمان الذي يتطلّب مفتاح مصدر للوصول إلى الملف عند مشاركته باستخدام رابط.

يتطلّب Drive مفتاح مورد للوصول إلى بعض الملفات أو المجلدات التي تمت مشاركتها باستخدام رابط. هذا التغيير هو جزء من تحديث أمان. يكون التعديل مفعّلاً تلقائيًا للملفات والمجلدات المؤهَّلة. لتفعيل أو إيقاف شرط مفتاح المرجع للملفات المؤهَّلة، استخدِم setSecurityUpdateEnabled.

مزيد من المعلومات حول تحديث الأمان لخدمة Google Drive

الإرجاع

Boolean: ما إذا كان يمكن تطبيق شرط مفتاح المورد على File.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSecurityUpdateEnabled()

تعرض هذه السمة ما إذا كان File يتطلّب مفتاح مورد للوصول إليه عند مشاركته باستخدام رابط. ويكون هذا الشرط مفعّلاً تلقائيًا للملفات والمجلدات المؤهّلة. لتفعيل أو إيقاف شرط مفتاح المرجع للملفات المؤهَّلة، استخدِم setSecurityUpdateEnabled.

مزيد من المعلومات حول تحديث الأمان لخدمة Google Drive

الإرجاع

Boolean: ما إذا كان شرط مفتاح المورد مفعَّلاً لهذا File.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingAccess()

تعرض هذه السمة فئة المستخدمين الذين يمكنهم الوصول إلى File، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول بشكل صريح.

الإرجاع

Access: فئة المستخدمين الذين يمكنهم الوصول إلى File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSharingPermission()

تعرض هذه السمة الإذن الممنوح للمستخدمين الذين يمكنهم الوصول إلى File، بالإضافة إلى أي مستخدمين فرديين تم منحهم الإذن بالوصول بشكل صريح.

الإرجاع

Permission: الأذونات الممنوحة للمستخدمين الذين يمكنهم الوصول إلى File

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getSize()

تعرض هذه السمة عدد وحدات البايت المستخدَمة لتخزين File في Drive. يُرجى العِلم أنّ ملفات تطبيقات Google Workspace لا تُحتسَب ضمن حدود مساحة التخزين في Drive، وبالتالي تعرض 0 بايت.

الإرجاع

Integer: عدد وحدات البايت المستخدَمة لتخزين File في Drive

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getTargetId()

إذا كان هذا العنصر عبارة عن اختصار، تعرض هذه السمة رقم تعريف العنصر الذي يشير إليه.

بخلاف ذلك، تعرض null.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the target ID of the shortcut.
console.log(`${shortcut.getName()}=${shortcut.getTargetId()}`);

الإرجاع

String|null: معرّف العنصر المستهدف، أو null إذا لم يكن الملف اختصارًا


getTargetMimeType()

إذا كان هذا العنصر عبارة عن اختصار، تعرض هذه السمة نوع MIME الخاص بالعنصر الذي يشير إليه.

بخلاف ذلك، تعرض null.

// The ID of the file for which to make a shortcut and the ID of
// the folder to which you want to add the shortcut.
// TODO(developer): Replace the file and folder IDs with your IDs.
const fileId = 'abc123456';
const folderId = 'xyz987654';

// Gets the folder to add the shortcut to.
const folder = DriveApp.getFolderById(folderId);

// Creates a shortcut of the file and moves it to the specified folder.
const shortcut = DriveApp.createShortcut(fileId).moveTo(folder);

// Logs the MIME type of the file that the shortcut points to.
console.log(`MIME type of the shortcut: ${shortcut.getTargetMimeType()}`);

الإرجاع

String|null: نوع MIME للعنصر المستهدَف أو null إذا كان الملف ليس اختصارًا


getTargetResourceKey()

إذا كان الملف عبارة عن اختصار، يعرض مفتاح مصدر العنصر الذي يشير إليه. مفتاح المورد هو مَعلمة إضافية يجب إدخالها للوصول إلى الملفات التي تمت مشاركتها باستخدام رابط.

إذا لم يكن الملف اختصارًا، سيعرض null.

//  Gets a file by its ID.
//  TODO(developer): Replace 'abc123456' with your file ID.
const file = DriveApp.getFileById('abc123456');

// If the file is a shortcut, returns the resource key of the file that it
// points to.
console.log(file.getTargetResourceKey());

الإرجاع

String|null: مفتاح المورد للعنصر المستهدف أو null إذا لم يكن الملف اختصارًا

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getThumbnail()

تعرض هذه السمة صورة مصغّرة للملف، أو null إذا لم تكن هناك صورة مصغّرة.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Logs the thumbnail image for each file to the console as a blob,
  // or null if no thumbnail exists.
  console.log(file.getThumbnail());
}

الإرجاع

Blob|null: الصورة المصغّرة للملف

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getUrl()

تعرض هذه السمة عنوان URL الذي يمكن استخدامه لفتح File في أحد تطبيقات Google، مثل Drive أو "مستندات Google".

الإرجاع

String: عنوان URL يمكن استخدامه لعرض هذا File في أحد تطبيقات Google، مثل Drive أو "مستندات Google"

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

getViewers()

تعرض هذه السمة قائمة بالمشاهدين والمعلّقين على File. إذا لم يكن لدى المستخدم الذي ينفّذ النص البرمجي إذن تعديل File، ستعرض هذه الطريقة مصفوفة فارغة.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // For each file, logs the viewers' email addresses to the console.
  const viewers = file.getViewers();
  for (const viewer of viewers) {
    console.log(viewer.getEmail());
  }
}

الإرجاع

User[]: إذا كان لدى المستخدم إذن بالتعديل على هذا File، تعرض هذه السمة قائمة بالمشاهدين والمعلّقين. إذا لم يكن لدى المستخدم إذن تعديل، سيتم عرض مصفوفة فارغة.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isShareableByEditors()

تحدّد هذه السمة ما إذا كان يُسمح للمستخدمين الذين لديهم أذونات تعديل File بالمشاركة مع مستخدمين آخرين أو تغيير الأذونات.

الإرجاع

Booleantrue إذا كان مسموحًا للمستخدمين الذين لديهم أذونات التعديل مشاركة الملف مع مستخدمين آخرين أو تغيير الأذونات، false إذا لم يكن مسموحًا بذلك

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isStarred()

تُحدِّد هذه السمة ما إذا تم تمييز File بنجمة في حساب Drive الخاص بالمستخدم.

الإرجاع

Boolean: true إذا تم تمييز File بنجمة في حساب Drive الخاص بالمستخدم، false إذا لم يتم تمييزه

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

isTrashed()

يحدّد هذا الحقل ما إذا كان File في مهملات حساب المستخدم على Drive.

الإرجاع

Booleantrue إذا كان File في مهملات حساب المستخدم على Drive؛ false إذا لم يكن كذلك

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive

makeCopy()

ينشئ نسخة من الملف.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and logs the file name to the console.
  console.log(file.makeCopy().getName());
}

الإرجاع

File: النسخة الجديدة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

makeCopy(destination)

ينشئ نسخة من الملف في دليل الوجهة.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and adds it to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy(destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

المعلمات

الاسمالنوعالوصف
destinationFolderالدليل المطلوب نسخ الملف إليه

الإرجاع

File: النسخة الجديدة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

makeCopy(name)

ينشئ نسخة من الملف ويسمّيها بالاسم المقدَّم.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file and sets the name to 'Test-Copy.'
  const filename = file.makeCopy('Test-Copy');

  // Logs the copied file's name to the console.
  console.log(filename.getName());
}

المعلمات

الاسمالنوعالوصف
nameStringاسم الملف الذي يجب تطبيقه على النسخة الجديدة.

الإرجاع

File: النسخة الجديدة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

makeCopy(name, destination)

ينشئ نسخة من الملف في دليل الوجهة ويسمّيها بالاسم المقدَّم.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Creates a copy of each file, sets the file name, and adds the copied file
  // to the specified folder.
  // TODO(developer): Replace the folder ID with your own.
  const destination = DriveApp.getFolderById('123456abcxyz');
  const copiedFile = file.makeCopy('Test-Copy', destination);

  // Logs the file names to the console.
  console.log(copiedFile.getName());
}

المعلمات

الاسمالنوعالوصف
nameStringاسم الملف الذي يجب تطبيقه على النسخة الجديدة.
destinationFolderالدليل المطلوب نسخ الملف إليه

الإرجاع

File: النسخة الجديدة

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

moveTo(destination)

تنقل هذه الطريقة العنصر إلى مجلد الوجهة المحدّد.

يجب أن يكون المستخدم الحالي هو مالك الملف أو أن يكون لديه إذن بالتعديل على الأقل في المجلد الرئيسي الحالي للعنصر كي يتمكّن من نقله إلى مجلد الوجهة.

المعلمات

الاسمالنوعالوصف
destinationFolderالمجلد الذي سيصبح المجلد الرئيسي الجديد

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

removeCommenter(emailAddress)

يزيل هذا الإجراء المستخدم المحدّد من قائمة المعلّقين على File. لا تمنع هذه الطريقة المستخدمين من الوصول إلى File إذا كانوا ينتمون إلى فئة من المستخدمين لديهم إذن وصول عام، مثلاً، إذا تمت مشاركة File مع النطاق الكامل للمستخدم.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  // TODO(developer): Replace the email with the email of the user you want to
  // remove.
  file.removeCommenter('cloudysanfrancisco@gmail.com');
}

المعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي تريد إزالته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

removeCommenter(user)

يزيل هذا الإجراء المستخدم المحدّد من قائمة المعلّقين على File. لا تمنع هذه الطريقة المستخدمين من الوصول إلى File إذا كانوا ينتمون إلى فئة من المستخدمين لديهم إذن وصول عام، مثلاً، إذا تمت مشاركة File مع النطاق الكامل للمستخدم.

// Gets a list of all files in Google Drive with the given name.
// TODO(developer): Replace the file name with your own.
const files = DriveApp.getFilesByName('Test');

// Loops through the files.
while (files.hasNext()) {
  const file = files.next();

  // Removes the given user from the list of commenters for each file.
  console.log(file.removeCommenter(Session.getActiveUser()));
}

المعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم المطلوب إزالته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

removeEditor(emailAddress)

تزيل هذه السمة المستخدم المحدّد من قائمة المحرّرين في File. لا تمنع هذه الطريقة المستخدمين من الوصول إلى File إذا كانوا ينتمون إلى فئة من المستخدمين لديهم إذن وصول عام، مثلاً، إذا تمت مشاركة File مع نطاق المستخدم بأكمله، أو إذا كان File في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

بالنسبة إلى ملفات Drive، تؤدي هذه العملية أيضًا إلى إزالة المستخدم من قائمة المشاهدين.

المعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي تريد إزالته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

removeEditor(user)

تزيل هذه السمة المستخدم المحدّد من قائمة المحرّرين في File. لا تمنع هذه الطريقة المستخدمين من الوصول إلى File إذا كانوا ينتمون إلى فئة من المستخدمين لديهم إذن وصول عام، مثلاً، إذا تمت مشاركة File مع نطاق المستخدم بأكمله، أو إذا كان File في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

بالنسبة إلى ملفات Drive، تؤدي هذه العملية أيضًا إلى إزالة المستخدم من قائمة المشاهدين.

المعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم المطلوب إزالته

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

removeViewer(emailAddress)

تزيل هذه الطريقة المستخدم المحدّد من قائمة المشاهدين والمعلّقين على File. ليس لهذه الطريقة أي تأثير إذا كان المستخدم محرّرًا وليس مشاهدًا أو معلّقًا. لا تمنع هذه الطريقة أيضًا المستخدمين من الوصول إلى File إذا كانوا ينتمون إلى فئة من المستخدمين لديهم إذن وصول عام، مثلاً إذا تمت مشاركة File مع النطاق بأكمله للمستخدم، أو إذا كان File في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المحرّرين.

المعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي تريد إزالته

الإرجاع

File: هذا File للتسلسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

removeViewer(user)

تزيل هذه الطريقة المستخدم المحدّد من قائمة المشاهدين والمعلّقين على File. لن يكون لهذا الإجراء أي تأثير إذا كان المستخدم محرّرًا وليس عارضًا. لا تمنع هذه الطريقة أيضًا المستخدمين من الوصول إلى File إذا كانوا ينتمون إلى فئة من المستخدمين لديهم إذن وصول عام، مثلاً إذا تمت مشاركة File مع النطاق الكامل للمستخدم أو إذا كان File في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

بالنسبة إلى ملفات Drive، يؤدي ذلك أيضًا إلى إزالة المستخدم من قائمة المحرّرين.

المعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم المطلوب إزالته

الإرجاع

File: هذا File للتسلسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

revokePermissions(emailAddress)

يلغي هذا الإجراء إذن الوصول إلى File الممنوح للمستخدم المحدّد. لا تمنع هذه الطريقة المستخدمين من الوصول إلى File إذا كانوا ينتمون إلى فئة من المستخدمين لديهم إذن وصول عام، مثلاً إذا تمت مشاركة File مع النطاق الكامل للمستخدم.

المعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي يجب إبطال إذن الوصول إليه.

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

revokePermissions(user)

يلغي هذا الإجراء إذن الوصول إلى File الممنوح للمستخدم المحدّد. لا تمنع هذه الطريقة المستخدمين من الوصول إلى File إذا كانوا ينتمون إلى فئة من المستخدمين لديهم إذن وصول عام، مثلاً، إذا تمت مشاركة File مع النطاق الكامل للمستخدم.

المعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم الذي يجب إلغاء إذن الوصول الخاص به

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setContent(content)

تستبدل هذه الطريقة محتوى الملف بنص بديل محدّد. يتم عرض استثناء إذا كان حجم content أكبر من 10 ميغابايت.

// Creates a text file with the content 'Hello, world!'
const file = DriveApp.createFile('New Text File', 'Hello, world!');

// Logs the content of the text file to the console.
console.log(file.getBlob().getDataAsString());

// Updates the content of the text file to 'Updated text!'
file.setContent('Updated text!');

// Logs content of the text file to the console.
console.log(file.getBlob().getDataAsString());

المعلمات

الاسمالنوعالوصف
contentStringالمحتوى الجديد للملف

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setDescription(description)

تضبط هذه السمة وصف File.

المعلمات

الاسمالنوعالوصف
descriptionStringالوصف الجديد لـ "File"

الإرجاع

File — هذا File، للسلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setName(name)

تُستخدَم لضبط اسم File.

المعلمات

الاسمالنوعالوصف
nameStringالاسم الجديد File

الإرجاع

File — هذا File، للسلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setOwner(emailAddress)

تغيير مالك File تمنح هذه الطريقة أيضًا المالك السابق إذن تعديل صريحًا على File.

المعلمات

الاسمالنوعالوصف
emailAddressStringعنوان البريد الإلكتروني للمستخدم الذي يجب أن يصبح المالك الجديد

الإرجاع

File — هذا File، للسلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setOwner(user)

تغيير مالك File تمنح هذه الطريقة أيضًا المالك السابق إذن تعديل صريحًا على File.

المعلمات

الاسمالنوعالوصف
userUserتمثيل للمستخدم الذي يجب أن يصبح المالك الجديد

الإرجاع

File — هذا File، للسلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setSecurityUpdateEnabled(enabled)

يحدّد هذا الحقل ما إذا كانت السمة File تتطلّب مفتاح مصدر للوصول إليها عند مشاركتها باستخدام رابط. يتم تفعيل الملفات والمجلدات المؤهَّلة تلقائيًا.

مزيد من المعلومات حول تحديث الأمان لخدمة Google Drive

المعلمات

الاسمالنوعالوصف
enabledBooleanتحديد ما إذا كان سيتم تفعيل شرط مفتاح المورد في File.

الإرجاع

File: هذا File، للسلاسل.

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setShareableByEditors(shareable)

يحدّد هذا الخيار ما إذا كان يُسمح للمستخدمين الذين لديهم أذونات تعديل File بمشاركة المحتوى مع مستخدمين آخرين أو تغيير الأذونات. القيمة التلقائية لـ File جديد هي true.

المعلمات

الاسمالنوعالوصف
shareableBooleantrue إذا كان يجب السماح للمستخدمين الذين لديهم أذونات التعديل بالمشاركة مع مستخدمين آخرين أو تغيير الأذونات، false إذا لم يكن كذلك

الإرجاع

File — هذا File، للسلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setSharing(accessType, permissionType)

تحدّد هذه السمة فئة المستخدمين الذين يمكنهم الوصول إلى File والأذونات الممنوحة لهم، بالإضافة إلى أي مستخدمين فرديين تم منحهم إذن الوصول بشكل صريح.

// Creates a folder that anyone on the Internet can read from and write to.
// (Domain administrators can prohibit this setting for users of a Google
// Workspace domain.)
const folder = DriveApp.createFolder('Shared Folder');
folder.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

المعلمات

الاسمالنوعالوصف
accessTypeAccessفئة المستخدمين التي يجب أن تتمكّن من الوصول إلى File
permissionTypePermissionالأذونات التي يجب منحها للمستخدمين الذين يمكنهم الوصول إلى File

الإرجاع

File — هذا File، للسلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setStarred(starred)

تضبط هذه السمة ما إذا كان الملف File مميّزًا بنجمة في حساب Drive الخاص بالمستخدم. القيمة التلقائية لـ File الجديدة هي false.

المعلمات

الاسمالنوعالوصف
starredBooleantrue إذا كان يجب تمييز File بنجمة في حساب Drive الخاص بالمستخدم، وfalse إذا لم يكن ذلك ضروريًا

الإرجاع

File — هذا File، للسلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive

setTrashed(trashed)

يضبط هذا الحقل ما إذا كان File في مهملات حساب المستخدم على Drive. يمكن للمالك فقط نقل File إلى المهملات. القيمة التلقائية لـ File الجديدة هي false.

المعلمات

الاسمالنوعالوصف
trashedBooleantrue إذا كان يجب نقل File إلى مهملات Drive الخاصة بالمستخدم، false إذا لم يكن ذلك ضروريًا

الإرجاع

File — هذا File، للسلاسل

التفويض

تتطلّب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على إذن باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/drive