تمت ترجمة هذه الصفحة بواسطة Cloud Translation API‏.

Class Spreadsheet

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

الطُرق

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

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

الطريقة	نوع القيمة التي يتم عرضها	وصف قصير
`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)`

المعلَمات

الاسم	النوع	الوصف
`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)`

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

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

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

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

المعلَمات

الاسم	النوع	الوصف
`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)`

المعلَمات

الاسم	النوع	الوصف
`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)`

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

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

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

المعلَمات

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

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق.

التفويض

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

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

`autoResizeColumn(columnPosition)`

تضبط عرض العمود المحدّد ليلائم محتوياته.

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

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

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

المعلَمات

الاسم	النوع	الوصف
`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
var 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)`

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

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

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

المعلَمات

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

الإرجاع

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

`deleteActiveSheet()`

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

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

الإرجاع

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

التفويض

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

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

`deleteColumn(columnPosition)`

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

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

المعلَمات

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

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

`deleteColumns(columnPosition, howMany)`

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

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

المعلَمات

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

التفويض

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

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

`deleteRow(rowPosition)`

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

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

المعلَمات

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

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

`deleteRows(rowPosition, howMany)`

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

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

المعلَمات

الاسم	النوع	الوصف
`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.
var ss = SpreadsheetApp.getActive();
var 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()، الذي يعرض الخلية التي تم تمييزها حاليًا.

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

الإرجاع

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

التفويض

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

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

`getActiveRange()`

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

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

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

الإرجاع

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

التفويض

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

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

انظر أيضًا

setActiveRange(range)

`getActiveRangeList()`

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

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

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

الإرجاع

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

التفويض

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

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

انظر أيضًا

setActiveRangeList(rangeList)

`getActiveSheet()`

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

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

var 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)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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"، ويتم تمييزها بحدود داكنة. لا تتوفّر أبدًا أكثر من خلية حالية واحدة. عندما يختار مستخدم نطاقًا واحدًا أو أكثر من الخلايا، تكون إحدى الخلايا في الاختيار هي الخلية الحالية.

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

الإرجاع

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

التفويض

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

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

`getDataRange()`

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

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

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

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

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

الإرجاع

Range - نطاق يتألف من جميع البيانات في جدول البيانات

التفويض

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

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

`getDataSourceFormulas()`

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

// 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 للنموذج المعروض غير محدّد. كخيار بديل، يمكن retrieving ربط عناوين 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()`

لعرض عدد الأعمدة المُجمَّدة.

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

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

الإرجاع

Integer: عدد الأعمدة المجمّدة

التفويض

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

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

`getFrozenRows()`

لعرض عدد الصفوف الثابتة.

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

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

الإرجاع

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

التفويض

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

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

`getId()`

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

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

الإرجاع

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

`getImages()`

عرض جميع الصور التي تتجاوز حدود الشبكة على الورقة

// 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()`

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

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

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

الإرجاع

Integer: العمود الأخير في جدول البيانات الذي يحتوي على محتوى

التفويض

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

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

`getLastRow()`

لعرض موضع آخر صف يحتوي على محتوى.

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

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

الإرجاع

Integer: الصف الأخير من جدول البيانات الذي يحتوي على محتوى

التفويض

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

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

`getMaxIterativeCalculationCycles()`

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

// 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()`

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

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

الإرجاع

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

التفويض

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

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

`getNamedRanges()`

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

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

الإرجاع

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

التفويض

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

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

`getNumSheets()`

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

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

الإرجاع

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

`getOwner()`

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

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

الإرجاع

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

التفويض

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

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

`getPredefinedSpreadsheetThemes()`

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

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

الإرجاع

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

التفويض

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

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

`getProtections(type)`

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

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

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

المعلَمات

الاسم	النوع	الوصف
`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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

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

المعلَمات

الاسم	النوع	الوصف
`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.
var 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.
var sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
var 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)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 الحالي في جدول البيانات.

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

الإرجاع

Selection: العنصر المحدّد حاليًا

التفويض

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

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

`getSheetByName(name)`

لعرض ورقة بيانات بالاسم المحدّد

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

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

المعلَمات

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

الإرجاع

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

`getSheetId()`

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

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

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

