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/Sheets/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;quot; (على سبيل المثال، "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). الحد الأقصى لحجم الكائن الثنائي الكبير (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). الحد الأقصى المسموح به لحجم الكائن الثنائي الكبير (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وسيطات JavaScript اختيارية اختيارية.

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

الاسمالنوعالوصف
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تتوفّر وسيطات JavaScript المتقدّمة الاختيارية أدناه.

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

الاسمالنوعالوصف
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وسيطات JavaScript اختيارية اختيارية.

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

الاسمالنوعالوصف
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وسيطات JavaScript اختيارية اختيارية.

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

الاسمالنوعالوصف
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 there are two sheets in the current
// active spreadsheet: one named "first", and another named "second",
// and that the current active sheet (first) is in position 1
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
var sheet = spreadsheet.getSheetByName("first");

// This should output 'Current index of sheet: 1'
Logger.log("Current index of sheet: %s", sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// This should output 'New index of sheet: 2'
Logger.log("New index of sheet: %s", sheet.getIndex());

المعلّمات

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

التفويض

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

  • 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

الطرق التي تم إيقافها نهائيًا