Class Spreadsheet

تنظيم صفحاتك في مجموعات يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
جدول بيانات

الوصول إلى ملفات "جداول بيانات Google" وتعديلها والعمليات الشائعة هي إضافة أوراق جديدة وإضافة متعاونين.

الطُرق

الطريقةنوع الإرجاعوصف قصير
addDeveloperMetadata(key)Spreadsheetلإضافة البيانات الوصفية لمطوّر البرامج باستخدام المفتاح المحدّد إلى جدول بيانات المستوى الأعلى.
addDeveloperMetadata(key, visibility)Spreadsheetلإضافة البيانات الوصفية لمطوّر البرامج مع المفتاح المحدد ومستوى الرؤية إلى جدول البيانات.
addDeveloperMetadata(key, value)Spreadsheetلإضافة البيانات الوصفية لمطوّر البرامج بالمفتاح والقيمة المحدّدين إلى جدول البيانات.
addDeveloperMetadata(key, value, visibility)Spreadsheetلإضافة البيانات الوصفية لمطوّر البرامج بالمفتاح والقيمة وحق الدخول إلى جدول البيانات.
addEditor(emailAddress)Spreadsheetإضافة المستخدم المحدد إلى قائمة محرِّري Spreadsheet.
addEditor(user)Spreadsheetإضافة المستخدم المحدد إلى قائمة محرِّري Spreadsheet.
addEditors(emailAddresses)Spreadsheetلإضافة الصفيف المحدد من المستخدمين إلى قائمة المحررين لـ Spreadsheet.
addMenu(name, subMenus)voidلإنشاء قائمة جديدة في واجهة مستخدم جدول البيانات.
addViewer(emailAddress)Spreadsheetلإضافة المستخدم المحدد إلى قائمة مشاهدي Spreadsheet.
addViewer(user)Spreadsheetلإضافة المستخدم المحدد إلى قائمة مشاهدي Spreadsheet.
addViewers(emailAddresses)Spreadsheetلإضافة الصفيف المحدد من المستخدمين إلى قائمة مشاهدي Spreadsheet.
appendRow(rowContents)Sheetلإلحاق صف أسفل منطقة البيانات الحالية في الورقة.
autoResizeColumn(columnPosition)Sheetلتعيين عرض العمود المعين ليلائم محتوياته.
copy(name)Spreadsheetلنسخ جدول البيانات وعرض الجدول الجديد.
createDeveloperMetadataFinder()DeveloperMetadataFinderلعرض DeveloperMetadataFinder للبحث عن البيانات الوصفية لمطوّر البرامج ضمن نطاق جدول البيانات هذا.
createTextFinder(findText)TextFinderلإنشاء باحث عن النص لجدول البيانات، والذي يمكن استخدامه للعثور على نص واستبداله داخل جدول البيانات.
deleteActiveSheet()Sheetلحذف الورقة النشطة حاليًا.
deleteColumn(columnPosition)Sheetلحذف العمود في موضع العمود المحدد.
deleteColumns(columnPosition, howMany)voidحذف عدد من الأعمدة بدءًا من موضع العمود المحدد.
deleteRow(rowPosition)Sheetلحذف الصف في موضع الصف المحدد.
deleteRows(rowPosition, howMany)voidلحذف عدد من الصفوف بدءًا من موضع الصف المحدد.
deleteSheet(sheet)voidلحذف الورقة المحددة.
duplicateActiveSheet()Sheetتكرار الورقة النشطة وجعلها الورقة النشطة.
getActiveCell()Rangeلعرض الخلية النشطة في هذه الورقة.
getActiveRange()Rangeلعرض النطاق المحدد في الورقة النشطة، أو null إذا لم يكن هناك نطاق نشط.
getActiveRangeList()RangeListلعرض قائمة النطاقات النشطة في الورقة النشطة أو null إذا لم تكن هناك نطاقات نشطة.
getActiveSheet()Sheetللحصول على الورقة النشطة في جدول بيانات.
getAs(contentType)Blobيمكنك عرض البيانات داخل هذا الكائن كائن ثنائي كبير (blob) تم تحويله إلى نوع المحتوى المحدد.
getBandings()Banding[]لعرض جميع الأشرطة في جدول البيانات هذا.
getBlob()Blobاعرض البيانات داخل هذا الكائن كائن كائن ثنائي كبير.
getColumnWidth(columnPosition)Integerللحصول على عرض بالبكسل للعمود المحدّد.
getCurrentCell()Rangeلعرض الخلية الحالية في الورقة النشطة أو null إذا لم تكن هناك خلية حالية.
getDataRange()Rangeلعرض Range يتطابق مع الأبعاد التي توجد بها بيانات.
getDataSourceFormulas()DataSourceFormula[]للحصول على جميع صيغ مصدر البيانات.
getDataSourcePivotTables()DataSourcePivotTable[]لعرض جميع الجداول المحورية لمصدر البيانات.
getDataSourceRefreshSchedules()DataSourceRefreshSchedule[]للحصول على الجداول الزمنية للتحديث لجدول البيانات هذا.
getDataSourceSheets()DataSourceSheet[]لعرض جميع أوراق مصدر البيانات في جدول البيانات.
getDataSourceTables()DataSourceTable[]الحصول على جميع جداول مصدر البيانات.
getDataSources()DataSource[]لعرض جميع مصادر البيانات في جدول البيانات.
getDeveloperMetadata()DeveloperMetadata[]الحصول على البيانات الوصفية لمطوّر البرامج المرتبطة بجدول بيانات المستوى الأعلى.
getEditors()User[]للحصول على قائمة بالمحررين لهذه Spreadsheet.
getFormUrl()Stringيعرض عنوان URL للنموذج الذي يرسل ردوده إلى جدول البيانات هذا، أو null إذا كان جدول البيانات هذا لا يحتوي على نموذج مقترن.
getFrozenColumns()Integerلعرض عدد الأعمدة المجمدة.
getFrozenRows()Integerلعرض عدد الصفوف المجمدة.
getId()Stringالحصول على معرّف فريد لجدول البيانات هذا.
getImages()OverGridImage[]لعرض جميع الصور فوق الشبكة في الورقة.
getIterativeCalculationConvergenceThreshold()Numberلعرض قيمة الحد الأدنى المستخدمة أثناء الحساب المكرر.
getLastColumn()Integerلعرض موضع العمود الأخير الذي يتضمن محتوى.
getLastRow()Integerلعرض موضع الصف الأخير الذي يتضمن محتوى.
getMaxIterativeCalculationCycles()Integerلعرض الحد الأقصى لعدد التكرارات المطلوب استخدامها أثناء الحساب المكرر.
getName()Stringللحصول على اسم المستند.
getNamedRanges()NamedRange[]للحصول على جميع النطاقات المُعنونة في جدول البيانات هذا.
getNumSheets()Integerلعرض عدد الأوراق في جدول البيانات هذا.
getOwner()Userيعرض مالك المستند أو null لمستند في مساحة تخزين سحابي مشتركة.
getPredefinedSpreadsheetThemes()SpreadsheetTheme[]لعرض قائمة المظاهر المحددة مسبقًا.
getProtections(type)Protection[]للحصول على مصفوفة من العناصر التي تمثل جميع النطاقات أو الأوراق المحمية في جدول البيانات.
getRange(a1Notation)Rangeلعرض النطاق كما هو محدد في تدوين A1 أو تدوين R1C1.
getRangeByName(name)Rangeلعرض نطاق مُعنون أو null إذا لم يتم العثور على نطاق بالاسم المحدد.
getRangeList(a1Notations)RangeListلعرض المجموعة RangeList التي تمثل النطاقات في الورقة نفسها المحددة من خلال قائمة غير فارغة من تدوينات A1 أو تدوينات R1C1.
getRecalculationInterval()RecalculationIntervalلعرض الفاصل الزمني للحساب في جدول البيانات هذا.
getRowHeight(rowPosition)Integerللحصول على الارتفاع بالبكسل للصف المحدد.
getSelection()Selectionلعرض Selection الحالية في جدول البيانات.
getSheetByName(name)Sheetلعرض ورقة تحمل الاسم المحدد.
getSheetId()Integerلعرض معرّف الورقة الذي يمثله هذا الكائن.
getSheetName()Stringلعرض اسم الورقة.
getSheetValues(startRow, startColumn, numRows, numColumns)Object[][]لعرض شبكة قيم مستطيلة لهذا النطاق تبدأ من الإحداثيات المحددة.
getSheets()Sheet[]لعرض كل الأوراق في جدول البيانات هذا.
getSpreadsheetLocale()Stringللحصول على لغة جدول البيانات.
getSpreadsheetTheme()SpreadsheetThemeلعرض المظهر الحالي لجدول البيانات، أو null في حالة عدم تطبيق أي مظهر.
getSpreadsheetTimeZone()Stringللحصول على المنطقة الزمنية لجدول البيانات.
getUrl()Stringلعرض عنوان URL لجدول البيانات المحدد.
getViewers()User[]لعرض قائمة المشاهدين والمعلقين على Spreadsheet.
hideColumn(column)voidلإخفاء العمود أو الأعمدة في النطاق المحدد.
hideRow(row)voidلإخفاء الصفوف في النطاق المحدد.
insertColumnAfter(afterPosition)Sheetإدراج عمود بعد موضع العمود المحدّد.
insertColumnBefore(beforePosition)Sheetإدراج عمود قبل موضع العمود المحدّد.
insertColumnsAfter(afterPosition, howMany)Sheetإدراج عدد من الأعمدة بعد موضع العمود المحدد.
insertColumnsBefore(beforePosition, howMany)Sheetإدراج عدد من الأعمدة قبل موضع العمود المحدد.
insertDataSourceSheet(spec)DataSourceSheetلإدراج DataSourceSheet جديد في جدول البيانات وبدء تنفيذ البيانات.
insertImage(blobSource, column, row)OverGridImageلإدراج Spreadsheet كصورة في المستند في صف وعمود معيّنين.
insertImage(blobSource, column, row, offsetX, offsetY)OverGridImageلإدراج Spreadsheet كصورة في المستند في صف وعمود معيّنين، مع إزاحة للبكسل.
insertImage(url, column, row)OverGridImageيدرج صورة في المستند في صف وعمود معينين.
insertImage(url, column, row, offsetX, offsetY)OverGridImageيدرج صورة في المستند في صف وعمود معين، مع إزاحة للبكسل.
insertRowAfter(afterPosition)Sheetإدراج صف بعد موضع الصف المحدّد.
insertRowBefore(beforePosition)Sheetلإدراج صف قبل موضع الصف المحدد.
insertRowsAfter(afterPosition, howMany)Sheetإدراج عدد من الصفوف بعد موضع الصف المحدد.
insertRowsBefore(beforePosition, howMany)Sheetإدراج عدد من الصفوف قبل موضع الصف المحدد.
insertSheet()Sheetلإدراج ورقة جديدة في جدول البيانات، باستخدام اسم ورقة افتراضية.
insertSheet(sheetIndex)Sheetإدراج ورقة جديدة في جدول البيانات في الفهرس المحدد.
insertSheet(sheetIndex, options)Sheetلإدراج ورقة جديدة في جدول البيانات في الفهرس المحدد واستخدام وسيطات اختيارية اختيارية.
insertSheet(options)Sheetلإدراج ورقة جديدة في جدول البيانات، باستخدام اسم ورقة افتراضية ووسيطات متقدمة اختيارية.
insertSheet(sheetName)Sheetلإدراج ورقة جديدة في جدول البيانات باستخدام الاسم المحدد.
insertSheet(sheetName, sheetIndex)Sheetإدراج ورقة جديدة في جدول البيانات مع تحديد الاسم نفسه في الفهرس المحدد.
insertSheet(sheetName, sheetIndex, options)Sheetلإدراج ورقة جديدة في جدول البيانات مع وضع الاسم المحدد في الفهرس المحدد واستخدام الوسيطات المتقدمة الاختيارية.
insertSheet(sheetName, options)Sheetلإدراج ورقة جديدة في جدول البيانات بالاسم المحدد واستخدام الوسيطات المتقدمة الاختيارية.
insertSheetWithDataSourceTable(spec)Sheetلإدراج ورقة جديدة في جدول البيانات، وإنشاء DataSourceTable عبر الورقة بأكملها مع مواصفات مصدر البيانات المحددة، وبدء تنفيذ البيانات.
isColumnHiddenByUser(columnPosition)Booleanلعرض ما إذا كان العمود المعني مخفيًا بواسطة المستخدم.
isIterativeCalculationEnabled()Booleanلعرض ما إذا كان الحساب المكرر مفعّلاً في جدول البيانات هذا أم لا.
isRowHiddenByFilter(rowPosition)Booleanلعرض ما إذا كان الصف المحدد مخفيًا من خلال فلتر (وليس عرض فلتر).
isRowHiddenByUser(rowPosition)Booleanلعرض ما إذا كان الصف المحدد مخفيًا بواسطة المستخدم.
moveActiveSheet(pos)voidلنقل الورقة النشطة إلى الموضع المحدد في قائمة الأوراق.
moveChartToObjectSheet(chart)Sheetلإنشاء ورقة SheetType.OBJECT جديدة ونقل الرسم البياني المتوفر إليها.
refreshAllDataSources()voidيؤدي هذا الإعداد إلى إعادة تحميل جميع مصادر البيانات المتوافقة وكائنات مصدر البيانات المرتبطة بها، مع تخطي عناصر مصدر البيانات غير الصالحة.
removeEditor(emailAddress)Spreadsheetإزالة المستخدم المحدد من قائمة المحررين لـ Spreadsheet.
removeEditor(user)Spreadsheetإزالة المستخدم المحدد من قائمة المحررين لـ Spreadsheet.
removeMenu(name)voidإزالة قائمة أضافها addMenu(name, subMenus).
removeNamedRange(name)voidلحذف نطاق مُعنون بالاسم نفسه.
removeViewer(emailAddress)Spreadsheetيزيل المستخدم المعين من قائمة المشاهدين والمعلقين في Spreadsheet.
removeViewer(user)Spreadsheetيزيل المستخدم المعين من قائمة المشاهدين والمعلقين في Spreadsheet.
rename(newName)voidلإعادة تسمية المستند.
renameActiveSheet(newName)voidإعادة تسمية الورقة النشطة الحالية إلى الاسم الجديد المحدد.
resetSpreadsheetTheme()SpreadsheetThemeإزالة المظهر الذي تم تطبيقه وتعيين المظهر التلقائي في جدول البيانات.
setActiveRange(range)Rangeلتعيين النطاق المحدد على active range في الورقة النشطة، مع وضع الخلية أعلى اليمين في النطاق كـ current cell.
setActiveRangeList(rangeList)RangeListتُحدِّد هذه السياسة قائمة النطاقات المحدَّدة على أنها active ranges في الورقة النشطة.
setActiveSelection(range)Rangeلتعيين منطقة التحديد النشطة لهذه الورقة.
setActiveSelection(a1Notation)Rangeلتعيين التحديد النشط، كما هو محدد في تدوين A1 أو تدوين R1C1.
setActiveSheet(sheet)Sheetلتعيين الورقة المحددة لتكون الورقة النشطة في جدول البيانات.
setActiveSheet(sheet, restoreSelection)Sheetلتعيين الورقة المحددة لتكون الورقة النشطة في جدول البيانات، مع خيار استعادة أحدث تحديد في هذه الورقة.
setColumnWidth(columnPosition, width)Sheetلتعيين عرض العمود المعين بالبكسل.
setCurrentCell(cell)Rangeلتعيين الخلية المحددة إلى current cell.
setFrozenColumns(columns)voidتجميد عدد معين من الأعمدة.
setFrozenRows(rows)voidتجميد عدد معين من الصفوف.
setIterativeCalculationConvergenceThreshold(minThreshold)Spreadsheetلتعيين الحد الأدنى لقيمة الحساب المكرر.
setIterativeCalculationEnabled(isEnabled)Spreadsheetلتحديد ما إذا كان سيتم تفعيل الحساب المكرر في جدول البيانات هذا أم لا.
setMaxIterativeCalculationCycles(maxIterations)Spreadsheetلتعيين الحد الأقصى لعدد تكرارات العمليات الحسابية التي يجب تنفيذها أثناء الحساب المكرر.
setNamedRange(name, range)voidلتسمية نطاق.
setRecalculationInterval(recalculationInterval)Spreadsheetلتعيين عدد مرات إعادة حساب جدول البيانات هذا.
setRowHeight(rowPosition, height)Sheetلتعيين ارتفاع الصف بالبكسل المحدد بالبكسل.
setSpreadsheetLocale(locale)voidلتعيين لغة جدول البيانات.
setSpreadsheetTheme(theme)SpreadsheetThemeلضبط مظهر في جدول البيانات.
setSpreadsheetTimeZone(timezone)voidلتعيين المنطقة الزمنية لجدول البيانات.
show(userInterface)voidلعرض مكوّن واجهة مستخدم مخصص في مربع حوار يتم توسيطه في إطار عرض متصفح المستخدم.
sort(columnPosition)Sheetلترتيب ورقة حسب العمود، تصاعديًا.
sort(columnPosition, ascending)Sheetلترتيب ورقة حسب العمود.
toast(msg)voidيعرض نافذة منبثقة في الجانب السفلي الأيسر من جدول البيانات بالرسالة المحددة.
toast(msg, title)voidيعرض نافذة منبثقة في الجانب السفلي الأيسر من جدول البيانات تتضمن الرسالة والعنوان.
toast(msg, title, timeoutSeconds)voidلعرض نافذة منبثقة أسفل الجانب الأيسر من جدول البيانات تحتوي على العنوان والرسالة المحدّدَين، وتبقى مرئية لفترة زمنية محدّدة.
unhideColumn(column)voidلإظهار العمود في النطاق المعين.
unhideRow(row)voidلإظهار الصف في النطاق المعين.
updateMenu(name, subMenus)voidتحديث قائمة تمت إضافتها بواسطة addMenu(name, subMenus).
waitForAllDataExecutionsCompletion(timeoutInSeconds)voidالانتظار حتى تكتمل جميع عمليات التنفيذ الحالية في جدول البيانات، بحيث تنتهي المهلة بعد عدد الثواني المقدَّم.