Logger.log(sheet.getSheetId());

الإرجاع

Integer: معرّف لصفحة البيانات فريد لجدول البيانات

التفويض

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

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

`getSheetName()`

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

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

Logger.log(sheet.getSheetName());

الإرجاع

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

التفويض

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

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

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

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

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

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

المعلَمات

الاسم	النوع	الوصف
`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
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

الإرجاع

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.
var 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: المنطقة الزمنية، المحدّدة بالتنسيق "الطول" (على سبيل المثال، "أمريكا/نيويورك"، كما هو مُدرَج في Joda.org)

التفويض

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

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

`getUrl()`

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

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

الإرجاع

‫String: عنوان URL لجدول البيانات المحدّد

التفويض

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

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

`getViewers()`

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

الإرجاع

User[]: صفيف من المستخدمين الذين لديهم إذن بالاطّلاع أو التعليق

التفويض

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

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

`hideColumn(column)`

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

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

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

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

المعلَمات

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

التفويض

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

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

`hideRow(row)`

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

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

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

المعلَمات

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

التفويض

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

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

`insertColumnAfter(afterPosition)`

تُدخِل عمودًا بعد موضع العمود المحدَّد.

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

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

المعلَمات

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

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

`insertColumnBefore(beforePosition)`

تُستخدَم لإدراج عمود قبل موضع العمود المحدّد.

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

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

المعلَمات

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

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

`insertColumnsAfter(afterPosition, howMany)`

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

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

تُدخِل عددًا من الأعمدة قبل موضع العمود المحدَّد.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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) المسموح به هو 2 ميغابايت.

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

var 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 ميغابايت.

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

var 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 المقدَّم متاحًا للجميع.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 المقدَّم متاحًا للجميع.

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

تُدرج صفًا بعد موضع الصف المحدَّد.

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

تُستخدَم لإدراج صف قبل موضع الصف المحدّد.

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

تُدرج عددًا من الصفوف بعد موضع الصف المحدَّد.

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

تُستخدَم لإدراج عدد من الصفوف قبل موضع الصف المحدَّد.

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

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

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

الإرجاع

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

التفويض

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

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

`insertSheet(sheetIndex)`

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

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

المعلَمات

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

الإرجاع

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

التفويض

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

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

`insertSheet(sheetIndex, options)`

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

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

المعلَمات

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

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

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

الإرجاع

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

التفويض

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

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

`insertSheet(options)`

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

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

المعلَمات

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

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

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

الإرجاع

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

التفويض

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

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

`insertSheet(sheetName)`

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

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

المعلَمات

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

الإرجاع

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

التفويض

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

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

`insertSheet(sheetName, sheetIndex)`

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

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

المعلَمات

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

الإرجاع

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

التفويض

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

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

`insertSheet(sheetName, sheetIndex, options)`

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

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

المعلَمات

الاسم	النوع	الوصف
`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)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 على مستوى الجدول بأكمله باستخدام مواصفات مصدر البيانات المحدّدة، وتبدأ تنفيذ البيانات. ونتيجةً لذلك، يصبح الجدول الجديد هو الجدول النشط.

// 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)`

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

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

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

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

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var sheet = spreadsheet.getSheetByName("first").activate();

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

spreadsheet.moveActiveSheet(2);

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

المعلَمات

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

التفويض

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

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

`moveChartToObjectSheet(chart)`

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

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

المعلَمات

الاسم	النوع	الوصف
`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 للمستخدم بالكامل، أو إذا كان Spreadsheet في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.

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

المعلَمات

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

الإرجاع

Spreadsheet — هذا الرمز Spreadsheet، لإنشاء سلسلة.

التفويض

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

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

`removeEditor(user)`

بالنسبة إلى ملفات 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() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu("badMenu");  // name must match the name used when added the menu
}
function foo(){
// Do nothing
}

المعلَمات

الاسم	النوع	الوصف
`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.
var 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 في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.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)`

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

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

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

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

المعلَمات

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

الإرجاع

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

التفويض

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

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

`setActiveRangeList(rangeList)`

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

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

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

المعلَمات

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

الإرجاع

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

التفويض

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

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

`setActiveSelection(range)`

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

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

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

المعلَمات

الاسم	النوع	الوصف
`range`	`Range`	النطاق الذي سيتم ضبطه على أنّه الاختيار النشط.

الإرجاع

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

التفويض

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

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

`setActiveSelection(a1Notation)`

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

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

sheet.setActiveSelection("A1:D4");

المعلَمات

الاسم	النوع	الوصف
`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.
var 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" الورقة المحدّدة ما لم تكن الورقة تنتمي إلى جدول بيانات مختلف.

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

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

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

