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	تنشئ هذه الدالة قائمة جديدة في واجهة مستخدم "جداول بيانات Google".
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	لعرض البيانات داخل هذا العنصر ككائن ثنائي كبير تم تحويله إلى نوع المحتوى المحدّد
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 الحالي في جدول البيانات.
getSheetById(id)	Sheet	تعرض هذه الطريقة الورقة التي تحمل رقم التعريف المحدّد.
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	ينتظر إلى أن تكتمل جميع عمليات التنفيذ الحالية في جدول البيانات، مع انتهاء المهلة بعد عدد الثواني المحدّد.

الطُرق المتوقّفة

الطريقة	نوع القيمة التي يتم إرجاعها	وصف قصير
getSheetProtection()	PageProtection	تعرض هذه الدالة مثيلاً من PageProtection يصف أذونات الورقة الحالية.
isAnonymousView()	Boolean	تشير هذه السمة إلى ما إذا كان المستند يسمح بالعرض بدون تسجيل الدخول.
isAnonymousWrite()	Boolean	تشير إلى ما إذا كان المستند يسمح بإجراء تعديلات من مستخدمين مجهولين.
setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)	void	تضبط هذه السمة سياسة المستند بشأن القراءة والكتابة بدون الكشف عن الهوية.
setSheetProtection(permissions)	void	تضبط هذه السمة أذونات الوصول إلى ورقة البيانات الحالية.

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

addDeveloperMetadata(key)

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME');

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

المعلمات

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

الإرجاع

Spreadsheet: جدول البيانات هذا، ويُستخدم في الربط.

التفويض

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

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

---

addDeveloperMetadata(key, visibility)

تضيف هذه الدالة بيانات وصفية للمطوّر تتضمّن المفتاح ومستوى الظهور المحدّدَين إلى جدول البيانات.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets
// the visibility to the developer project that created the metadata.
ss.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

// Gets the first developer metadata object and logs its key and visibility
// setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

المعلمات

الاسم	النوع	الوصف
key	String	مفتاح البيانات الوصفية الجديدة للمطوّر
visibility	DeveloperMetadataVisibility	مستوى ظهور البيانات الوصفية الجديدة للمطوّر

الإرجاع

Spreadsheet: جدول البيانات هذا، ويُستخدم في الربط.

التفويض

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

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

---

addDeveloperMetadata(key, value)

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata
// for the spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(
    `Key: ${developerMetaData.getKey()}, Value: ${
        developerMetaData.getValue()}`,
);

المعلمات

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

الإرجاع

Spreadsheet: جدول البيانات هذا، ويُستخدم في الربط.

التفويض

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

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

---

addDeveloperMetadata(key, value, visibility)

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata(
    'NAME',
    'GOOGLE',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

// Gets the first developer metadata object and logs its key, value, and
// visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

المعلمات

الاسم	النوع	الوصف
key	String	مفتاح البيانات الوصفية الجديدة للمطوّر
value	String	قيمة البيانات الوصفية الجديدة للمطوّر.
visibility	DeveloperMetadataVisibility	مستوى ظهور البيانات الوصفية الجديدة للمطوّر

الإرجاع

Spreadsheet: جدول البيانات هذا، ويُستخدم في الربط.

التفويض

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

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

---

addEditor(emailAddress)

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

المعلمات

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

الإرجاع

Spreadsheet: هذا Spreadsheet، يُستخدَم للربط.

التفويض

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

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

---

addEditor(user)

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

المعلمات

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

الإرجاع

Spreadsheet: هذا Spreadsheet، يُستخدَم للربط.

التفويض

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

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

---

addEditors(emailAddresses)

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

المعلمات

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

الإرجاع

Spreadsheet: هذا Spreadsheet، يُستخدَم للربط.

التفويض

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

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

---

addMenu(name, subMenus)

تنشئ هذه الدالة قائمة جديدة في واجهة مستخدم "جداول بيانات Google".

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

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const 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);
}

المعلمات

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

التفويض

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

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

---

addViewer(emailAddress)

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

المعلمات

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

الإرجاع

Spreadsheet: هذا Spreadsheet، يُستخدَم للربط.

التفويض

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

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

---

addViewer(user)

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

المعلمات

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

الإرجاع

Spreadsheet: هذا Spreadsheet، يُستخدَم للربط.

التفويض

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

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

---

addViewers(emailAddresses)

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

المعلمات

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

الإرجاع

Spreadsheet: هذا Spreadsheet، يُستخدَم للربط.

التفويض

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

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

---

appendRow(rowContents)

يُلحق هذا الإجراء صفًا بأسفل منطقة البيانات الحالية في ورقة البيانات. إذا كان محتوى الخلية يبدأ بـ =، سيتم تفسيره على أنّه صيغة.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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']);

المعلمات

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

الإرجاع

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

التفويض

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

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

---

autoResizeColumn(columnPosition)

تضبط هذه السمة عرض العمود المحدّد ليتناسب مع محتواه.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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);

المعلمات

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

الإرجاع

‫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
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy(`Copy of ${ss.getName()}`);

المعلمات

الاسم	النوع	الوصف
name	String	تمثّل هذه السمة اسم النسخة.

الإرجاع

Spreadsheet: جدول البيانات هذا، ويُستخدم في الربط.

