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

Class SpreadsheetApp

الوصول إلى ملفات "جداول بيانات Google" وإنشاؤها. هذه الفئة هي الفئة الرئيسية لخدمة جداول البيانات.

أماكن إقامة

الموقع	النوع	الوصف
`AutoFillSeries`	`AutoFillSeries`	تعداد لأنواع السلاسل المستخدمة لحساب قيم الملء التلقائي.
`BandingTheme`	`BandingTheme`	تعداد موضوعات التباين المحتملة.
`BooleanCriteria`	`BooleanCriteria`	تعداد المعايير المنطقية للتنسيق الشرطي.
`BorderStyle`	`BorderStyle`	تعداد للأنماط الصالحة لضبط الحدود على `Range`.
`ColorType`	`ColorType`	تعداد لأنواع الألوان المحتملة.
`CopyPasteType`	`CopyPasteType`	تعداد لأنواع اللصق المحتملة.
`DataExecutionErrorCode`	`DataExecutionErrorCode`	تعداد لرموز أخطاء تنفيذ البيانات المحتملة.
`DataExecutionState`	`DataExecutionState`	تعداد لحالات تنفيذ البيانات المحتملة.
`DataSourceParameterType`	`DataSourceParameterType`	تعداد لأنواع مَعلمات مصدر البيانات المحتملة
`DataSourceRefreshScope`	`DataSourceRefreshScope`	تعداد نطاقات إعادة تحميل مصدر البيانات المحتملة
`DataSourceType`	`DataSourceType`	تعداد لأنواع مصادر البيانات المحتملة.
`DataValidationCriteria`	`DataValidationCriteria`	تعداد يمثل معايير التحقق من صحة البيانات التي يمكن تعيينها على نطاق.
`DateTimeGroupingRuleType`	`DateTimeGroupingRuleType`	تعداد قاعدة تجميع التاريخ والوقت.
`DeveloperMetadataLocationType`	`DeveloperMetadataLocationType`	تعداد لأنواع المواقع الجغرافية للبيانات الوصفية المحتملة لمطوّري البرامج.
`DeveloperMetadataVisibility`	`DeveloperMetadataVisibility`	تعداد أذونات الوصول المحتملة إلى البيانات الوصفية لمطوّر البرامج
`Dimension`	`Dimension`	تعداد الأبعاد المحتملة لجدول بيانات.
`Direction`	`Direction`	تعداد للاتجاهات المحتملة التي يمكن للمرء نقلها داخل جدول بيانات باستخدام السهم المفاتيح.
`FrequencyType`	`FrequencyType`	تعداد لأنواع التكرار المحتملة.
`GroupControlTogglePosition`	`GroupControlTogglePosition`	تعداد لعدد المواضع التي يمكن أن يظهر فيها مفتاح تبديل عنصر التحكّم في المجموعة.
`InterpolationType`	`InterpolationType`	تعداد لأنواع استقراء تدرج تنسيق الشرطي.
`PivotTableSummarizeFunction`	`PivotTableSummarizeFunction`	يشير ذلك المصطلح إلى تعداد الدوال التي يمكن استخدامها لتلخيص القيم في جدول محوري.
`PivotValueDisplayType`	`PivotValueDisplayType`	تعداد للطرق التي يمكن أن تظهر بها قيمة محورية.
`ProtectionType`	`ProtectionType`	تعداد يمثل أجزاء جدول البيانات التي يمكن حمايتها من التعديلات.
`RecalculationInterval`	`RecalculationInterval`	يشير ذلك المصطلح إلى تعداد الفواصل الزمنية المحتمَلة التي يمكن استخدامها في إعادة احتساب جداول البيانات.
`RelativeDate`	`RelativeDate`	قائمة باختيارات التاريخ النسبي لاحتساب قيمة ستُستخدَم في `BooleanCriteria` المستندة إلى التاريخ
`SheetType`	`SheetType`	تعداد للأنواع المختلفة من الأوراق التي يمكن أن توجد في جدول البيانات.
`SortOrder`	`SortOrder`	تعداد نظام الفرز.
`TextDirection`	`TextDirection`	تعداد اتجاهات النص الصالحة.
`TextToColumnsDelimiter`	`TextToColumnsDelimiter`	تعداد محددات معدة مسبقًا لتقسيم النص إلى أعمدة.
`ThemeColorType`	`ThemeColorType`	مجموعة من أنواع ألوان المظاهر المحتملة
`ValueType`	`ValueType`	تعداد أنواع القيم التي يعرضها `Range.getValue()` و`Range.getValues()` من فئة النطاق في خدمة جدول البيانات. قيم التعداد الواردة أدناه بالإضافة إلى `Number` أو `Boolean` أو `Date` أو `String`.
`WrapStrategy`	`WrapStrategy`	تعداد للاستراتيجيات المستخدمة لإحاطة الخلايا.