المعلَمات

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

الإرجاع

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

التفويض

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

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

`setColumnWidth(columnPosition, width)`

لضبط عرض العمود المحدّد بالبكسل

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

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

المعلَمات

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

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

`setCurrentCell(cell)`

لضبط الخلية المحدّدة على أنّها current cell.

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

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

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

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

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

المعلَمات

الاسم	النوع	الوصف
`cell`	`Range`	الخلية التي سيتم ضبطها على أنّها الخلية الحالية.

الإرجاع

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

التفويض

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

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

`setFrozenColumns(columns)`

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

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

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

المعلَمات

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

التفويض

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

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

`setFrozenRows(rows)`

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

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

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

المعلَمات

الاسم	النوع	الوصف
`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
var 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).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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`	رمز اللغة المراد استخدامه (على سبيل المثال، 'en' أو 'fr' أو 'en_US')

التفويض

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

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

`setSpreadsheetTheme(theme)`

ضبط تصميم في جدول البيانات

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

المعلَمات

الاسم	النوع	الوصف
`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`	المنطقة الزمنية، المحدّدة بالتنسيق "الطول" (على سبيل المثال، "أمريكا/نيويورك"، كما هو مُدرَج في Joda.org)

التفويض

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

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

`show(userInterface)`

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

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

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

var htmlApp = HtmlService
    .createHtmlOutput('<p>A change of speed, a change of style...</p>')
    .setTitle('My HtmlService Application')
    .setWidth(250)
    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

المعلَمات

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

التفويض

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

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

`sort(columnPosition)`

لترتيب ورقة بيانات حسب العمود تصاعديًا

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

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

المعلَمات

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

الإرجاع

Sheet - ورقة البيانات، وهي مفيدة لتسلسل الطرق

التفويض

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

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

`sort(columnPosition, ascending)`

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

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

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

المعلَمات

الاسم	النوع	الوصف
`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)`

تُزيل إخفاء العمود في النطاق المحدَّد.

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

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

المعلَمات

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

التفويض

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

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

`unhideRow(row)`

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

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

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

المعلَمات

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

التفويض

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

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

`updateMenu(name, subMenus)`

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

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

المعلَمات

الاسم	النوع	الوصف
`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 يصف أذونات الورقة الحالية

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

var permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser("user@example.com");

// 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.
var 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission != DriveApp.Permission.NONE;

الإرجاع

Boolean: true إذا كان المستند يسمح بالعرض بدون تحديد الهوية، false في حال عدم السماح بذلك

التفويض

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

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

انظر أيضًا

خدمة Drive

`isAnonymousWrite()`

يشير إلى ما إذا كان المستند يسمح بإجراء تعديلات من مستخدمين مجهولين. بما أنّه لم يعُد هذا الخيار متاحًا في الإصدار الجديد من جداول بيانات Google، استخدِم File.getSharingAccess() وFile.getSharingPermission() بدلاً من ذلك.

// Determine if the document allow anonymous edits via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var 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)`

لضبط سياسة المستند بشأن القراءة والكتابة بدون الكشف عن الهوية بما أنّ هذه الميزة لم تعُد متاحة في الإصدار الجديد من "جداول بيانات Google"، استخدِم File.setSharing(accessType, permissionType) كبديل.

// Set the document's policy on anonymous reading and writing via the Drive API.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApi.Access.ANYONE, DriveApi.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApi.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".

تُستخدَم لضبط أذونات ورقة البيانات الحالية.

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

var permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
var sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

المعلَمات

الاسم	النوع	الوصف
`permissions`	`PageProtection`	عنصر أذونات الوصول المطلوب ضبطه في هذه الورقة

التفويض

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

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