التفويض

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

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

---

createDeveloperMetadataFinder()

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet =
    developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and
// logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

الإرجاع

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

---

createTextFinder(findText)

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

المعلمات

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

الإرجاع

TextFinder: TextFinder لجدول البيانات

---

deleteActiveSheet()

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

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

الإرجاع

Sheet: ورقة البيانات النشطة الجديدة

التفويض

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

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

---

deleteColumn(columnPosition)

تحذف هذه الدالة العمود في موضع العمود المحدّد.

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

المعلمات

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

الإرجاع

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

التفويض

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

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

---

deleteColumns(columnPosition, howMany)

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

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

المعلمات

الاسم	النوع	الوصف
columnPosition	Integer	موضع العمود الأول المطلوب حذفه
howMany	Integer	عدد الأعمدة المطلوب حذفها.

التفويض

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

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

---

deleteRow(rowPosition)

يحذف هذا الإجراء الصف في موضع الصف المحدّد.

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

المعلمات

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

الإرجاع

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

التفويض

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

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

---

deleteRows(rowPosition, howMany)

تحذف هذه الطريقة عددًا من الصفوف بدءًا من موضع الصف المحدّد.

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

المعلمات

الاسم	النوع	الوصف
rowPosition	Integer	موضع الصف الأول المطلوب حذفه
howMany	Integer	عدد الصفوف المطلوب حذفها.

التفويض

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

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

---

deleteSheet(sheet)

تحذف هذه الدالة ورقة البيانات المحدّدة.

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

المعلمات

الاسم	النوع	الوصف
sheet	Sheet	ورقة البيانات المطلوب حذفها

التفويض

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

• 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()، الذي يعرض الخلية المحدّدة حاليًا.

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

الإرجاع

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

التفويض

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

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

---

getActiveRange()

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

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

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

الإرجاع

‫Range: النطاق النشط

التفويض

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

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

انظر أيضًا

• setActiveRange(range)

---

getActiveRangeList()

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

إذا تم اختيار نطاق واحد، سيتصرف هذا النطاق مثل طلب getActiveRange().

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

الإرجاع

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

التفويض

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

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

انظر أيضًا

• setActiveRangeList(rangeList)

---

getActiveSheet()

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

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

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

الإرجاع

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

---

getAs(contentType)

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

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

المعلمات

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

الإرجاع

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

---

getBandings()

تعرِض هذه الدالة جميع الفئات في جدول البيانات هذا.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

الإرجاع

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

التفويض

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

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

---

getBlob()

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

الإرجاع

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

---

getColumnWidth(columnPosition)

تعرض هذه الدالة عرض العمود المحدّد بالبكسل.

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

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

المعلمات

الاسم	النوع	الوصف
columnPosition	Integer	تمثّل هذه السمة موضع العمود المطلوب فحصه.

الإرجاع

Integer: تمثّل عرض العمود بالبكسل.

التفويض

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

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

---

getCurrentCell()

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

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

الإرجاع

Range: الخلية الحالية

التفويض

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

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

---

getDataRange()

تعرِض Range تتوافق مع السمات التي تتوفّر فيها البيانات.

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

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

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

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let 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()

تعرض هذه الطريقة جميع صيغ مصادر البيانات.

// Opens the spreadsheet by its ID. If you created your script from within a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

الإرجاع

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

التفويض

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

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

---

getDataSourcePivotTables()

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

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

الإرجاع

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

التفويض

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

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

---

getDataSourceRefreshSchedules()

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                          .getFrequency()
                          .getFrequencyType()
                          .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

الإرجاع

DataSourceRefreshSchedule[]: الجداول الزمنية لإعادة تحميل جدول البيانات هذا.

التفويض

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

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

---

getDataSourceSheets()

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

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

الإرجاع

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

التفويض

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

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

---

getDataSourceTables()

تعرض هذه الطريقة جميع جداول مصادر البيانات.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

الإرجاع

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

التفويض

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

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

---

getDataSources()

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

// Turns data execution on for BigQuery data sources.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

الإرجاع

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

التفويض

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

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

---

getDeveloperMetadata()

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the
// console.
console.log(ssMetadata[0].getKey());

الإرجاع

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(). يطرح هذا الرمز خطأً إذا لم يكن لدى المستخدم إذن بتعديل جدول البيانات.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

الإرجاع

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

التفويض

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

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

---

getFrozenColumns()

تعرض هذه السمة عدد الأعمدة المجمّدة.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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()

تعرض هذه السمة عدد الصفوف المجمّدة.

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

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

الإرجاع

Integer: عدد الصفوف المجمّدة

التفويض

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

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

---

getId()

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

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

الإرجاع

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

---

getImages()

تعرِض هذه الدالة جميع الصور التي تقع خارج الشبكة في ورقة الجدول.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use
// ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
  console.log(image.getAnchorCell().getA1Notation());
}

الإرجاع

OverGridImage[]: مصفوفة من الصور التي تظهر على سطح الشبكة

التفويض

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

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

---

getIterativeCalculationConvergenceThreshold()

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

الإرجاع

Number: الحدّ الأدنى للتقارب

التفويض

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

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

---

getLastColumn()

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

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

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

الإرجاع

Integer: هو آخر عمود في ورقة البيانات يحتوي على محتوى.