الطُرق

الطريقة	نوع الإرجاع	وصف قصير
`create(name)`	`Spreadsheet`	تنشئ جدول بيانات جديدًا بالاسم المعين.
`create(name, rows, columns)`	`Spreadsheet`	تنشئ جدول بيانات جديدًا بالاسم المعين والعدد المحدد من الصفوف والأعمدة.
`enableAllDataSourcesExecution()`	`void`	تفعِّل هذه السياسة تنفيذ البيانات لجميع أنواع مصادر البيانات.
`enableBigQueryExecution()`	`void`	يتم تفعيل تنفيذ البيانات لمصادر بيانات BigQuery.
`enableLookerExecution()`	`void`	تفعِّل تنفيذ البيانات لمصادر بيانات Looker.
`flush()`	`void`	يطبِّق هذا الخيار جميع تغييرات جدول البيانات المعلَّقة.
`getActive()`	`Spreadsheet`	عرض جدول البيانات النشط حاليًا أو `null` إذا لم يكن هناك جدول بيانات.
`getActiveRange()`	`Range`	لعرض النطاق المحدد في ورقة البيانات النشطة، أو `null` إذا لم يكن هناك نطاق نشط.
`getActiveRangeList()`	`RangeList`	عرض قائمة النطاقات النشطة في ورقة البيانات النشطة أو `null` إذا لم يكن هناك نطاقات المحددة.
`getActiveSheet()`	`Sheet`	للحصول على الورقة النشطة في جدول بيانات.
`getActiveSpreadsheet()`	`Spreadsheet`	عرض جدول البيانات النشط حاليًا أو `null` إذا لم يكن هناك جدول بيانات.
`getCurrentCell()`	`Range`	لعرض الخلية الحالية (المظللة) التي تم تحديدها في أحد النطاقات النشطة في ورقة البيانات النشطة أو `null` إذا لم تكن هناك خلية حالية.
`getSelection()`	`Selection`	لعرض `Selection` الحالي في جدول البيانات.
`getUi()`	`Ui`	لعرض مثيل لبيئة واجهة المستخدم في جدول البيانات والتي تسمح للنص البرمجي إضافة ميزات مثل القوائم ومربعات الحوار والأشرطة الجانبية.
`newCellImage()`	`CellImageBuilder`	تنشئ أداة إنشاء لـ `CellImage`.
`newColor()`	`ColorBuilder`	تنشئ أداة إنشاء لـ `Color`.
`newConditionalFormatRule()`	`ConditionalFormatRuleBuilder`	تنشئ أداة إنشاء لقاعدة التنسيق الشرطي.
`newDataSourceSpec()`	`DataSourceSpecBuilder`	تنشئ أداة إنشاء لـ `DataSourceSpec`.
`newDataValidation()`	`DataValidationBuilder`	لإنشاء أداة إنشاء لقاعدة التحقّق من البيانات
`newFilterCriteria()`	`FilterCriteriaBuilder`	تنشئ أداة إنشاء لـ `FilterCriteria`.
`newRichTextValue()`	`RichTextValueBuilder`	تنشئ أداة إنشاء لقيمة نص منسق.
`newTextStyle()`	`TextStyleBuilder`	تنشئ أداة إنشاء لنمط النص.
`open(file)`	`Spreadsheet`	لفتح جدول البيانات الذي يتوافق مع كائن الملف المحدد.
`openById(id)`	`Spreadsheet`	لفتح جدول البيانات بالمعرف المحدد.
`openByUrl(url)`	`Spreadsheet`	لفتح جدول البيانات باستخدام عنوان URL المحدد.
`setActiveRange(range)`	`Range`	لضبط النطاق المحدّد على أنّه `active range`، أعلى قيمة الخلية اليسرى في نطاق مثل `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	تضبط هذه السياسة قائمة النطاقات المحدّدة على أنّها `active ranges`.
`setActiveSheet(sheet)`	`Sheet`	لضبط الورقة النشطة في جدول بيانات
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	لضبط الورقة النشطة في جدول بيانات، مع توفُّر خيار استعادة أحدث اختيار داخل تلك الورقة.
`setActiveSpreadsheet(newActiveSpreadsheet)`	`void`	لإعداد جدول البيانات النشط
`setCurrentCell(cell)`	`Range`	لضبط الخلية المحددة على أنّها `current cell`.

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

`create(name)`

تنشئ جدول بيانات جديدًا بالاسم المعين.

// The code below creates a new spreadsheet "Finances" and logs the URL for it
var ssNew = SpreadsheetApp.create("Finances");
Logger.log(ssNew.getUrl());

المعلمات

الاسم	النوع	الوصف
`name`	`String`	اسم جدول البيانات.

الإرجاع

Spreadsheet - جدول بيانات جديد

التفويض

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

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

`create(name, rows, columns)`

تنشئ هذه الدالة جدول بيانات جديدًا بالاسم المحدَّد والعدد المحدَّد من الصفوف والأعمدة.

// The code below creates a new spreadsheet "Finances" with 50 rows and 5 columns and logs the
// URL for it
var ssNew = SpreadsheetApp.create("Finances", 50, 5);
Logger.log(ssNew.getUrl());

المعلمات

الاسم	النوع	الوصف
`name`	`String`	اسم جدول البيانات.
`rows`	`Integer`	عدد الصفوف في جدول البيانات.
`columns`	`Integer`	عدد الأعمدة في جدول البيانات.

الإرجاع

Spreadsheet - جدول بيانات جديد

التفويض

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

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

`enableAllDataSourcesExecution()`

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

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

// Turns data execution on for all types of data sources.
SpreadsheetApp.enableAllDataSourcesExecution();

// 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 the first data source sheet in the spreadsheet and refreshes the data.
ss.getDataSourceSheets()[0].refreshData();

التفويض

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

https://www.googleapis.com/auth/bigquery.readonly

`enableBigQueryExecution()`

يتم تفعيل تنفيذ البيانات لمصادر بيانات BigQuery.

يؤدي تنفيذ البيانات لمصدر بيانات BigQuery إلى حدوث استثناء في حال عدم تفعيله.

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

// 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 the first data source sheet in the spreadsheet and refreshes the BigQuery data.
ss.getDataSourceSheets()[0].refreshData();

التفويض

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

https://www.googleapis.com/auth/bigquery.readonly

`enableLookerExecution()`

تفعِّل تنفيذ البيانات لمصادر بيانات Looker.

يؤدي تنفيذ البيانات لمصدر بيانات Looker إلى حدوث استثناء في حال عدم تفعيله.

// Turns data execution on for Looker data sources.
SpreadsheetApp.enableLookerExecution();

// 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 the first data source sheet in the spreadsheet and refreshes the associated Looker
// data.
ss.getDataSourceSheets()[0].refreshData();

`flush()`

يطبِّق هذا الخيار جميع تغييرات جدول البيانات المعلَّقة.

أحيانًا يتم تجميع عمليات جداول البيانات معًا لتحسين الأداء، مثل عندما إجراء اتصالات متعددة إلى Range.getValue(). ومع ذلك، قد ترغب أحيانًا في التأكد من أن جميع التغييرات المعلّقة على الفور، على سبيل المثال، لعرض بيانات المستخدمين أثناء تنفيذ نص برمجي.

// The code below changes the background color of cells A1 and B1 twenty times. You should be
// able to see the updates live in the spreadsheet. If flush() is not called, the updates may
// be applied live or may all be applied at once when the script completes.
function colors() {
  var sheet = SpreadsheetApp.getActiveSheet();
  for (var i = 0; i < 20; i++) {
    if ((i % 2) == 0) {
      sheet.getRange('A1').setBackground('green');
      sheet.getRange('B1').setBackground('red');
    } else {
      sheet.getRange('A1').setBackground('red');
      sheet.getRange('B1').setBackground('green');
    }
    SpreadsheetApp.flush();
  }
}

`getActive()`

عرض جدول البيانات النشط حاليًا أو null إذا لم يكن هناك جدول بيانات.

يمكن للدوال التي يتم تشغيلها في سياق جدول البيانات الحصول على مرجع إلى كائن جدول البيانات المقابل عن طريق استدعاء هذه الدالة.

// The code below logs the URL for the active spreadsheet.
Logger.log(SpreadsheetApp.getActive().getUrl());

الإرجاع

Spreadsheet - كائن جدول البيانات النشط

التفويض

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

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

`getActiveRange()`

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

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

// The code below logs the background color for the active range.
var colorObject = SpreadsheetApp.getActiveRange().getBackgroundObject();
// Assume the color has ColorType.RGB.
Logger.log(colorObject.asRgbColor().asHexString());

الإرجاع

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

التفويض

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

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

`getActiveRangeList()`

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

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

// Returns the list of active ranges.
var rangeList = SpreadsheetApp.getActiveRangeList();

الإرجاع

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

التفويض

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

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

`getActiveSheet()`

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

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

// The code below logs the name of the active sheet.
Logger.log(SpreadsheetApp.getActiveSheet().getName());

الإرجاع

Sheet — كائن "ورقة البيانات" النشط

التفويض

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

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

`getActiveSpreadsheet()`

عرض جدول البيانات النشط حاليًا أو null إذا لم يكن هناك جدول بيانات.

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

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

الإرجاع

Spreadsheet - كائن جدول البيانات النشط

التفويض

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

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

`getCurrentCell()`

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

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

الإرجاع

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

التفويض

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

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

`getSelection()`

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

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

الإرجاع

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

التفويض

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

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

`getUi()`

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

// Add a custom menu to the active spreadsheet, including a separator and a sub-menu.
function onOpen(e) {
  SpreadsheetApp.getUi()
      .createMenu('My Menu')
      .addItem('My menu item', 'myFunction')
      .addSeparator()
      .addSubMenu(SpreadsheetApp.getUi().createMenu('My sub-menu')
          .addItem('One sub-menu item', 'mySecondFunction')
          .addItem('Another sub-menu item', 'myThirdFunction'))
      .addToUi();
}

الإرجاع

Ui - مثيل لبيئة واجهة المستخدم في جدول البيانات هذا

`newCellImage()`

تنشئ أداة إنشاء لـ CellImage.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets cell A1 on Sheet1.
const range = sheet.getRange('A1');

// Builds an image using a source URL.
const cellImage = SpreadsheetApp.newCellImage()
  .setSourceUrl('https://www.gstatic.com/images/branding/productlogos/apps_script/v10/web-64dp/logo_apps_script_color_1x_web_64dp.png')
  .build();

// Sets the image in cell A1.
range.setValue(cellImage);

الإرجاع

CellImageBuilder — أداة الإنشاء الجديدة.

`newColor()`

تنشئ أداة إنشاء لـ Color.

var rgbColor = SpreadsheetApp.newColor().setRgbColor("#FF0000").build();

الإرجاع

ColorBuilder — أداة الإنشاء الجديدة.

`newConditionalFormatRule()`

تنشئ أداة إنشاء لقاعدة التنسيق الشرطي.

// Adds a conditional format rule to a sheet that causes all cells in range A1:B3 to turn red
// if they contain a number between 1 and 10.
var sheet = SpreadsheetApp.getActive().getActiveSheet();
var range = sheet.getRange('A1:B3');
var rule = SpreadsheetApp.newConditionalFormatRule()
    .whenNumberBetween(1, 10)
    .setBackground("#FF0000")
    .setRanges([range])
    .build()
var rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

الإرجاع

ConditionalFormatRuleBuilder — أداة الإنشاء الجديدة.

`newDataSourceSpec()`

تنشئ أداة إنشاء لـ DataSourceSpec.

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

// Enables BigQuery.
SpreadsheetApp.enableBigQueryExecution();

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

الإرجاع

DataSourceSpecBuilder — أداة الإنشاء الجديدة.

`newDataValidation()`

تنشئ أداة إنشاء لقاعدة التحقق من صحة البيانات.

var cell = SpreadsheetApp.getActive().getRange('A1');
var rule = SpreadsheetApp.newDataValidation()
    .requireNumberBetween(1, 100)
    .setAllowInvalid(false)
    .setHelpText('Number must be between 1 and 100.')
    .build();
cell.setDataValidation(rule);

الإرجاع

DataValidationBuilder — أداة الإنشاء الجديدة.

`newFilterCriteria()`

تنشئ أداة إنشاء لـ FilterCriteria.

// 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 Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Sets the range to A1:D20.
const range = sheet.getRange('A1:D20');

// Creates a filter and applies it to the specified range.
range.createFilter();

// Gets the current filter for the range and creates filter criteria that only shows cells
// that aren't empty.
const filter = range.getFilter();
const criteria = SpreadsheetApp.newFilterCriteria().whenCellNotEmpty().build();

// Sets the criteria to  column C.
filter.setColumnFilterCriteria(3, criteria);

الإرجاع

FilterCriteriaBuilder — أداة الإنشاء الجديدة

`newRichTextValue()`

تنشئ أداة إنشاء لقيمة نص منسق.

// Sets cell A1 to have the text "Hello world", with "Hello" bolded.
var cell = SpreadsheetApp.getActive().getRange('A1');
var bold = SpreadsheetApp.newTextStyle().setBold(true).build();
var value = SpreadsheetApp.newRichTextValue()
    .setText("Hello world")
    .setTextStyle(0, 5, bold)
    .build();
cell.setRichTextValue(value);

الإرجاع

RichTextValueBuilder — أداة الإنشاء الجديدة.

`newTextStyle()`

تنشئ أداة إنشاء لنمط النص.

// Sets range A1:B3 to have red, size 22, bolded, underlined text.
var range = SpreadsheetApp.getActive().getRange('A1:B3');
var style = SpreadsheetApp.newTextStyle()
    .setForegroundColor("red")
    .setFontSize(22)
    .setBold(true)
    .setUnderline(true)
    .build();
range.setTextStyle(style);

الإرجاع

TextStyleBuilder — أداة الإنشاء الجديدة.

`open(file)`

لفتح جدول البيانات الذي يتوافق مع كائن الملف المحدد.

// Get any starred spreadsheets from Google Drive, then open the spreadsheets and log the name
// of the first sheet within each spreadsheet.
var files = DriveApp.searchFiles(
    'starred = true and mimeType = "' + MimeType.GOOGLE_SHEETS + '"');
while (files.hasNext()) {
  var spreadsheet = SpreadsheetApp.open(files.next());
  var sheet = spreadsheet.getSheets()[0];
  Logger.log(sheet.getName());
}

المعلمات

الاسم	النوع	الوصف
`file`	`File`	الملف المراد فتحه.

الإرجاع

Spreadsheet — جدول البيانات

التفويض

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

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

`openById(id)`

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

// The code below opens a spreadsheet using its ID and logs the name for it.
// Note that the spreadsheet is NOT physically opened on the client side.
// It is opened on the server only (for modification by the script).
var ss = SpreadsheetApp.openById("abc1234567");
Logger.log(ss.getName());

المعلمات

الاسم	النوع	الوصف
`id`	`String`	المعرّف الفريد لجدول البيانات.

الإرجاع

Spreadsheet - كائن جدول البيانات بالمعرّف المحدّد

التفويض

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

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

`openByUrl(url)`

لفتح جدول البيانات باستخدام عنوان URL المحدد. عرض استثناء برمجة نصية إذا لم يكن عنوان URL موجودًا أو لا يملك المستخدم إذنًا بالوصول إليها.

// Opens a spreadsheet by its URL and logs its name.
// Note that the spreadsheet doesn't physically open on the client side.
// It opens on the server only (for modification by the script).
var ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit');
console.log(ss.getName());

المعلمات

الاسم	النوع	الوصف
`url`	`String`	عنوان URL لجدول البيانات.

الإرجاع

Spreadsheet — كائن جدول البيانات الذي يحمل عنوان URL المحدّد.

التفويض

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

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

`setActiveRange(range)`

لضبط النطاق المحدّد على أنّه active range، أعلى قيمة الخلية اليسرى في نطاق مثل current cell.

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

// The code below sets range C1:D4 in the first sheet as the active range.
var range = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('C1:D4');
SpreadsheetApp.setActiveRange(range);

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

المعلمات

الاسم	النوع	الوصف
`range`	`Range`	النطاق المراد تحويله إلى النطاق النشط.

الإرجاع

Range - النطاق النشط الجديد

`setActiveRangeList(rangeList)`

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

// The code below sets ranges [D4, B2:C4] in the active sheet as the active ranges.
var rangeList = SpreadsheetApp.getActiveSheet().getRanges(['D4', 'B2:C4']);
SpreadsheetApp.setActiveRangeList(rangeList);

var selection = SpreadsheetApp.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

`setActiveSheet(sheet)`

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

// The code below makes the 2nd sheet active in the active spreadsheet.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
SpreadsheetApp.setActiveSheet(spreadsheet.getSheets()[1]);

المعلمات

الاسم	النوع	الوصف
`sheet`	`Sheet`	الورقة النشطة الجديدة.

الإرجاع

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

`setActiveSheet(sheet, restoreSelection)`

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

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

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

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

المعلمات

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

الإرجاع

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

التفويض

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

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

`setActiveSpreadsheet(newActiveSpreadsheet)`

لإعداد جدول البيانات النشط

// The code below makes the spreadsheet with key "1234567890" the active spreadsheet
var ss = SpreadsheetApp.openById("1234567890");
SpreadsheetApp.setActiveSpreadsheet(ss);

المعلمات

الاسم	النوع	الوصف
`newActiveSpreadsheet`	`Spreadsheet`	جدول البيانات المراد جعله جدول البيانات النشط.

`setCurrentCell(cell)`

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

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

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

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

// The code below sets the cell B5 in the first sheet as the current cell.
var cell = SpreadsheetApp.getActiveSpreadsheet().getSheets()[0].getRange('B5');
SpreadsheetApp.setCurrentCell(cell);

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

المعلمات

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

الإرجاع

Range - الخلية الحالية التي تم إعدادها حديثًا

التفويض

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

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