الوثائق التفصيلية

addDeveloperMetadata(key)

لإضافة البيانات الوصفية لمطوّر البرامج باستخدام المفتاح المحدّد إلى جدول بيانات المستوى الأعلى.

المَعلمات

الاسمالنوعالوصف
keyStringمفتاح البيانات الوصفية الجديدة لمطوّر البرامج.

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addDeveloperMetadata(key, visibility)

لإضافة البيانات الوصفية لمطوّر البرامج مع المفتاح المحدد ومستوى الرؤية إلى جدول البيانات.

المَعلمات

الاسمالنوعالوصف
keyStringمفتاح البيانات الوصفية الجديدة لمطوّر البرامج.
visibilityDeveloperMetadataVisibilityمستوى رؤية البيانات الوصفية الجديدة لمطوّر البرامج.

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addDeveloperMetadata(key, value)

لإضافة البيانات الوصفية لمطوّر البرامج بالمفتاح والقيمة المحدّدين إلى جدول البيانات.

المَعلمات

الاسمالنوعالوصف
keyStringمفتاح البيانات الوصفية الجديدة لمطوّر البرامج.
valueStringقيمة البيانات الوصفية الجديدة لمطوّر البرامج.

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addDeveloperMetadata(key, value, visibility)

لإضافة البيانات الوصفية لمطوّر البرامج بالمفتاح والقيمة وحق الدخول إلى جدول البيانات.