التفويض

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

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

---

getLastRow()

تعرِض هذه الدالة موضع الصف الأخير الذي يتضمّن محتوًى.

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

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

الإرجاع

Integer: يشير إلى آخر صف في ورقة البيانات يحتوي على محتوى.

التفويض

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

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

---

getMaxIterativeCalculationCycles()

تعرض هذه السمة الحد الأقصى لعدد التكرارات التي سيتم استخدامها أثناء الاحتساب المكرّر.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

الإرجاع

‫Integer: الحد الأقصى لعدد تكرارات الحساب.

التفويض

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

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

---

getName()

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

const 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.
const namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (let 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 إذا كان المستند في مساحة تخزين سحابي مشتركة.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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.
const 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.
const ss = SpreadsheetApp.getActive();
const protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

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

المعلمات

الاسم	النوع	الوصف
type	ProtectionType	تمثّل هذه السمة نوع المنطقة المحمية، إما 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"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

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

المعلمات

الاسم	النوع	الوصف
a1Notation	String	النطاق المطلوب عرضه، كما هو محدّد في ترميز 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.
const range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

المعلمات

الاسم	النوع	الوصف
name	String	اسم النطاق المطلوب الحصول عليه

الإرجاع

Range: نطاق الخلايا الذي يحمل الاسم المحدّد.

---

getRangeList(a1Notations)

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

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

المعلمات

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

الإرجاع

RangeList: قائمة النطاقات في الموقع الجغرافي المحدّد

التفويض

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

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

---

getRecalculationInterval()

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

الإرجاع

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

التفويض

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

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

---

getRowHeight(rowPosition)

تعرض هذه الدالة ارتفاع الصف المحدّد بالبكسل.

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

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

المعلمات

الاسم	النوع	الوصف
rowPosition	Integer	تمثّل هذه السمة موضع الصف المطلوب فحصه.

الإرجاع

Integer: تمثّل ارتفاع الصف بالبكسل.

التفويض

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

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

---

getSelection()

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

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

الإرجاع

‫Selection: التحديد الحالي

التفويض

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

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

---

getSheetById(id)

تعرض هذه الطريقة الورقة التي تحمل رقم التعريف المحدّد. استخدم Sheet.getSheetId().

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetById(12345);

المعلمات

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

الإرجاع

‫Sheet: الورقة التي تحمل رقم التعريف المحدّد أو null إذا لم يتم العثور على أي ورقة.

---

getSheetByName(name)

تعرض هذه الدالة ورقة بالاسم المحدّد.

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

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

المعلمات

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

الإرجاع

Sheet: الورقة التي تحمل الاسم المحدّد

---

getSheetId()

تعرض هذه الدالة رقم تعريف ورقة البيانات الممثّلة بهذا العنصر.

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

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

Logger.log(sheet.getSheetId());

الإرجاع

استبدِل Integer بمعرّف الورقة الفريد في جدول البيانات.

التفويض

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

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

---

getSheetName()

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
const 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 المحدّدة كموضع الصف أو العمود تعادل الحصول على آخر صف أو عمود يتضمّن بيانات في الورقة.

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

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

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

المعلمات

الاسم	النوع	الوصف
startRow	Integer	موضع صف البداية
startColumn	Integer	موضع العمود الأول
numRows	Integer	عدد الصفوف المطلوب عرض قيمها.
numColumns	Integer	عدد الأعمدة المطلوب عرض قيمها.

الإرجاع

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
const sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
// Iterates through the sheets and logs the name and ID of each sheet.
for (const sheet of sheets) {
  Logger.log(`name: ${sheet.getName()}, ID: ${sheet.getSheetId()}`);
}

الإرجاع

‫Sheet[]: صفيف يتضمّن جميع الأوراق في جدول البيانات.

---

getSpreadsheetLocale()

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

الإرجاع

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.
const currentTheme =
    SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

الإرجاع

‫SpreadsheetTheme: المظهر الحالي الذي تم تطبيقه

التفويض

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

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

---

getSpreadsheetTimeZone()

تعرض هذه الدالة المنطقة الزمنية لجدول البيانات.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

الإرجاع

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

التفويض

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

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

---

getUrl()

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

const 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)

تخفي هذه الدالة العمود أو الأعمدة في النطاق المحدّد.

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

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

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

المعلمات

الاسم	النوع	الوصف
column	Range	نطاق الأعمدة المطلوب إخفاؤه.

التفويض

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

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

---

hideRow(row)

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

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

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

المعلمات

الاسم	النوع	الوصف
row	Range	نطاق الصفوف المطلوب إخفاؤه.

التفويض

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

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

---

insertColumnAfter(afterPosition)

تُدرج هذه الدالة عمودًا بعد موضع العمود المحدّد.

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

---

insertColumnBefore(beforePosition)

تُدرِج هذه الدالة عمودًا قبل موضع العمود المحدّد.

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

---

insertColumnsAfter(afterPosition, howMany)

تُدرج هذه الدالة عددًا معيّنًا من الأعمدة بعد موضع العمود المحدّد.

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

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

المعلمات

الاسم	النوع	الوصف
afterPosition	Integer	العمود الذي يجب إضافة العمود الجديد بعده
howMany	Integer	عدد الأعمدة المطلوب إدراجها.

