דף זה תורגם על ידי Cloud Translation API.

Class SpreadsheetApp

לגשת לקובצי Google Sheets וליצור אותם. הכיתה הזו היא כיתת ההורה של שירות הגיליונות האלקטרוניים.

מאפיינים

נכס	סוג	תיאור
`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`	יצירת Builder עבור `CellImage`.
`newColor()`	`ColorBuilder`	יצירת Builder עבור `Color`.
`newConditionalFormatRule()`	`ConditionalFormatRuleBuilder`	יצירת כלי ליצירת כלל של עיצוב מותנה.
`newDataSourceSpec()`	`DataSourceSpecBuilder`	יצירת Builder עבור `DataSourceSpec`.
`newDataValidation()`	`DataValidationBuilder`	יצירת כלי ליצירת כלל לאימות נתונים.
`newFilterCriteria()`	`FilterCriteriaBuilder`	יצירת Builder עבור `FilterCriteria`.
`newRichTextValue()`	`RichTextValueBuilder`	יצירת builder לערך של טקסט עשיר.
`newTextStyle()`	`TextStyleBuilder`	התכונה הזו יוצרת Builder לסגנון טקסט.
`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 – האובייקט הפעיל ב-Sheets

אישור

סקריפטים שמשתמשים בשיטה הזו מחייבים הרשאה עם אחד או יותר מהיקפי ההרשאות הבאים:

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

יצירת Builder עבור 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 – ה-builder החדש.

`newColor()`

יצירת Builder עבור Color.

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

חזרה

ColorBuilder – ה-builder החדש.

`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 – ה-builder החדש.

`newDataSourceSpec()`

יצירת Builder עבור 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 – ה-builder החדש.

`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 – ה-builder החדש.

`newFilterCriteria()`

יצירת Builder עבור 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 – ה-builder החדש

`newRichTextValue()`

יצירת builder לערך של טקסט עשיר.

// 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 – ה-builder החדש.

`newTextStyle()`

התכונה הזו יוצרת Builder לסגנון טקסט.

// 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 – ה-builder החדש.

`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 Sheets, אלא אם הגיליון שייך לגיליון אלקטרוני אחר.

// 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 Sheets מוצג הגיליון שנבחר, אלא אם הוא שייך לגיליון גיליון אלקטרוני אחר.

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