المَعلمات

الاسمالنوعالوصف
keyStringمفتاح البيانات الوصفية الجديدة لمطوّر البرامج.
valueStringقيمة البيانات الوصفية الجديدة لمطوّر البرامج.
visibilityDeveloperMetadataVisibilityمستوى رؤية البيانات الوصفية الجديدة لمطوّر البرامج.

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addEditor(emailAddress)

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addEditor(user)

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addEditors(emailAddresses)

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addMenu(name, subMenus)

لإنشاء قائمة جديدة في واجهة مستخدم جدول البيانات.

يشغل كل إدخال في القائمة دالة من تحديد المستخدم. عادة ما تريد استدعاؤها من الدالة onOpen() بحيث يتم إنشاء القائمة تلقائيًا عند تحميل جدول البيانات.

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function function1 is
  // executed.
  menuEntries.push({name: "Menu Entry 1", functionName: "function1"});
  menuEntries.push(null); // line separator
  menuEntries.push({name: "Menu Entry 2", functionName: "function2"});

  ss.addMenu("addMenuExample", menuEntries);
}

المَعلمات

الاسمالنوعالوصف
nameStringاسم القائمة التي سيتم إنشاؤها.
subMenusObject[]مصفوفة من خرائط JavaScript مع معلّمتَي name وfunctionName . يمكنك استخدام وظائف من المكتبات المضمّنة، مثل Library.libFunction1.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addViewer(emailAddress)

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addViewer(user)

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

addViewers(emailAddresses)

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

appendRow(rowContents)

لإلحاق صف أسفل منطقة البيانات الحالية في الورقة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(["a man", "a plan", "panama"]);

المَعلمات

الاسمالنوعالوصف
rowContentsObject[]مصفوفة من القيم لإدراجها بعد الصف الأخير في الورقة.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

autoResizeColumn(columnPosition)