الإرجاع

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

التفويض

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

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

---

insertColumnsBefore(beforePosition, howMany)

تُدرج هذه الطريقة عددًا من الأعمدة قبل موضع العمود المحدّد.

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

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

المعلمات

الاسم	النوع	الوصف
beforePosition	Integer	العمود الذي يجب إضافة العمود الجديد قبله.
howMany	Integer	عدد الأعمدة المطلوب إدراجها.

الإرجاع

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

التفويض

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

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

---

insertDataSourceSheet(spec)

يُدرج DataSourceSheet جديدًا في جدول البيانات ويبدأ تنفيذ البيانات. نتيجة لذلك، سيصبح جدول البيانات الجديد هو جدول البيانات النشط.

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
                           .asBigQuery()
                           .setProjectId('project-id-1')
                           .setTableProjectId('bigquery-public-data')
                           .setDatasetId('ncaa_basketball')
                           .setTableId('mbb_historical_teams_games')
                           .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

المعلمات

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

الإرجاع

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

التفويض

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

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

---

insertImage(blobSource, column, row)

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

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

المعلمات

الاسم	النوع	الوصف
blobSource	BlobSource	كائن تخزين البيانات الثنائية الكبيرة الذي يحتوي على محتوى الصورة ونوع MIME واسمها (اختياريًا)
column	Integer	موضع العمود
row	Integer	تمثّل هذه السمة موضع الصف.

الإرجاع

OverGridImage: الصورة المُدرَجة

التفويض

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

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

---

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

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

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

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

المعلمات

الاسم	النوع	الوصف
blobSource	BlobSource	كائن تخزين البيانات الثنائية الكبيرة الذي يحتوي على محتوى الصورة ونوع MIME واسمها (اختياريًا)
column	Integer	موضع العمود
row	Integer	تمثّل هذه السمة موضع الصف.
offsetX	Integer	تمثّل هذه السمة الإزاحة الأفقية من زاوية الخلية بوحدة البكسل.
offsetY	Integer	تمثّل هذه السمة الإزاحة العمودية من زاوية الخلية بالبكسل.

الإرجاع

OverGridImage: الصورة المُدرَجة

التفويض

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

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

---

insertImage(url, column, row)

تُدرِج هذه الدالة صورة في المستند في صف وعمود محدّدين.

يجب أن يكون عنوان URL المقدَّم متاحًا للجميع.

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

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

المعلمات

الاسم	النوع	الوصف
url	String	عنوان URL للصورة
column	Integer	تمثّل هذه السمة موضع عمود الشبكة.
row	Integer	تمثّل هذه السمة موضع الصف في الشبكة.

الإرجاع

OverGridImage: الصورة المُدرَجة

التفويض

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

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

---

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

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

يجب أن يكون عنوان URL المقدَّم متاحًا للجميع.

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

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

المعلمات

الاسم	النوع	الوصف
url	String	تمثّل عنوان URL الخاص بالصورة.
column	Integer	موضع العمود
row	Integer	تمثّل هذه السمة موضع الصف.
offsetX	Integer	تمثّل هذه السمة الإزاحة الأفقية من زاوية الخلية بوحدة البكسل.
offsetY	Integer	تمثّل هذه السمة الإزاحة العمودية من زاوية الخلية بالبكسل.

الإرجاع

OverGridImage: الصورة المُدرَجة

التفويض

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

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

---

insertRowAfter(afterPosition)

تُدرِج هذه الدالة صفًا بعد موضع الصف المحدّد.

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

---

insertRowBefore(beforePosition)

تُدرِج هذه الدالة صفًا قبل موضع الصف المحدّد.

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

---

insertRowsAfter(afterPosition, howMany)

تُدرِج هذه الطريقة عددًا من الصفوف بعد موضع الصف المحدّد.

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

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

المعلمات

الاسم	النوع	الوصف
afterPosition	Integer	الصف الذي يجب إضافة الصفوف الجديدة بعده
howMany	Integer	عدد الصفوف المطلوب إدراجها.

الإرجاع

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

التفويض

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

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

---

insertRowsBefore(beforePosition, howMany)

تُدرِج هذه الطريقة عددًا من الصفوف قبل موضع الصف المحدّد.

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

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

المعلمات

الاسم	النوع	الوصف
beforePosition	Integer	الصف الذي يجب إضافة الصفوف الجديدة قبله
howMany	Integer	عدد الصفوف المطلوب إدراجها.

الإرجاع

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

التفويض

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

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

---

insertSheet()

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

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

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

insertSheet(sheetIndex)

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

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

المعلمات

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

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

insertSheet(sheetIndex, options)

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

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

المعلمات

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

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

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

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

insertSheet(options)

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

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

المعلمات

الاسم	النوع	الوصف
options	Object	وسيطات JavaScript المتقدّمة الاختيارية، والمدرَجة أدناه

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

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

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

insertSheet(sheetName)

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

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

المعلمات

الاسم	النوع	الوصف
sheetName	String	اسم الورقة الجديدة

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

insertSheet(sheetName, sheetIndex)

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

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

المعلمات

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

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

insertSheet(sheetName, sheetIndex, options)

تُدرِج هذه الدالة ورقة جديدة في جدول البيانات بالاسم والفهرس المحدّدَين، وتستخدِم وسيطات متقدّمة اختيارية. يصبح جدول البيانات الجديد هو جدول البيانات النشط.

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

