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وينتظر حتى اكتمال جميع عمليات التنفيذ الحالية في جدول البيانات، وتنتهي المهلة بعد عدد الثواني المقدم.

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

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

المعلمات

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

الإرجاع

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()}`);

المعلمات

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

الإرجاع

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()}`);

المعلمات

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

الإرجاع

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()}`);

المعلمات

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

الإرجاع

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

التفويض

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

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

addEditor(emailAddress)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

addEditor(user)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

addEditors(emailAddresses)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

addMenu(name, subMenus)

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

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

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

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

المعلمات

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

التفويض

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

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

addViewer(emailAddress)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

addViewer(user)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

addViewers(emailAddresses)

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

المعلمات

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

الإرجاع

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

التفويض

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

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

appendRow(rowContents)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

autoResizeColumn(columnPosition)

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

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

copy(name)

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

createDeveloperMetadataFinder()

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

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

المعلمات

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

الإرجاع

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


deleteActiveSheet()

يؤدي هذا الإجراء إلى حذف الورقة النشطة حاليًا.

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

الإرجاع

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

التفويض

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

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

deleteColumn(columnPosition)

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

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

المعلمات

الاسمالنوعالوصف
columnPositionIntegerتمثّل هذه السمة موضع العمود، بدءًا من 1 للعمود الأول.

الإرجاع

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

التفويض

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

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

deleteColumns(columnPosition, howMany)

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

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

المعلمات

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

التفويض

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

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

deleteRow(rowPosition)

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

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

المعلمات

الاسمالنوعالوصف
rowPositionIntegerتمثّل هذه السمة موضع الصف، بدءًا من 1 للصف الأول.

الإرجاع

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

التفويض

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

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

deleteRows(rowPosition, howMany)

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

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

المعلمات

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

التفويض

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

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

deleteSheet(sheet)

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

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

المعلمات

الاسمالنوعالوصف
sheetSheetالورقة التي تريد حذفها.

التفويض

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

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

duplicateActiveSheet()

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

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

getActiveCell()

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

ملاحظة: من الأفضل استخدام getCurrentCell() التي تعرض القيمة الحالية الخلية المميزة.

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

الإرجاع

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

التفويض

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

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

getActiveRange()

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

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

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

الإرجاع

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

التفويض

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

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

انظر أيضًا


getActiveRangeList()

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

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

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

الإرجاع

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

التفويض

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

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

انظر أيضًا


getActiveSheet()

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

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

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

الإرجاع

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


getAs(contentType)

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

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

المعلمات

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

الإرجاع

Blob — البيانات ككائنات ثنائية كبيرة (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 — البيانات ككائنات ثنائية كبيرة (blob).


getColumnWidth(columnPosition)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getCurrentCell()

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

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

الإرجاع

Range - الخلية الحالية

التفويض

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

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

getDataRange()

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

وهذا معادلاً وظيفيًا لإنشاء نطاق تحده A1 (Sheet.getLastColumn()، وSheet.getLastRow()).

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

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

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

الإرجاع

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

التفويض

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

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

getDataSourceFormulas()

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

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

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

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

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

الإرجاع

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

التفويض

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

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

getDataSourcePivotTables()

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

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

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

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

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

الإرجاع

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

التفويض

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

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

getDataSourceRefreshSchedules()

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

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

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

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

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

الإرجاع

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

التفويض

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

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

getDataSourceSheets()

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

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

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

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

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

الإرجاع

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

التفويض

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

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

getDataSourceTables()

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

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

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

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

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

الإرجاع

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

التفويض

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

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

getDataSources()

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

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

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

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

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

الإرجاع

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

التفويض

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

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

getDeveloperMetadata()

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

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

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

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

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

الإرجاع

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

التفويض

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

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

getEditors()

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

الإرجاع

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

التفويض

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

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

getFormUrl()

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

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

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

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

الإرجاع

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

التفويض

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

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

getFrozenColumns()

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

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();
  }
}

المعلمات

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

الإرجاع

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

التفويض

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

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

getRange(a1Notation)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getRangeByName(name)

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

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

المعلمات

الاسمالنوعالوصف
nameStringاسم النطاق الذي تريد الحصول عليه.

الإرجاع

Range — نطاق الخلايا التي تحمل الاسم المحدّد.


getRangeList(a1Notations)

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getRecalculationInterval()

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getSelection()

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

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

الإرجاع

Selection - الاختيار الحالي

التفويض

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

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

getSheetByName(name)

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

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

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

المعلمات

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

الإرجاع

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


getSheetId()

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

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

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

Logger.log(sheet.getSheetId());

الإرجاع

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

التفويض

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

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

getSheetName()

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

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

Logger.log(sheet.getSheetName());

الإرجاع

String - اسم ورقة البيانات

التفويض

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

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

getSheetValues(startRow, startColumn, numRows, numColumns)

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

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

getSheets()

للحصول على كل الأوراق في جدول البيانات هذا

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

الإرجاع

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


getSpreadsheetLocale()

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

// 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 — المنطقة الزمنية المحددة بالصيغة "long" (على سبيل المثال، "America/New_York"، كما هو مذكور بواسطة Joda.org).

التفويض

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

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

getUrl()

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

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

الإرجاع

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

التفويض

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

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

getViewers()

الحصول على قائمة المشاهدين والمعلِّقين لهذا Spreadsheet

الإرجاع

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

التفويض

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

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

hideColumn(column)

يؤدي هذا الإجراء إلى إخفاء العمود أو الأعمدة في النطاق المحدّد.

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

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

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

المعلمات

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

التفويض

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

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

hideRow(row)

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

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

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

المعلمات

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

التفويض

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

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

insertColumnAfter(afterPosition)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertColumnBefore(beforePosition)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertColumnsAfter(afterPosition, howMany)

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertColumnsBefore(beforePosition, howMany)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertDataSourceSheet(spec)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertImage(blobSource, column, row)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

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

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

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

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

المعلمات

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

الإرجاع

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

المعلمات

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

الإرجاع

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertRowAfter(afterPosition)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertRowBefore(beforePosition)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertRowsAfter(afterPosition, howMany)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertRowsBefore(beforePosition, howMany)

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

insertSheet()

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

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

insertSheet(sheetIndex)

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

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

المعلمات

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

insertSheet(sheetIndex, options)

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

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

المعلمات

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

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

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

insertSheet(options)

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

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

المعلمات

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

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

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

insertSheet(sheetName)

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

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

المعلمات

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

insertSheet(sheetName, sheetIndex)

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

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

المعلمات

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

insertSheet(sheetName, sheetIndex, options)

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

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

المعلمات

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

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

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

insertSheet(sheetName, options)

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

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

المعلمات

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

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

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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

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

insertSheetWithDataSourceTable(spec)

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

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

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

المعلمات

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

الإرجاع

Sheet — ورقة البيانات الجديدة

التفويض

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