لتعيين عرض العمود المعين ليلائم محتوياته.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue('Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerموضع العمود المحدّد لتغيير حجمه.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

copy(name)

لنسخ جدول البيانات وعرض الجدول الجديد.

// This code makes a copy of the current spreadsheet and names it appropriately
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy("Copy of " + ss.getName());

المَعلمات

الاسمالنوعالوصف
nameStringاسم النسخة.

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

createDeveloperMetadataFinder()

لعرض DeveloperMetadataFinder للبحث عن البيانات الوصفية لمطوّر البرامج ضمن نطاق جدول البيانات هذا. تراعي هذه الميزة تلقائيًا جميع البيانات الوصفية المقترنة بجدول البيانات والأوراق والصفوف والأعمدة.

تذكرة ذهاب وعودة

DeveloperMetadataFinder — أداة للبحث عن البيانات الوصفية لمطوّر البرامج للبحث عن البيانات الوصفية في نطاق جدول البيانات هذا.


createTextFinder(findText)

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
var textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
var firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.replaceWith('cat');

المَعلمات

الاسمالنوعالوصف
findTextStringالنص المطلوب البحث عنه.

تذكرة ذهاب وعودة

TextFinderTextFinder لجدول البيانات.


deleteActiveSheet()

لحذف الورقة النشطة حاليًا.

// The code below deletes the currently active sheet and stores the new active sheet in a
// variable
var newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

تذكرة ذهاب وعودة

Sheet — الورقة النشطة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

deleteColumn(columnPosition)

لحذف العمود في موضع العمود المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerموضع العمود، بدءًا من 1 للعمود الأول.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

deleteColumns(columnPosition, howMany)

حذف عدد من الأعمدة بدءًا من موضع العمود المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerموضع العمود الأول المطلوب حذفه.
howManyIntegerعدد الأعمدة المراد حذفها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

deleteRow(rowPosition)

لحذف الصف في موضع الصف المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerموضع الصف، بدءًا من 1 للصف الأول.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

deleteRows(rowPosition, howMany)

لحذف عدد من الصفوف بدءًا من موضع الصف المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerموضع الصف الأول المطلوب حذفه.
howManyIntegerعدد الصفوف المراد حذفها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

deleteSheet(sheet)

لحذف الورقة المحددة.

// The code below deletes the specified sheet.
var ss = SpreadsheetApp.getActive();
var sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

المَعلمات

الاسمالنوعالوصف
sheetSheetالورقة المطلوب حذفها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

duplicateActiveSheet()

تكرار الورقة النشطة وجعلها الورقة النشطة.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getActiveCell()

لعرض الخلية النشطة في هذه الورقة.

ملاحظة: يُفضل استخدام getCurrentCell()، التي تعرض الخلية المحدّدة الحالية.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var cell = sheet.getActiveCell();

تذكرة ذهاب وعودة

Range — الخلية النشطة الحالية

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getActiveRange()

لعرض النطاق المحدد في الورقة النشطة، أو null إذا لم يكن هناك نطاق نشط. إذا تم تحديد نطاقات متعددة، فلن تعرض هذه الطريقة إلا النطاق الأخير المحدد فقط.

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var activeRange = sheet.getActiveRange();

تذكرة ذهاب وعودة

Range — النطاق النشط

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

يمكن أيضًا مراجعة


getActiveRangeList()

لعرض قائمة النطاقات النشطة في الورقة النشطة أو null إذا لم تكن هناك نطاقات نشطة.

إذا تم تحديد نطاق واحد، فسيمثل ذلك استدعاء getActiveRange().

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var activeRangeList = sheet.getActiveRangeList();

تذكرة ذهاب وعودة

RangeList — قائمة النطاقات النشطة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

يمكن أيضًا مراجعة


getActiveSheet()

للحصول على الورقة النشطة في جدول بيانات.

الورقة النشطة في جدول بيانات هي الورقة التي يتم عرضها في واجهة مستخدم جدول البيانات.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

تذكرة ذهاب وعودة

Sheet — الورقة النشطة في جدول البيانات.


getAs(contentType)

يمكنك عرض البيانات داخل هذا الكائن كائن ثنائي كبير (blob) تم تحويله إلى نوع المحتوى المحدد. تضيف هذه الطريقة الإضافة المناسبة إلى اسم الملف—على سبيل المثال، "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' صالحًا أيضًا.

تذكرة ذهاب وعودة

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


getBandings()

لعرض جميع الأشرطة في جدول البيانات هذا.

تذكرة ذهاب وعودة

Banding[] — النطاقات في جدول البيانات هذا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getBlob()

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

تذكرة ذهاب وعودة

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


getColumnWidth(columnPosition)

للحصول على عرض بالبكسل للعمود المحدّد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerموضع العمود المطلوب فحصه.

تذكرة ذهاب وعودة

Integer — عرض العمود بالبكسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getCurrentCell()

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

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
// Returns the current highlighted cell in the one of the active ranges.
var currentCell = sheet.getCurrentCell();

تذكرة ذهاب وعودة

Range — الخلية الحالية

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataRange()

لعرض Range يتطابق مع الأبعاد التي توجد بها بيانات.

وهذا مكافئ من الناحية الوظيفية لإنشاء نطاق مقيد بواسطة A1 و((Sheet.getLastColumn(), Sheet.getLastRow()).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This represents ALL the data
var range = sheet.getDataRange();
var values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (var i = 0; i < values.length; i++) {
  var row = "";
  for (var j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = row + ",";
  }
  Logger.log(row);
}

تذكرة ذهاب وعودة

Range — نطاق يتكون من جميع البيانات في جدول البيانات

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceFormulas()

للحصول على جميع صيغ مصدر البيانات.

تذكرة ذهاب وعودة

DataSourceFormula[] — قائمة بصيغ مصادر البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourcePivotTables()

لعرض جميع الجداول المحورية لمصدر البيانات.

تذكرة ذهاب وعودة

DataSourcePivotTable[] — قائمة بالجداول المحورية لمصدر البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceRefreshSchedules()

للحصول على الجداول الزمنية للتحديث لجدول البيانات هذا.

تذكرة ذهاب وعودة

DataSourceRefreshSchedule[] — الجداول الزمنية للتحديث لجدول البيانات هذا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceSheets()

لعرض جميع أوراق مصدر البيانات في جدول البيانات.

تذكرة ذهاب وعودة

DataSourceSheet[] — مصفوفة من جميع أوراق مصدر البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSourceTables()

الحصول على جميع جداول مصدر البيانات.

تذكرة ذهاب وعودة

DataSourceTable[] — قائمة بجداول مصدر البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDataSources()

لعرض جميع مصادر البيانات في جدول البيانات.

تذكرة ذهاب وعودة

DataSource[] — مصفوفة من جميع مصادر البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getDeveloperMetadata()

الحصول على البيانات الوصفية لمطوّر البرامج المرتبطة بجدول بيانات المستوى الأعلى.

تذكرة ذهاب وعودة

DeveloperMetadata[] - البيانات الوصفية لمطوّر البرامج المرتبطة بهذا النطاق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getEditors()

للحصول على قائمة بالمحررين لهذه Spreadsheet.

تذكرة ذهاب وعودة

User[] — مصفوفة من المستخدمين الذين لديهم إذن تعديل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFormUrl()

يعرض عنوان URL للنموذج الذي يرسل ردوده إلى جدول البيانات هذا، أو null إذا كان جدول البيانات هذا لا يحتوي على نموذج مقترن. إذا أرسلت نماذج متعددة ردودًا على جدول البيانات هذا، لن يكون عنوان URL للنموذج المعروض محددًا. وبدلاً من ذلك، يمكن استرداد ارتباطات عنوان URL لكل نموذج ورقة من خلال طريقة Sheet.getFormUrl().

تذكرة ذهاب وعودة

String — عنوان URL للنموذج الذي يضع ردوده في جدول البيانات هذا، أو null إذا لم يكن هناك جدول بيانات مرتبط بجدول البيانات هذا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFrozenColumns()

لعرض عدد الأعمدة المجمدة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen columns: %s", sheet.getFrozenColumns());

تذكرة ذهاب وعودة

Integer — عدد الأعمدة المجمدة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getFrozenRows()

لعرض عدد الصفوف المجمدة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log("Number of frozen rows: %s", sheet.getFrozenRows());

تذكرة ذهاب وعودة

Integer — عدد الصفوف المجمدة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getId()

الحصول على معرّف فريد لجدول البيانات هذا. يمكن استخراج معرّف جدول البيانات من عنوان URL الخاص به. على سبيل المثال، رقم تعريف جدول البيانات في عنوان URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 هو "abc1234567".

// The code below logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

تذكرة ذهاب وعودة

String — المعرف (أو المفتاح) الفريد لجدول البيانات.


getImages()

لعرض جميع الصور فوق الشبكة في الورقة.

تذكرة ذهاب وعودة

OverGridImage[] — مصفوفة من الصور فوق الشبكة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getIterativeCalculationConvergenceThreshold()

لعرض قيمة الحد الأدنى المستخدمة أثناء الحساب المكرر. عندما تختلف نتائج العملية الحسابية المتتالية بقيمة أقل من هذه القيمة، يتوقف الحساب المكرر.

تذكرة ذهاب وعودة

Number — الحد الأدنى للتقارب.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getLastColumn()

لعرض موضع العمود الأخير الذي يتضمن محتوى.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

تذكرة ذهاب وعودة

Integer — العمود الأخير من الورقة التي تحتوي على محتوى

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getLastRow()

لعرض موضع الصف الأخير الذي يتضمن محتوى.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

تذكرة ذهاب وعودة

Integer - آخر صف في الورقة يحتوي على محتوى

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getMaxIterativeCalculationCycles()

لعرض الحد الأقصى لعدد التكرارات المطلوب استخدامها أثناء الحساب المكرر.

تذكرة ذهاب وعودة

Integer — الحد الأقصى لعدد تكرارات العمليات الحسابية.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getName()

للحصول على اسم المستند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

تذكرة ذهاب وعودة

String — اسم جدول البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getNamedRanges()

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

// The code below logs the name of the first named range.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

تذكرة ذهاب وعودة

NamedRange[] — مصفوفة من جميع النطاقات المُعنونة في جدول البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getNumSheets()

لعرض عدد الأوراق في جدول البيانات هذا.

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

تذكرة ذهاب وعودة

Integer — عدد الأوراق في جدول البيانات.


getOwner()

يعرض مالك المستند أو null لمستند في مساحة تخزين سحابي مشتركة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var owner = ss.getOwner();
Logger.log(owner.getEmail());

تذكرة ذهاب وعودة

User — مالك المستند، أو null إذا كان المستند في مساحة تخزين سحابي مشتركة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getPredefinedSpreadsheetThemes()

لعرض قائمة المظاهر المحددة مسبقًا.

// The code below returns the list of predefined themes.
var predefinedThemesList = SpreadsheetApp.getActiveSpreadsheet()
                               .getPredefinedSpreadsheetThemes();

تذكرة ذهاب وعودة

SpreadsheetTheme[] — قائمة المظاهر المحددة مسبقًا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getProtections(type)

للحصول على مصفوفة من العناصر التي تمثل جميع النطاقات أو الأوراق المحمية في جدول البيانات.

// Remove all range protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}
// Remove all sheet protections in the spreadsheet that the user has permission to edit.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

المَعلمات

الاسمالنوعالوصف
typeProtectionTypeنوع المنطقة المحمية، إما SpreadsheetApp.ProtectionType.RANGE أو SpreadsheetApp.ProtectionType.SHEET.

تذكرة ذهاب وعودة

Protection[] — مصفوفة من الكائنات التي تمثل جميع النطاقات أو الأوراق المحمية في جدول البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRange(a1Notation)

لعرض النطاق كما هو محدد في تدوين A1 أو تدوين R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

// Get cell A1 on the first sheet
var sheet = ss.getSheets()[0];
var cell = sheet.getRange("A1");

المَعلمات

الاسمالنوعالوصف
a1NotationStringالنطاق المراد عرضه، كما هو محدد في تدوين A1 أو تدوين R1C1.

تذكرة ذهاب وعودة

Range — النطاق في الموقع المحدد

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRangeByName(name)

لعرض نطاق مُعنون أو null إذا لم يتم العثور على نطاق بالاسم المحدد. إذا كانت أوراق متعددة من جدول البيانات تستخدم اسم النطاق نفسه، حدد اسم الورقة بدون علامات اقتباس إضافية — على سبيل المثال getRangeByName('TaxRates') أو getRangeByName('Sheet Name!TaxRates')، ولكن ليس getRangeByName('"Sheet Name"!TaxRates').

// Log the number of columns for the range named 'TaxRates' in the active spreadsheet.
var range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

المَعلمات

الاسمالنوعالوصف
nameStringاسم النطاق المطلوب الحصول عليه.

تذكرة ذهاب وعودة

Range — نطاق الخلايا الذي يحتوي على اسم معين.


getRangeList(a1Notations)

لعرض المجموعة RangeList التي تمثل النطاقات في الورقة نفسها المحددة من خلال قائمة غير فارغة من تدوينات A1 أو تدوينات R1C1.

// Get a list of ranges A1:D4, F1:H4.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var rangeList  = sheet.getRangeList(['A1:D4', 'F1:H4']);

المَعلمات

الاسمالنوعالوصف
a1NotationsString[]قائمة النطاقات المطلوب عرضها، على النحو المحدد في تدوين A1 أو تدوين R1C1.

تذكرة ذهاب وعودة

RangeList — قائمة النطاقات في الموقع المحدد

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRecalculationInterval()

لعرض الفاصل الزمني للحساب في جدول البيانات هذا.

تذكرة ذهاب وعودة

RecalculationInterval — الفاصل الزمني لحساب جدول البيانات هذا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getRowHeight(rowPosition)

للحصول على الارتفاع بالبكسل للصف المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerموضع الصف المراد فحصه.

تذكرة ذهاب وعودة

Integer — ارتفاع الصف بالبكسل

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSelection()

لعرض Selection الحالية في جدول البيانات.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var currentCell = selection.getCurrentCell();

تذكرة ذهاب وعودة

Selection — التحديد الحالي

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetByName(name)

لعرض ورقة تحمل الاسم المحدد.

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

// The code below logs the index of a sheet named "Expenses"
var sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName("Expenses");
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

المَعلمات

الاسمالنوعالوصف
nameStringاسم الورقة المطلوب الحصول عليها.

تذكرة ذهاب وعودة

Sheet — جدول البيانات الذي يحمل الاسم


getSheetId()

لعرض معرّف الورقة الذي يمثله هذا الكائن.

وهو معرّف للورقة يتم استخدامه بشكل فريد لجدول البيانات. المعرّف هو عدد صحيح يزيد تدريجيًا من حدّه عند تخصيص وقت إنشاء الورقة، ويكون مستقلاً عن موضع الورقة. ويعد هذا مفيدًا بالتزامن مع طرق مثل Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) التي تستخدم معلمة gridId بدلاً من مثيل Sheet.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

تذكرة ذهاب وعودة

Integer - رقم تعريف الورقة الفريدة لجدول البيانات

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetName()

لعرض اسم الورقة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

تذكرة ذهاب وعودة

String — اسم الورقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheetValues(startRow, startColumn, numRows, numColumns)

لعرض شبكة قيم مستطيلة لهذا النطاق تبدأ من الإحداثيات المحددة. قيمة -1 التي يتم تقديمها كموضع الصف أو العمود مكافئ للحصول على آخر صف أو عمود يحتوي على بيانات في الورقة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// The two samples below produce the same output
var values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

var range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

المَعلمات

الاسمالنوعالوصف
startRowIntegerتمثّل هذه السمة موضع صف البداية.
startColumnIntegerموضع عمود البداية.
numRowsIntegerعدد الصفوف المطلوب عرض القيم لها.
numColumnsIntegerعدد الأعمدة المطلوب عرض القيم لها.

تذكرة ذهاب وعودة

Object[][] — مصفوفة قيم ثنائية الأبعاد

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSheets()

لعرض كل الأوراق في جدول البيانات هذا.

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

تذكرة ذهاب وعودة

Sheet[] — مصفوفة من كل الأوراق في جدول البيانات.


getSpreadsheetLocale()

للحصول على لغة جدول البيانات.

تذكرة ذهاب وعودة

String — لغة جدول البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSpreadsheetTheme()

لعرض المظهر الحالي لجدول البيانات، أو null في حالة عدم تطبيق أي مظهر.

// The code below returns the current theme of the spreadsheet.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

تذكرة ذهاب وعودة

SpreadsheetTheme — المظهر المطبَّق الحالي.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getSpreadsheetTimeZone()

للحصول على المنطقة الزمنية لجدول البيانات.

تذكرة ذهاب وعودة

String — المنطقة الزمنية، مُحدَّدة بالتنسيق "long" (على سبيل المثال، "America/New_York"، كما هو مدرَج في Joda.org).

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getUrl()

لعرض عنوان URL لجدول البيانات المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

تذكرة ذهاب وعودة

String — عنوان URL لجدول البيانات المحدد.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

getViewers()

لعرض قائمة المشاهدين والمعلقين على Spreadsheet.

تذكرة ذهاب وعودة

User[] — مصفوفة من المستخدمين الذين لديهم إذن بعرض أو تعليق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

hideColumn(column)

لإخفاء العمود أو الأعمدة في النطاق المحدد.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange("A1");
sheet.hideColumn(range);

// This hides the first 3 columns
let range = sheet.getRange("A:C");
sheet.hideColumn(range);

المَعلمات

الاسمالنوعالوصف
columnRangeنطاق العمود المراد إخفاءه.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

hideRow(row)

لإخفاء الصفوف في النطاق المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This hides the first row
var range = sheet.getRange("A1");
sheet.hideRow(range);

المَعلمات

الاسمالنوعالوصف
rowRangeنطاق الصف المراد إخفاؤه.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertColumnAfter(afterPosition)

إدراج عمود بعد موضع العمود المحدّد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

المَعلمات

الاسمالنوعالوصف
afterPositionIntegerالعمود الذي يجب إضافة العمود الجديد بعده.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertColumnBefore(beforePosition)

إدراج عمود قبل موضع العمود المحدّد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

المَعلمات

الاسمالنوعالوصف
beforePositionIntegerالعمود الذي يجب إضافة العمود الجديد قبله.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertColumnsAfter(afterPosition, howMany)

إدراج عدد من الأعمدة بعد موضع العمود المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a column in the second column position
sheet.insertColumnsAfter(1);

المَعلمات

الاسمالنوعالوصف
afterPositionIntegerالعمود الذي يجب إضافة العمود الجديد بعده.
howManyIntegerعدد الأعمدة المراد إدراجها.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertColumnsBefore(beforePosition, howMany)

إدراج عدد من الأعمدة قبل موضع العمود المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

المَعلمات

الاسمالنوعالوصف
beforePositionIntegerالعمود الذي يجب إضافة العمود الجديد قبله.
howManyIntegerعدد الأعمدة المراد إدراجها.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertDataSourceSheet(spec)

لإدراج DataSourceSheet جديد في جدول البيانات وبدء تنفيذ البيانات. وكنتيجة جانبية، يؤدي هذا أيضًا إلى جعل الورقة الجديدة الورقة النشطة.

لعرض استثناء إذا لم يتم تفعيل نوع مصدر البيانات. يمكنك استخدام طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع محدّد من مصادر البيانات.

المَعلمات

الاسمالنوعالوصف
specDataSourceSpecمواصفات مصدر البيانات للإدراج معها.

تذكرة ذهاب وعودة

DataSourceSheet — ورقة مصدر البيانات الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertImage(blobSource, column, row)

لإدراج Spreadsheet كصورة في المستند في صف وعمود معيّنين. يتم استرداد حجم الصورة من محتوى الكائنات الثنائية الكبيرة. الحد الأقصى لحجم الكائن الثنائي الكبير (blob) هو 2 ميغابايت.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

المَعلمات

الاسمالنوعالوصف
blobSourceBlobSourceالكائنات الثنائية الكبيرة (blob) التي تحتوي على محتويات الصورة ونوع MIME واسم (اختياري).
columnIntegerموضع العمود.
rowIntegerموضع الصف.

تذكرة ذهاب وعودة

OverGridImage — الصورة التي تم إدراجها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertImage(blobSource, column, row, offsetX, offsetY)

لإدراج Spreadsheet كصورة في المستند في صف وعمود معيّنين، مع إزاحة للبكسل. ويتم استرداد حجم الصورة من محتوى الكائنات الثنائية الكبيرة. الحد الأقصى لحجم الكائن الثنائي الكبير (blob) هو 2 ميغابايت.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

المَعلمات

الاسمالنوعالوصف
blobSourceBlobSourceالكائنات الثنائية الكبيرة (blob) التي تحتوي على محتويات الصورة ونوع MIME واسم (اختياري).
columnIntegerموضع العمود.
rowIntegerموضع الصف.
offsetXIntegerالإزاحة الأفقية من زاوية الخلية بالبكسل.
offsetYIntegerالإزاحة العمودية من زاوية الخلية بالبكسل.

تذكرة ذهاب وعودة

OverGridImage — الصورة التي تم إدراجها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertImage(url, column, row)

يدرج صورة في المستند في صف وعمود معينين.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1);