المعلمات

الاسم	النوع	الوصف
sheetName	String	اسم الورقة الجديدة
sheetIndex	Integer	فهرس ورقة البيانات المُدرَجة حديثًا لإدراج ورقة كأول ورقة في جدول بيانات، اضبطها على 0.
options	Object	الوسيطات المتقدّمة الاختيارية في JavaScript

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

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

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

insertSheet(sheetName, options)

تُدرج هذه الدالة ورقة جديدة في جدول البيانات بالاسم المحدّد، وتستخدِم وسيطات اختيارية متقدّمة. يصبح جدول البيانات الجديد هو جدول البيانات النشط.

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

المعلمات

الاسم	النوع	الوصف
sheetName	String	اسم الورقة الجديدة
options	Object	الوسيطات المتقدّمة الاختيارية في JavaScript

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

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

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

insertSheetWithDataSourceTable(spec)

تُدرج هذه الدالة ورقة جديدة في جدول البيانات، وتنشئ DataSourceTable تمتد على الورقة بأكملها مع مواصفات مصدر البيانات المحدّدة، وتبدأ في تنفيذ البيانات. ونتيجة لذلك، يصبح جدول البيانات الجديد هو جدول البيانات النشط.

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
    '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
                           .asBigQuery()
                           .setProjectId('project-id-1')
                           .setRawQuery(query)
                           .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
                           .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

المعلمات

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

الإرجاع

Sheet: الورقة الجديدة

التفويض

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

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

---

isColumnHiddenByUser(columnPosition)

تعرِض هذه السمة ما إذا كان المستخدم قد أخفى العمود المحدّد.

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

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

المعلمات

الاسم	النوع	الوصف
columnPosition	Integer	تمثّل هذه السمة موضع العمود المطلوب فحصه.

الإرجاع

Boolean: true إذا كان العمود مخفيًا، false بخلاف ذلك

التفويض

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

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

---

isIterativeCalculationEnabled()

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

الإرجاع

Boolean — true إذا تم تفعيل الاحتساب المكرّر، false في الحالات الأخرى

التفويض

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

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

---

isRowHiddenByFilter(rowPosition)

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

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

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

المعلمات

الاسم	النوع	الوصف
rowPosition	Integer	تمثّل هذه السمة موضع الصف المطلوب فحصه.

الإرجاع

‫Boolean: true إذا كان الصف مخفيًا، false بخلاف ذلك

التفويض

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

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

---

isRowHiddenByUser(rowPosition)

تعرِض هذه السمة ما إذا كان المستخدم قد أخفى الصف المحدّد.

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

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

المعلمات

الاسم	النوع	الوصف
rowPosition	Integer	تمثّل هذه السمة موضع الصف المطلوب فحصه.

الإرجاع

‫Boolean: true إذا كان الصف مخفيًا، false بخلاف ذلك

التفويض

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

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

---

moveActiveSheet(pos)

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

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

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

spreadsheet.moveActiveSheet(2);

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

المعلمات

الاسم	النوع	الوصف
pos	Integer	موضع الفهرس 1 الذي سيتم نقل الورقة النشطة إليه في قائمة الأوراق

التفويض

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

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

---

moveChartToObjectSheet(chart)

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

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

المعلمات

الاسم	النوع	الوصف
chart	EmbeddedChart	الرسم البياني المطلوب نقله

الإرجاع

Sheet: الورقة التي يظهر عليها الرسم البياني

التفويض

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

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

---

refreshAllDataSources()

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

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

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(
    `Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`,
);

التفويض

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

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

---

removeEditor(emailAddress)

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

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

المعلمات

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

الإرجاع

Spreadsheet: هذا Spreadsheet، يُستخدَم للربط.

التفويض

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

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

---

removeEditor(user)

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

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

المعلمات

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

الإرجاع

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() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu('badMenu', [
    {name: 'remove bad menu', functionName: 'removeBadMenu'},
    {name: 'foo', functionName: 'foo'},
  ]);
}
function removeBadMenu() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu(
      'badMenu');  // name must match the name used when added the menu
}
function foo() {
  // Do nothing
}

المعلمات

الاسم	النوع	الوصف
name	String	تمثّل هذه السمة اسم القائمة التي ستتم إزالتها.

التفويض

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

• 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.
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange('foo', ss.getActiveRange());
ss.removeNamedRange('foo');

المعلمات

الاسم	النوع	الوصف
name	String	تمثّل هذه السمة اسم النطاق.

التفويض

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

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

---

removeViewer(emailAddress)

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

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

المعلمات

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

الإرجاع

‫Spreadsheet: هذا Spreadsheet للتسلسل.

التفويض

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

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

---

removeViewer(user)

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

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

المعلمات

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

الإرجاع

‫Spreadsheet: هذا Spreadsheet للتسلسل.

التفويض

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

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

---

rename(newName)

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

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename('This is the new name');

المعلمات

الاسم	النوع	الوصف
newName	String	الاسم الجديد للمستند

التفويض

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

• 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');

المعلمات

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

التفويض

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

• 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.

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

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

المعلمات

الاسم	النوع	الوصف
range	Range	النطاق الذي سيتم ضبطه كنطاق نشط

