الوصول إلى ملفات "جداول بيانات 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 | عرض البيانات داخل هذا الكائن على هيئة كائن ثنائي كبير (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())
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
key | String | مفتاح البيانات الوصفية الجديدة للمطوِّر. |
استرجاع الكرة
Spreadsheet
- جدول البيانات هذا مخصّص للتسلسل.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, visibility)
تضيف البيانات الوصفية لمطوّر البرامج مع المفتاح المحدّد ومستوى الرؤية إلى جدول البيانات.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds the key 'NAME' in the developer metadata for the spreadsheet and sets the visibility // to the developer project that created the metadata. ss.addDeveloperMetadata('NAME', SpreadsheetApp.DeveloperMetadataVisibility.PROJECT); // Gets the first developer metadata object and logs its key and visibility setting. const developerMetaData = ss.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(`Key: ${developerMetaData.getKey()}, . Visibility: ${developerMetaData.getVisibility()}`);
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
key | String | مفتاح البيانات الوصفية الجديدة للمطوِّر. |
visibility | DeveloperMetadataVisibility | مستوى ظهور البيانات الوصفية الجديدة للمطوِّرين. |
استرجاع الكرة
Spreadsheet
- جدول البيانات هذا مخصّص للتسلسل.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, value)
تضيف البيانات الوصفية لمطوّر البرامج مع المفتاح والقيمة المحدّدَين إلى جدول البيانات.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata for the // spreadsheet. ss.addDeveloperMetadata('NAME', 'GOOGLE'); // Gets the first developer metadata object and logs its key and value. const developerMetaData = ss.getDeveloperMetadata()[0]; console.log(developerMetaData.getKey()); console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}`);
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
key | String | مفتاح البيانات الوصفية الجديدة للمطوِّر. |
value | String | قيمة البيانات الوصفية الجديدة لمطوّر البرامج |
استرجاع الكرة
Spreadsheet
- جدول البيانات هذا مخصّص للتسلسل.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addDeveloperMetadata(key, value, visibility)
تتم إضافة البيانات الوصفية لمطوّر البرامج مع المفتاح والقيمة وإذن الوصول المحدّدَين إلى جدول البيانات.
// Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility // to any developer project with document access. ss.addDeveloperMetadata('NAME', 'GOOGLE', SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT); // Gets the first developer metadata object and logs its key, value, and visibility setting. const developerMetaData = ss.getDeveloperMetadata()[0]; console.log(`Key: ${developerMetaData.getKey()}, Value: ${developerMetaData.getValue()}, Visibility: ${developerMetaData.getVisibility()}`);
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
key | String | مفتاح البيانات الوصفية الجديدة للمطوِّر. |
value | String | قيمة البيانات الوصفية الجديدة لمطوّر البرامج |
visibility | DeveloperMetadataVisibility | مستوى ظهور البيانات الوصفية الجديدة للمطوِّرين. |
استرجاع الكرة
Spreadsheet
- جدول البيانات هذا مخصّص للتسلسل.
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditor(emailAddress)
لإضافة المستخدم المحدّد إلى قائمة المحرِّرين في Spreadsheet
. إذا كان المستخدم مدرجًا في قائمة المشاهدين، تؤدي هذه الطريقة إلى إزالة المستخدم من قائمة المشاهدين.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
emailAddress | String | عنوان البريد الإلكتروني للمستخدم المطلوب إضافته. |
استرجاع الكرة
Spreadsheet
- جهاز Spreadsheet
هذا للسلاسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditor(user)
لإضافة المستخدم المحدّد إلى قائمة المحرِّرين في Spreadsheet
. إذا كان المستخدم مدرجًا في قائمة المشاهدين، تؤدي هذه الطريقة إلى إزالة المستخدم من قائمة المشاهدين.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
user | User | تمثيل للمستخدم تتم إضافته. |
استرجاع الكرة
Spreadsheet
- جهاز Spreadsheet
هذا للسلاسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addEditors(emailAddresses)
لإضافة مجموعة المستخدمين المحدّدة إلى قائمة المحرِّرين في Spreadsheet
. إذا كان أيٌّ من المستخدمين مدرجًا في قائمة المشاهدين، تعمل هذه الطريقة على الترويج له خارج قائمة المشاهدين.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
emailAddresses | String[] | مصفوفة من عناوين البريد الإلكتروني للمستخدمين المراد إضافتها. |
استرجاع الكرة
Spreadsheet
- جهاز Spreadsheet
هذا للسلاسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addMenu(name, subMenus)
ينشئ قائمة جديدة في واجهة مستخدم جدول البيانات.
يقوم كل إدخال قائمة بتشغيل دالة يحددها المستخدم. عادة، تريد استدعائها من الدالة 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)
لإضافة المستخدم المحدّد إلى قائمة المشاهدين في Spreadsheet
. إذا كان المستخدم بالفعل في قائمة
المحررين، فلن يكون لهذه الطريقة أي تأثير.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
user | User | تمثيل للمستخدم تتم إضافته. |
استرجاع الكرة
Spreadsheet
- جهاز Spreadsheet
هذا للسلاسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
addViewers(emailAddresses)
لإضافة مصفوفة المستخدمين المحددة إلى قائمة العارضين لـ Spreadsheet
. إذا كان أي من المستخدمين مدرجًا بالفعل في قائمة المحررين، فلن يكون لهذه الطريقة أي تأثير عليهم.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
emailAddresses | String[] | مصفوفة من عناوين البريد الإلكتروني للمستخدمين المراد إضافتها. |
استرجاع الكرة
Spreadsheet
- جهاز Spreadsheet
هذا للسلاسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
appendRow(rowContents)
لإلحاق صف بأسفل منطقة البيانات الحالية في ورقة البيانات. إذا كان محتوى الخلية يبدأ بـ =
، يتم تفسيره على أنه معادلة.
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
يمكن أيضًا مراجعة
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 التي تم إنشاؤها حديثًا لحصص أكثر صرامة مؤقتًا.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
contentType | String | نوع MIME المطلوب التحويل إليه. بالنسبة إلى معظم الكائنات الثنائية الكبيرة، يكون 'application/pdf' هو الخيار الصالح الوحيد. بالنسبة إلى الصور بتنسيق BMP أو GIF أو JPEG أو PNG، يكون أي من 'image/bmp' أو 'image/gif' أو 'image/jpeg' أو 'image/png' صالحًا أيضًا. |
استرجاع الكرة
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
— البيانات في صورة كائن ثنائي كبير (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 للنموذج الذي يتم عرضه غير محدد. بدلاً من ذلك، يمكن استرداد عمليات ربط عناوين 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
— المنطقة الزمنية المحددة بتنسيق "طويل" (على سبيل المثال، "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);
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
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). الحد الأقصى المسموح به لحجم الكائن الثنائي الكبير (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 | الكائن الثنائي الكبير (blob) الذي يحتوي على محتوى الصورة ونوع 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 | الكائن الثنائي الكبير (blob) الذي يحتوي على محتوى الصورة ونوع 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
تمتد على الورقة بأكملها باستخدام مواصفات مصدر البيانات المحددة، وتبدأ في تنفيذ البيانات. كتأثير جانبي، يجعل الورقة
الجديدة الورقة النشطة.
ينشئ استثناء إذا لم يكن نوع مصدر البيانات مفعَّلاً. استخدِم طرق SpreadsheetApp#enable...Execution()
لتفعيل تنفيذ البيانات لنوع معيّن من مصدر البيانات.
// Activates BigQuery operations. SpreadsheetApp.enableBigQueryExecution(); // Opens the spreadsheet file by its URL. If you created your script from within a // Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet() instead. // TODO(developer): Replace the URL with your own. const ss = SpreadsheetApp.openByUrl('https://docs.google.com/spreadsheets/d/abc123456/edit'); // Adds a sheet and sets cell A1 as the parameter cell. const parameterCell = ss.insertSheet('parameterSheet').getRange('A1'); // Sets the value of the parameter cell to 'Duke'. parameterCell.setValue('Duke'); const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' + '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL'; // Adds a data source with a query parameter. // TODO(developer): Update the project ID to your own Google Cloud project ID. const dataSourceSpec = SpreadsheetApp.newDataSourceSpec() .asBigQuery() .setProjectId('project-id-1') .setRawQuery(query) .setParameterFromCell('SCHOOL', 'parameterSheet!A1') .build(); // Adds sheets for the data source and data source table to the spreadsheet. ss.insertSheetWithDataSourceTable(dataSourceSpec);
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
spec | DataSourceSpec | مواصفات مصدر البيانات التي يجب الإدراج معها. |
استرجاع الكرة
Sheet
— ورقة البيانات الجديدة
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
isColumnHiddenByUser(columnPosition)
تعرض ما إذا كان العمود المعيّن مخفيًا من قِبل المستخدم.
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
في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.
بالنسبة إلى ملفات Drive، سيؤدي هذا أيضًا إلى إزالة المستخدم من قائمة العارضين.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
emailAddress | String | عنوان البريد الإلكتروني للمستخدم المطلوب إزالته. |
استرجاع الكرة
Spreadsheet
- جهاز Spreadsheet
هذا للسلاسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeEditor(user)
لإزالة المستخدم المحدّد من قائمة المحرِّرين في Spreadsheet
. ولا تحظر هذه الطريقة المستخدمين من الوصول إلى Spreadsheet
إذا كانوا ينتمون إلى فئة من المستخدمين الذين لديهم إذن وصول عام، مثلاً إذا تمت مشاركة Spreadsheet
مع نطاق المستخدم بأكمله، أو إذا كانت Spreadsheet
في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.
بالنسبة إلى ملفات Drive، سيؤدي هذا أيضًا إلى إزالة المستخدم من قائمة العارضين.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
user | User | تمثيل للمستخدم المطلوب إزالته. |
استرجاع الكرة
Spreadsheet
- جهاز Spreadsheet
هذا للسلاسل
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
removeMenu(name)
يؤدي هذا الإجراء إلى إزالة قائمة أضافها "addMenu(name, subMenus)
". يجب أن يكون للوسيطة name
القيمة نفسها لاستدعاء addMenu(name, subMenus)
.
// The onOpen function is executed automatically every time a Spreadsheet is loaded function onOpen() { 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
في مساحة تخزين سحابي مشتركة يمكن للمستخدم الوصول إليها.
بالنسبة إلى ملفات 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 | Tf 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 و10000 (شامل)، وأن يتم ضبطها تلقائيًا على 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 | المنطقة الزمنية المحددة بالتنسيق "الطويل" (على سبيل المثال، "America/New_York" كما مدرج في Joda.org). |
التفويض
تتطلب النصوص البرمجية التي تستخدم هذه الطريقة الحصول على تفويض باستخدام واحد أو أكثر من النطاقات التالية:
-
https://www.googleapis.com/auth/spreadsheets.currentonly
-
https://www.googleapis.com/auth/spreadsheets
show(userInterface)
تعرِض مكوِّن واجهة مستخدم مخصّصًا في مربّع حوار متمركز في إطار عرض متصفّح المستخدم. عدم تعليق تنفيذ النص البرمجي من جهة الخادم. للاتصال من جهة الخادم، يجب أن يجري مكوّن واجهة المستخدم استدعاءات غير متزامنة للنص البرمجي من جهة الخادم.
إذا كان النص البرمجي من جهة الخادم يعرض في السابق مربّع حوار لم يتم رفضه بعد، سيتم استبدال مربّع الحوار الحالي بواجهة مستخدم مربّع الحوار المطلوب حديثًا.
يعرض مقتطف الرمز التالي تطبيق HtmlService
بسيطًا في مربّع حوار يتضمّن العنوان والارتفاع والعرض المحدّدَين:
var htmlApp = HtmlService .createHtmlOutput('<p>A change of speed, a change of style...</p>') .setTitle('My HtmlService Application') .setWidth(250) .setHeight(300); SpreadsheetApp.getActiveSpreadsheet().show(htmlApp); // The script resumes execution immediately after showing the dialog.
المَعلمات
الاسم | النوع | الوصف |
---|---|---|
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