المَعلمات

الاسمالنوعالوصف
urlStringعنوان URL للصورة
columnIntegerموضع عمود الشبكة.
rowIntegerموضع صف الشبكة.

تذكرة ذهاب وعودة

OverGridImage — الصورة التي تم إدراجها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertImage(url, column, row, offsetX, offsetY)

يدرج صورة في المستند في صف وعمود معين، مع إزاحة للبكسل.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.insertImage("https://www.google.com/images/srpr/logo3w.png", 1, 1, 10, 10);

المَعلمات

الاسمالنوعالوصف
urlStringعنوان URL للصورة.
columnIntegerموضع العمود.
rowIntegerموضع الصف.
offsetXIntegerالإزاحة الأفقية من زاوية الخلية بالبكسل.
offsetYIntegerالإزاحة العمودية من زاوية الخلية بالبكسل.

تذكرة ذهاب وعودة

OverGridImage — الصورة التي تم إدراجها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertRowAfter(afterPosition)

إدراج صف بعد موضع الصف المحدّد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

المَعلمات

الاسمالنوعالوصف
afterPositionIntegerالصف الذي يجب إضافة الصف الجديد بعده.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertRowBefore(beforePosition)

لإدراج صف قبل موضع الصف المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

المَعلمات

الاسمالنوعالوصف
beforePositionIntegerالصف الذي يجب إضافة الصف الجديد قبله.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertRowsAfter(afterPosition, howMany)