الإرجاع

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

التفويض

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

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

---

setActiveRangeList(rangeList)

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

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

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

المعلمات

الاسم	النوع	الوصف
rangeList	RangeList	قائمة النطاقات التي سيتم اختيارها

الإرجاع

RangeList: قائمة النطاقات المحدّدة حديثًا

التفويض

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

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

---

setActiveSelection(range)

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

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

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

المعلمات

الاسم	النوع	الوصف
range	Range	النطاق المطلوب ضبطه كالنطاق النشط.

الإرجاع

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

التفويض

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

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

---

setActiveSelection(a1Notation)

تضبط هذه السمة التحديد النشط، كما هو محدّد في ترميز A1 أو ترميز R1C1.

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

sheet.setActiveSelection('A1:D4');

المعلمات

الاسم	النوع	الوصف
a1Notation	String	النطاق المطلوب ضبطه على نشط، كما هو محدّد في ترميز 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.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

المعلمات

الاسم	النوع	الوصف
sheet	Sheet	ورقة البيانات التي سيتم ضبطها كورقة البيانات النشطة

الإرجاع

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

التفويض

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

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

---

setActiveSheet(sheet, restoreSelection)

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

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const firstSheet = spreadsheet.getSheets()[0];
const 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
const range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

المعلمات

الاسم	النوع	الوصف
sheet	Sheet	ورقة البيانات النشطة الجديدة
restoreSelection	Boolean	إذا كانت القيمة true، سيتم تحديد آخر اختيار للورقة النشطة الجديدة مرة أخرى عندما تصبح الورقة الجديدة نشطة. أما إذا كانت القيمة false، فستصبح الورقة الجديدة نشطة بدون تغيير التحديد الحالي.

الإرجاع

Sheet: ورقة البيانات النشطة الجديدة

التفويض

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

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

---

setColumnWidth(columnPosition, width)

تضبط هذه السمة عرض العمود المحدّد بالبكسل.

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

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

المعلمات

الاسم	النوع	الوصف
columnPosition	Integer	موضع العمود المحدّد المطلوب ضبطه.
width	Integer	تمثّل هذه السمة العرض المطلوب ضبطه بالبكسل.

الإرجاع

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

التفويض

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

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

---

setCurrentCell(cell)

تضبط هذه السمة الخلية المحدّدة على current cell.

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

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

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

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

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

المعلمات

الاسم	النوع	الوصف
cell	Range	الخلية المطلوب ضبطها كخلية حالية

الإرجاع

Range: الخلية الحالية التي تم ضبطها حديثًا

التفويض

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

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

---

setFrozenColumns(columns)

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

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

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

المعلمات

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

التفويض

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

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

---

setFrozenRows(rows)

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

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

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

المعلمات

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

التفويض

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

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

---

setIterativeCalculationConvergenceThreshold(minThreshold)

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

المعلمات

الاسم	النوع	الوصف
minThreshold	Number	الحد الأدنى للتقارب (يجب أن يكون غير سالب)

الإرجاع

Spreadsheet: جدول البيانات هذا، ويُستخدم في الربط.

التفويض

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

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

---

setIterativeCalculationEnabled(isEnabled)

تحدّد هذه السمة ما إذا كان الاحتساب المكرّر مفعَّلاً في جدول البيانات هذا. إذا لم يتم ضبط الحد الأقصى لعدد دورات الحساب وحدّ التقارب من قبل عند تفعيل الحساب، سيتم ضبطهما تلقائيًا على 50 و0.05 على التوالي. إذا تم ضبط أي منهما سابقًا، سيحتفظان بقيمتيهما السابقتَين.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

المعلمات

الاسم	النوع	الوصف
isEnabled	Boolean	true إذا كان يجب تفعيل الاحتساب المكرّر، false في ما عدا ذلك

الإرجاع

Spreadsheet: جدول البيانات هذا، ويُستخدم في الربط.

التفويض

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

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

---

setMaxIterativeCalculationCycles(maxIterations)

تضبط هذه السمة الحد الأقصى لعدد تكرارات الحساب التي يجب تنفيذها أثناء الحساب التكراري. يجب أن تتراوح هذه القيمة بين 1 و10,000 (بما في ذلك هذين الرقمَين)، والقيمة التلقائية هي 50.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

المعلمات