إدراج عدد من الصفوف بعد موضع الصف المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

المَعلمات

الاسمالنوعالوصف
afterPositionIntegerالصف الذي يجب إضافة الصفوف الجديدة بعدها.
howManyIntegerعدد الصفوف المراد إدراجها.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertRowsBefore(beforePosition, howMany)

إدراج عدد من الصفوف قبل موضع الصف المحدد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

المَعلمات

الاسمالنوعالوصف
beforePositionIntegerالصف الذي يجب إضافة الصفوف الجديدة قبله.
howManyIntegerعدد الصفوف المراد إدراجها.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheet()

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheet(sheetIndex)

إدراج ورقة جديدة في جدول البيانات في الفهرس المحدد. تصبح الورقة الجديدة الورقة النشطة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

المَعلمات

الاسمالنوعالوصف
sheetIndexIntegerفهرس الورقة التي تم إنشاؤها حديثًا. لإدراج ورقة كأول ورقة في جدول البيانات، اضبطها على 0.

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheet(sheetIndex, options)

لإدراج ورقة جديدة في جدول البيانات في الفهرس المحدد واستخدام وسيطات اختيارية اختيارية. تصبح الورقة الجديدة الورقة النشطة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

المَعلمات

الاسمالنوعالوصف
sheetIndexIntegerفهرس الورقة التي تم إنشاؤها حديثًا. لإدراج ورقة كأول ورقة في جدول البيانات، اضبطها على 0.
optionsObjectوسيطات جافا سكريبت اختيارية اختيارية.

المعلمات المتقدمة

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

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheet(options)

لإدراج ورقة جديدة في جدول البيانات، باستخدام اسم ورقة افتراضية ووسيطات متقدمة اختيارية. تصبح الورقة الجديدة الورقة النشطة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

المَعلمات

الاسمالنوعالوصف
optionsObjectوسيطات اختيارية متقدمة لجافا سكريبت، مدرجة أدناه.

المعلمات المتقدمة

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

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheet(sheetName)

لإدراج ورقة جديدة في جدول البيانات باستخدام الاسم المحدد. تصبح الورقة الجديدة الورقة النشطة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

المَعلمات

الاسمالنوعالوصف
sheetNameStringاسم الورقة الجديدة.

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheet(sheetName, sheetIndex)

إدراج ورقة جديدة في جدول البيانات مع تحديد الاسم نفسه في الفهرس المحدد. تصبح الورقة الجديدة الورقة النشطة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

المَعلمات

الاسمالنوعالوصف
sheetNameStringاسم الورقة الجديدة.
sheetIndexIntegerفهرس الورقة التي تم إنشاؤها حديثًا. لإدراج ورقة كأول ورقة في جدول البيانات، اضبطها على 0.

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheet(sheetName, sheetIndex, options)

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

المَعلمات

الاسمالنوعالوصف
sheetNameStringاسم الورقة الجديدة.
sheetIndexIntegerفهرس الورقة المدرجة حديثًا. لإدراج ورقة كأول ورقة في جدول البيانات، اضبطها على 0.
optionsObjectوسيطات جافا سكريبت اختيارية اختيارية.

المعلمات المتقدمة

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

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheet(sheetName, options)

لإدراج ورقة جديدة في جدول البيانات بالاسم المحدد واستخدام الوسيطات المتقدمة الاختيارية. تصبح الورقة الجديدة الورقة النشطة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

المَعلمات

الاسمالنوعالوصف
sheetNameStringاسم الورقة الجديدة.
optionsObjectوسيطات جافا سكريبت اختيارية اختيارية.

المعلمات المتقدمة

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

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

insertSheetWithDataSourceTable(spec)

لإدراج ورقة جديدة في جدول البيانات، وإنشاء DataSourceTable عبر الورقة بأكملها مع مواصفات مصدر البيانات المحددة، وبدء تنفيذ البيانات. كتأثير جانبي، تجعل الورقة الجديدة الورقة النشطة.

لعرض استثناء إذا لم يتم تفعيل نوع مصدر البيانات. يمكنك استخدام طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع محدّد من مصادر البيانات.

المَعلمات

الاسمالنوعالوصف
specDataSourceSpecمواصفات مصدر البيانات للإدراج معها.

تذكرة ذهاب وعودة

Sheet — الورقة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isColumnHiddenByUser(columnPosition)

لعرض ما إذا كان العمود المعني مخفيًا بواسطة المستخدم.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerموضع العمود المطلوب فحصه.

تذكرة ذهاب وعودة

Booleantrue إذا كان العمود مخفيًا، false.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isIterativeCalculationEnabled()

لعرض ما إذا كان الحساب المكرر مفعّلاً في جدول البيانات هذا أم لا.

تذكرة ذهاب وعودة

Booleantrue في حال تفعيل الحساب المكرر، false في الحالات الأخرى.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isRowHiddenByFilter(rowPosition)