الاسم	النوع	الوصف
maxIterations	Integer	الحدّ الأقصى لعدد تكرارات الحساب (بين 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
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange('TaxRates', SpreadsheetApp.getActiveRange());

المعلمات

الاسم	النوع	الوصف
name	String	تمثّل هذه السمة الاسم الذي سيتم إطلاقه على النطاق.
range	Range	مواصفات النطاق

التفويض

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

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

---

setRecalculationInterval(recalculationInterval)

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(
    SpreadsheetApp.RecalculationInterval.ON_CHANGE,
);

// Logs the calculation interval to the console.
console.log(interval);

المعلمات

الاسم	النوع	الوصف
recalculationInterval	RecalculationInterval	الفاصل الزمني الجديد لإعادة الحساب

الإرجاع

Spreadsheet: جدول البيانات هذا، ويُستخدم في الربط.

التفويض

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

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

---

setRowHeight(rowPosition, height)

تضبط هذه السمة ارتفاع الصف المحدّد بالبكسل. تتوسّع الصفوف تلقائيًا لتلائم محتوى الخلايا. إذا أردت فرض ارتفاع محدّد على الصفوف، استخدِم Sheet.setRowHeightsForced(startRow, numRows, height).

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

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

المعلمات

الاسم	النوع	الوصف
rowPosition	Integer	موضع الصف الذي سيتم تغييره.
height	Integer	تمثّل هذه السمة الارتفاع المطلوب ضبطه بالبكسل.

الإرجاع

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

التفويض

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

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

---

setSpreadsheetLocale(locale)

تضبط هذه السمة لغة جدول البيانات.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

المعلمات

الاسم	النوع	الوصف
locale	String	رمز اللغة المطلوب استخدامه (على سبيل المثال، "ar" أو "fr" أو "ar_SA")

التفويض

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

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

---

setSpreadsheetTheme(theme)

تضبط هذه السمة تصميمًا على جدول البيانات.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the
// spreadsheet.
const predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

المعلمات

الاسم	النوع	الوصف
theme	SpreadsheetTheme	المظهر الذي سيتم تطبيقه

الإرجاع

SpreadsheetTheme: المظهر الحالي الجديد

التفويض

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

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

---

setSpreadsheetTimeZone(timezone)

تضبط هذه السمة المنطقة الزمنية لجدول البيانات.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

المعلمات

الاسم	النوع	الوصف
timezone	String	المنطقة الزمنية، ويتم تحديدها بالتنسيق "الطويل" (على سبيل المثال، "America/New_York"، كما هو موضّح في Joda.org).

التفويض

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

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

---

show(userInterface)

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

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

يعرض مقتطف الرمز التالي تطبيق HtmlService بسيطًا في مربّع حوار يتضمّن العنوان والارتفاع والعرض المحدّدين:

const 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.

المعلمات

الاسم	النوع	الوصف
userInterface	Object	HtmlOutput

التفويض

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

• https://www.googleapis.com/auth/script.container.ui

---

sort(columnPosition)

ترتّب هذه الدالة ورقة حسب العمود، تصاعديًا.

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

// Sorts the sheet by the first column, ascending
sheet.sort(1);

المعلمات

الاسم	النوع	الوصف
columnPosition	Integer	العمود المطلوب الترتيب حسبه

الإرجاع

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

التفويض

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

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

---

sort(columnPosition, ascending)

ترتّب هذه الدالة ورقة حسب العمود. تتضمّن مَعلمة لتحديد الترتيب التصاعدي أو التنازلي.

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

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

المعلمات

الاسم	النوع	الوصف
columnPosition	Integer	العمود المطلوب الترتيب حسبه
ascending	Boolean	true للترتيب التصاعدي، و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');

المعلمات

الاسم	النوع	الوصف
msg	String	الرسالة التي سيتم عرضها في الإشعار المؤقت

التفويض

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

• 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');

المعلمات

الاسم	النوع	الوصف
msg	String	الرسالة التي سيتم عرضها في الإشعار المؤقت
title	String	تمثّل هذه السمة العنوان الاختياري للإشعار.

التفويض

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

• 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);

المعلمات

الاسم	النوع	الوصف
msg	String	الرسالة التي سيتم عرضها في الإشعار المؤقت
title	String	تمثّل هذه السمة العنوان الاختياري للإشعار.
timeoutSeconds	Number	مهلة انتهاء الوقت بالثواني؛ إذا كانت القيمة null، تكون مدة ظهور الإشعار 5 ثوانٍ تلقائيًا؛ إذا كانت القيمة سالبة، يظل الإشعار معروضًا إلى أن يتم إغلاقه.

التفويض

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

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

---

unhideColumn(column)

تعرض هذه الدالة العمود المخفي في النطاق المحدّد.

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

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

المعلمات

الاسم	النوع	الوصف
column	Range	النطاق المطلوب إظهاره، إذا كان مخفيًا.

التفويض

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

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

---

unhideRow(row)

إظهار الصف في النطاق المحدّد

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

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

المعلمات

الاسم	النوع	الوصف
row	Range	النطاق المطلوب إظهاره، إذا كان مخفيًا.

التفويض

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

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

---

updateMenu(name, subMenus)

تعدّل هذه الطريقة قائمة طعام أضافها addMenu(name, subMenus). تعمل تمامًا مثل addMenu(name, subMenus).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const menuEntries = [];
menuEntries.push({name: 'Lone Menu Entry', functionName: 'function1'});
ss.updateMenu('addMenuExample', menuEntries);

المعلمات

الاسم	النوع	الوصف
name	String	تمثّل هذه السمة اسم قائمة الطعام المطلوب تعديلها.
subMenus	Object[]	مجموعة من خرائط JavaScript مع المَعلمتَين name وfunctionName يمكنك استخدام دوال من المكتبات المضمّنة، مثل Library.libFunction1.

التفويض

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

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

---

waitForAllDataExecutionsCompletion(timeoutInSeconds)

ينتظر إلى أن تكتمل جميع عمليات التنفيذ الحالية في جدول البيانات، مع انتهاء المهلة بعد عدد الثواني المحدّد. يُطلق استثناءً إذا لم تكتمل عمليات التنفيذ عند انتهاء المهلة، ولكنّه لا يلغي عمليات تنفيذ البيانات.