لعرض ما إذا كان الصف المحدد مخفيًا من خلال فلتر (وليس عرض فلتر).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerموضع الصف المراد فحصه.

تذكرة ذهاب وعودة

Booleantrue إذا كان الصف مخفيًا، false وإلا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

isRowHiddenByUser(rowPosition)

لعرض ما إذا كان الصف المحدد مخفيًا بواسطة المستخدم.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerموضع الصف المراد فحصه.

تذكرة ذهاب وعودة

Booleantrue إذا كان الصف مخفيًا، false وإلا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveActiveSheet(pos)

لنقل الورقة النشطة إلى الموضع المحدد في قائمة الأوراق. لعرض استثناء إذا كان الموضع سالبًا أو أكبر من عدد الأوراق.

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named "second"
// in position 2.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

// Logs 'Current index of sheet: 1'
console.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log("New index of sheet: %s", sheet.getIndex());

المَعلمات

الاسمالنوعالوصف
posIntegerموضع الفهرس 1 لنقل الورقة النشطة إليه في قائمة الأوراق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

moveChartToObjectSheet(chart)

لإنشاء ورقة SheetType.OBJECT جديدة ونقل الرسم البياني المتوفر إليها. إذا كان المخطط موجودًا بالفعل على جدول بيانات خاص به، سيتم عرض هذه الورقة بدون إنشاء جدول بيانات جديد.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

المَعلمات

الاسمالنوعالوصف
chartEmbeddedChartالمخطط المراد نقله.

تذكرة ذهاب وعودة

Sheet — الورقة التي تم تشغيل الرسم البياني بها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

refreshAllDataSources()

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

يمكنك استخدام طرق SpreadsheetApp#enable...Execution() لتفعيل تنفيذ البيانات لنوع محدّد من مصادر البيانات.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeEditor(emailAddress)

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

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeEditor(user)

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

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet، للسلسلة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeMenu(name)

إزالة قائمة أضافها addMenu(name, subMenus). يجب أن يكون للوسيطة name نفس قيمة الاستدعاء المقابل لـ addMenu(name, subMenus).

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

المَعلمات

الاسمالنوعالوصف
nameStringاسم القائمة المطلوب إزالتها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeNamedRange(name)

لحذف نطاق مُعنون بالاسم نفسه. لعرض استثناء إذا لم يتم العثور على نطاق بالاسم المحدد في جدول البيانات.

// The code below creates a new named range "foo", and then remove it.
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("foo", ss.getActiveRange());
ss.removeNamedRange("foo");

المَعلمات

الاسمالنوعالوصف
nameStringاسم النطاق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeViewer(emailAddress)

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

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet للتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

removeViewer(user)

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

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

المَعلمات

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

تذكرة ذهاب وعودة

Spreadsheet — هذا Spreadsheet للتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

rename(newName)

لإعادة تسمية المستند.

var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename("This is the new name");

المَعلمات

الاسمالنوعالوصف
newNameStringالاسم الجديد للمستند.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

renameActiveSheet(newName)

إعادة تسمية الورقة النشطة الحالية إلى الاسم الجديد المحدد.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet("Hello world");

المَعلمات

الاسمالنوعالوصف
newNameStringالاسم الجديد للورقة النشطة الحالية.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

resetSpreadsheetTheme()

إزالة المظهر الذي تم تطبيقه وتعيين المظهر التلقائي في جدول البيانات.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

تذكرة ذهاب وعودة

SpreadsheetTheme — المظهر التلقائي.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setActiveRange(range)

لتعيين النطاق المحدد على active range في الورقة النشطة، مع وضع الخلية أعلى اليمين في النطاق كـ current cell.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

var selection = sheet.getSelection();
// Current cell: A1
var currentCell = selection.getCurrentCell();
// Active Range: A1:D4
var activeRange = selection.getActiveRange();

المَعلمات

الاسمالنوعالوصف
rangeRangeالنطاق المراد تعيينه كنطاق نشط.

تذكرة ذهاب وعودة

Range — النطاق النشط حديثًا

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setActiveRangeList(rangeList)

تُحدِّد هذه السياسة قائمة النطاقات المحدَّدة على أنها active ranges في الورقة النشطة. تم ضبط النطاق الأخير في القائمة على أنه active range.

var sheet = SpreadsheetApp.getActiveSheet();
var rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

var selection = sheet.getSelection();
// Current cell: B2
var currentCell = selection.getCurrentCell();
// Active range: B2:C4
var activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
var activeRangeList = selection.getActiveRangeList();

المَعلمات

الاسمالنوعالوصف
rangeListRangeListقائمة النطاقات المراد تحديدها

تذكرة ذهاب وعودة

RangeList — قائمة النطاقات المختارة حديثًا

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setActiveSelection(range)

لتعيين منطقة التحديد النشطة لهذه الورقة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

المَعلمات

الاسمالنوعالوصف
rangeRangeالنطاق المراد تحديده كاختيار نشط.

تذكرة ذهاب وعودة

Range — النطاق النشط حديثًا

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setActiveSelection(a1Notation)

لتعيين التحديد النشط، كما هو محدد في تدوين A1 أو تدوين R1C1.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

sheet.setActiveSelection("A1:D4");

المَعلمات

الاسمالنوعالوصف
a1NotationStringالنطاق المراد تعيينه كنشط، كما هو محدد في تدوين A1 أو تدوين R1C1.

تذكرة ذهاب وعودة

Range — النطاق النشط حديثًا

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setActiveSheet(sheet)

لتعيين الورقة المحددة لتكون الورقة النشطة في جدول البيانات. تعرض واجهة مستخدم جداول بيانات Google الورقة المختارة ما لم تكن الورقة تابعة لجدول بيانات مختلف.

// The code below makes the first sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

المَعلمات

الاسمالنوعالوصف
sheetSheetالورقة المطلوب تعيينها كورقة نشطة.

تذكرة ذهاب وعودة

Sheet — الورقة النشطة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setActiveSheet(sheet, restoreSelection)

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var firstSheet = spreadsheet.getSheets()[0];
var secondSheet = spreadsheet.getSheets()[1];
// Set the first sheet as the active sheet and select the range D4:F4.
spreadsheet.setActiveSheet(firstSheet).getRange('D4:F4').activate();

// Switch to the second sheet to do some work.
spreadsheet.setActiveSheet(secondSheet);
// Switch back to first sheet, and restore its selection.
spreadsheet.setActiveSheet(firstSheet, true);

// The selection of first sheet is restored, and it logs D4:F4
var range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

المَعلمات

الاسمالنوعالوصف
sheetSheetالورقة النشطة الجديدة.
restoreSelectionBooleanعند اختيار true، يصبح أحدث اختيار للورقة النشطة الجديدة محددًا مرة أخرى عندما تصبح الورقة الجديدة نشطة، وإذا كانت false، تصبح الورقة الجديدة نشطة بدون تغيير الاختيار الحالي.

تذكرة ذهاب وعودة

Sheet — الورقة النشطة الجديدة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setColumnWidth(columnPosition, width)

لتعيين عرض العمود المعين بالبكسل.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerموضع العمود المحدّد المطلوب ضبطه.
widthIntegerالعرض بالبكسل لضبطه.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setCurrentCell(cell)

لتعيين الخلية المحددة إلى current cell.

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

إذا كانت الخلية المحددة غير موجودة في أي نطاق محدد، تتم إزالة أي تحديد حالي وتصبح الخلية الخلية الحالية والنطاق النشط.

ملاحظة: يجب أن تتألّف قيمة Range المحدّدة من خلية واحدة، وإلا سيتم عرض استثناء.

var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

var selection = sheet.getSelection();
// Current cell: B5
var currentCell = selection.getCurrentCell();

المَعلمات

الاسمالنوعالوصف
cellRangeالخلية المراد تعيينها كخلية حالية.

تذكرة ذهاب وعودة

Range — الخلية الحالية المحدّدة حديثًا

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFrozenColumns(columns)

تجميد عدد معين من الأعمدة. إذا كان صفرًا، فلن يتم تجميد أي أعمدة.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

المَعلمات

الاسمالنوعالوصف
columnsIntegerعدد الأعمدة المطلوب تجميدها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setFrozenRows(rows)

تجميد عدد معين من الصفوف. إذا كان صفرًا، لن يتم تجميد أي صفوف.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