المعلمات

الاسم	النوع	الوصف
timeoutInSeconds	Integer	الوقت المطلوب للانتظار حتى يتم تنفيذ البيانات، بالثواني الحدّ الأقصى هو 300 ثانية.

التفويض

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

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

الطُرق المتوقّفة

getSheetProtection()

تمّت إزالة هذا العمود. بالنسبة إلى جداول البيانات التي تم إنشاؤها في الإصدار الأحدث من "جداول بيانات Google"، استخدِم Sheet.getProtections(type)، الذي يعرض الفئة Protection الأكثر فعالية. على الرغم من إيقاف هذه الطريقة نهائيًا، إلا أنّها تظل متاحة للتوافق مع الإصدار القديم من "جداول بيانات Google".

تعرض هذه الدالة مثيلاً من PageProtection يصف أذونات الورقة الحالية.

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

const permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser('[e-mail]');

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
const users = permissions.getUsers();
Logger.log(users);

الإرجاع

‫PageProtection: عنصر يصف أذونات الوصول إلى جدول بيانات.

التفويض

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

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

---

isAnonymousView()

تمّت إزالة هذا العمود. اعتبارًا من يناير 2014، تم إيقاف هذه الدالة نهائيًا وهي غير متاحة في الإصدار الجديد من "جداول بيانات Google".

تشير هذه السمة إلى ما إذا كان المستند يسمح بالعرض بدون تسجيل الدخول. بما أنّ هذه الميزة لم تعُد متاحة في الإصدار الجديد من "جداول بيانات Google"، استخدِم File.getSharingAccess() وFile.getSharingPermission() بدلاً من ذلك.

// Determine if the document allows anonymous viewing via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());
const access = file.getSharingAccess();
const permission = file.getSharingPermission();
const isAnonymousAccess = access === DriveApp.Access.ANYONE ||
    access === DriveApp.Access.ANYONE_WITH_LINK;
const isAnonymousEdit =
    isAnonymousAccess && permission !== DriveApp.Permission.NONE;

الإرجاع

‫Boolean — true إذا كان المستند يسمح بالعرض بدون الكشف عن الهوية، false في الحالات الأخرى

التفويض

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

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

انظر أيضًا

• خدمة Drive

---

isAnonymousWrite()

تمّت إزالة هذا العمود. اعتبارًا من يناير 2014، تم إيقاف هذه الدالة نهائيًا وهي غير متاحة في الإصدار الجديد من "جداول بيانات Google".

تشير إلى ما إذا كان المستند يسمح بإجراء تعديلات من مستخدمين مجهولين. بما أنّ هذه الميزة لم تعُد متاحة في الإصدار الجديد من "جداول بيانات Google"، استخدِم File.getSharingAccess() وFile.getSharingPermission() بدلاً من ذلك.

// Determine if the document allow anonymous edits via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());
const access = file.getSharingAccess();
const permission = file.getSharingPermission();
const isAnonymousAccess = access === DriveApp.Access.ANYONE ||
    access === DriveApp.Access.ANYONE_WITH_LINK;
const isAnonymousEdit =
    isAnonymousAccess && permission === DriveApp.Permission.EDIT;

الإرجاع

‫Boolean — true إذا كان المستند يسمح بالتعديل بدون الكشف عن الهوية، false في الحالات الأخرى

التفويض

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

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

انظر أيضًا

• خدمة Drive

---

setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)

تمّت إزالة هذا العمود. اعتبارًا من يناير 2014، تم إيقاف هذه الدالة نهائيًا وهي غير متاحة في الإصدار الجديد من "جداول بيانات Google".

تضبط هذه السمة سياسة المستند بشأن القراءة والكتابة بدون الكشف عن الهوية. بما أنّ هذه الميزة لم تعُد متاحة في الإصدار الجديد من "جداول بيانات Google"، يمكنك استخدام File.setSharing(accessType, permissionType) كبديل.

// Set the document's policy on anonymous reading and writing via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApp.Access.PRIVATE, file.getSharingPermission());

المعلمات

الاسم	النوع	الوصف
anonymousReadAllowed	Boolean	true للسماح بعمليات القراءة بدون الكشف عن الهوية، false في الحالات الأخرى
anonymousWriteAllowed	Boolean	true للسماح بعمليات القراءة بدون الكشف عن الهوية، false في الحالات الأخرى

التفويض

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

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

انظر أيضًا

• isAnonymousView()
• isAnonymousWrite()
• خدمة Drive

---

setSheetProtection(permissions)

تمّت إزالة هذا العمود. بالنسبة إلى جداول البيانات التي تم إنشاؤها في الإصدار الأحدث من "جداول بيانات Google"، استخدِم Sheet.protect()، الذي يعرض الفئة Protection الأكثر فعالية. على الرغم من أنّ هذه الطريقة متوقّفة نهائيًا، إلا أنّها تظل متاحة للتوافق مع الإصدار القديم من "جداول بيانات Google".

تضبط هذه السمة أذونات الوصول إلى ورقة البيانات الحالية.

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

const permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
const sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

المعلمات

الاسم	النوع	الوصف
permissions	PageProtection	عنصر أذونات الوصول المطلوب ضبطه في ورقة البيانات هذه.

التفويض

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

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