المَعلمات

الاسمالنوعالوصف
rowsIntegerعدد الصفوف المطلوب تجميدها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setIterativeCalculationConvergenceThreshold(minThreshold)

لتعيين الحد الأدنى لقيمة الحساب المكرر. عندما تختلف نتائج العملية الحسابية المتتالية بقيمة أقل من هذه القيمة، يتوقف الحساب المكرر. ويجب أن تكون هذه القيمة غير سالبة، ويتم تعيينها تلقائيًا على 0.05.

المَعلمات

الاسمالنوعالوصف
minThresholdNumberالحد الأدنى للتقارب (يجب أن يكون غير سالب).

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setIterativeCalculationEnabled(isEnabled)

لتحديد ما إذا كان سيتم تفعيل الحساب المكرر في جدول البيانات هذا أم لا. إذا لم يتم تعيين الحد الأقصى لدورات العملية الحسابية والحد الأدنى للتقارب من قبل عند تمكين الحساب، فيكون الإعداد الافتراضي 50 و0.05 على التوالي. وإذا تم تعيين أي منهما سابقًا، فإنهما يحتفظان بالقيم السابقة.

المَعلمات

الاسمالنوعالوصف
isEnabledBooleantrue في حال تفعيل الحساب المكرر، false في الحالات الأخرى

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setMaxIterativeCalculationCycles(maxIterations)

لتعيين الحد الأقصى لعدد تكرارات العمليات الحسابية التي يجب تنفيذها أثناء الحساب المكرر. ويجب أن تتراوح هذه القيمة بين 1 و10,000 (بما في ذلك القيم الواقعة بينهما)، وأن يتم ضبطها تلقائيًا على 50.

المَعلمات

الاسمالنوعالوصف
maxIterationsIntegerالحد الأقصى لعدد تكرارات العمليات الحسابية (بين 1 و10,000).

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setNamedRange(name, range)

لتسمية نطاق.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange("TaxRates", SpreadsheetApp.getActiveRange());

المَعلمات

الاسمالنوعالوصف
nameStringالاسم المطلوب إعطاء النطاق.
rangeRangeمواصفات النطاق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRecalculationInterval(recalculationInterval)

لتعيين عدد مرات إعادة حساب جدول البيانات هذا.

المَعلمات

الاسمالنوعالوصف
recalculationIntervalRecalculationIntervalالفاصل الزمني الجديد لإعادة الحساب.

تذكرة ذهاب وعودة

Spreadsheet — جدول البيانات هذا، لتسلسل.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setRowHeight(rowPosition, height)

لتعيين ارتفاع الصف بالبكسل المحدد بالبكسل. تلقائيًا، تنمو الصفوف لتلائم محتويات الخلية. إذا كنت ترغب في فرض صفوف على ارتفاع معين، فاستخدم Sheet.setRowHeightsForced(startRow, numRows, height).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

المَعلمات

الاسمالنوعالوصف
rowPositionIntegerموضع الصف المراد تغييره.
heightIntegerالارتفاع بالبكسل المطلوب تعيينه.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSpreadsheetLocale(locale)

لتعيين لغة جدول البيانات.

المَعلمات

الاسمالنوعالوصف
localeStringرمز اللغة المطلوب استخدامه (على سبيل المثال، "en" أو "fr" أو "en_US").

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSpreadsheetTheme(theme)

لضبط مظهر في جدول البيانات.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the spreadsheet.
var predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

المَعلمات

الاسمالنوعالوصف
themeSpreadsheetThemeالمظهر المراد تطبيقه.

تذكرة ذهاب وعودة

SpreadsheetTheme — المظهر الحالي الجديد.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

setSpreadsheetTimeZone(timezone)

لتعيين المنطقة الزمنية لجدول البيانات.

المَعلمات

الاسمالنوعالوصف
timezoneStringالمنطقة الزمنية المحدّدة بالتنسيق "long" (على سبيل المثال، "America/New_York" كما هو مُدرَج في Joda.org).

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

show(userInterface)

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

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

يعرض مقتطف الرمز التالي تطبيق HtmlService بسيطًا في مربع حوار يتضمن العنوان والارتفاع والعرض المحددين:

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

المَعلمات

الاسمالنوعالوصف
userInterfaceObjectHtmlOutput.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/script.container.ui

sort(columnPosition)

لترتيب ورقة حسب العمود، تصاعديًا.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerالعمود المطلوب الفرز حسبه.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

sort(columnPosition, ascending)

لترتيب ورقة حسب العمود. يتم استخدام معلّمة لتحديد تصاعدي أو تنازلي.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

المَعلمات

الاسمالنوعالوصف
columnPositionIntegerالعمود المطلوب الفرز حسبه.
ascendingBooleantrue للترتيبات التصاعدية، وfalse للترتيب التنازلي.

تذكرة ذهاب وعودة

Sheet — الورقة، مفيدة لتسلسل الطريقة

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

toast(msg)

يعرض نافذة منبثقة في الجانب السفلي الأيسر من جدول البيانات بالرسالة المحددة.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

المَعلمات

الاسمالنوعالوصف
msgStringالرسالة التي سيتم عرضها في الإشعار المنبثق.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

toast(msg, title)

يعرض نافذة منبثقة في الجانب السفلي الأيسر من جدول البيانات تتضمن الرسالة والعنوان.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

المَعلمات

الاسمالنوعالوصف
msgStringالرسالة التي سيتم عرضها في الإشعار المنبثق.
titleStringالعنوان الاختياري للخبز المحمص.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

toast(msg, title, timeoutSeconds)

لعرض نافذة منبثقة أسفل الجانب الأيسر من جدول البيانات تحتوي على العنوان والرسالة المحدّدَين، وتبقى مرئية لفترة زمنية محدّدة.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

المَعلمات

الاسمالنوعالوصف
msgStringالرسالة التي سيتم عرضها في الإشعار المنبثق.
titleStringالعنوان الاختياري للخبز المحمص.
timeoutSecondsNumberالمهلة بالثواني، وفي حال ضبط قيمة null على قيمة الخبز المحمّلة تلقائيًا على 5 ثوانٍ إذا كانت قيمة السالب باقية، تبقى الخبز المحمّل إلى أن يتم تجاهلها.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

unhideColumn(column)

لإظهار العمود في النطاق المعين.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideColumn(range);

المَعلمات

الاسمالنوعالوصف
columnRangeالنطاق المراد إظهاره، إذا كان مخفيًا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

unhideRow(row)

لإظهار الصف في النطاق المعين.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
var range = sheet.getRange("A1");
sheet.unhideRow(range);

المَعلمات

الاسمالنوعالوصف
rowRangeالنطاق المراد إظهاره، إذا كان مخفيًا.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

updateMenu(name, subMenus)

تحديث قائمة تمت إضافتها بواسطة addMenu(name, subMenus). يعمل تمامًا مثل addMenu(name, subMenus).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var menuEntries = [];
menuEntries.push({name: "Lone Menu Entry", functionName: "function1"});
ss.updateMenu("addMenuExample", menuEntries);

المَعلمات

الاسمالنوعالوصف
nameStringاسم القائمة المراد تحديثها.
subMenusObject[]مصفوفة من خرائط JavaScript مع معلّمتَي name وfunctionName . يمكنك استخدام وظائف من المكتبات المضمّنة، مثل Library.libFunction1.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

waitForAllDataExecutionsCompletion(timeoutInSeconds)

الانتظار حتى تكتمل جميع عمليات التنفيذ الحالية في جدول البيانات، بحيث تنتهي المهلة بعد عدد الثواني المقدَّم. يتم استثناء استثناء في حال عدم اكتمال عمليات التنفيذ عند انتهاء المهلة، بدون إلغاء عمليات تنفيذ البيانات.

المَعلمات

الاسمالنوعالوصف
timeoutInSecondsIntegerالوقت المستغرق في انتظار تنفيذ البيانات، بالثواني. الحد الأقصى هو 300 ثانية.

التفويض

تتطلب النصوص البرمجية التي تستخدم هذه الطريقة تفويضًا باستخدام واحد أو أكثر من النطاقات التالية:

  • https://www.googleapis.com/auth/spreadsheets.currentonly
  • https://www.googleapis.com/auth/spreadsheets

الطرق المتوقّفة