Class SpreadsheetApp

SpreadsheetApp

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

תכונות

נכסתיאורהתיאור
AutoFillSeriesAutoFillSeriesספירה של סוגי הסדרות שמשמשות לחישוב ערכים שמולאו באופן אוטומטי.
BandingThemeBandingThemeזהו המספור של עיצובי התדרים האפשריים.
BooleanCriteriaBooleanCriteriaמספר של קריטריונים בוליאניים בעיצוב מותנה.
BorderStyleBorderStyleזהו ספירה של הסגנונות התקינים להגדרת גבולות ב-Range.
ColorTypeColorTypeהמספור של סוגי הצבעים האפשריים.
CopyPasteTypeCopyPasteTypeהמספור של סוגי ההדבקה האפשריים.
DataExecutionErrorCodeDataExecutionErrorCodeזהו מונה של קודי שגיאה אפשריים לביצוע נתונים.
DataExecutionStateDataExecutionStateזה המספור של המצבים האפשריים לביצוע נתונים.
DataSourceParameterTypeDataSourceParameterTypeזהו ספירה של סוגי הפרמטרים האפשריים של מקור נתונים.
DataSourceRefreshScopeDataSourceRefreshScopeזהו המספור של היקפי הרענון האפשריים של מקור הנתונים.
DataSourceTypeDataSourceTypeאלה סוגי מקורות הנתונים האפשריים.
DataValidationCriteriaDataValidationCriteriaספירה שמייצגת את הקריטריונים לאימות נתונים שניתן להגדיר בטווח.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeספירה של כלל קיבוץ לפי תאריך ושעה.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeזהו המספור של סוגי המיקומים האפשריים של מטא נתונים של מפתחים.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityמספר הרשאות הגישה האפשריות למטא נתונים של המפתח.
DimensionDimensionספירה של המאפיינים האפשריים בגיליון אלקטרוני.
DirectionDirectionספירה של הכיוונים האפשריים שניתן להזיז בתוך גיליון אלקטרוני באמצעות מקשי החיצים.
FrequencyTypeFrequencyTypeאלה סוגי התדרים האפשריים.
GroupControlTogglePositionGroupControlTogglePositionמונה של המיקומים שבהם יכול לחצן החלפת המצב של פקד הקבוצה.
InterpolationTypeInterpolationTypeספירה של סוגי אינטרפולציית ההדרגתיות של פורמט מותנה.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionספירה של הפונקציות שבהן ניתן להשתמש לסיכום ערכים בטבלת צירים.
PivotValueDisplayTypePivotValueDisplayTypeמונה את הדרכים שבהן ניתן להציג ערך בטבלת צירים.
ProtectionTypeProtectionTypeספירה שמייצגת את החלקים בגיליון האלקטרוני שאפשר להגן עליהם מפני עריכה.
RecalculationIntervalRecalculationIntervalמונה של המרווחים האפשריים שניתן להשתמש בהם בחישוב מחדש של גיליון אלקטרוני.
RelativeDateRelativeDateספירה של אפשרויות תאריך יחסיות לחישוב ערך שישמש ב-BooleanCriteria מבוסס-תאריכים.
SheetTypeSheetTypeרשימה של סוגי הגיליונות השונים שיכולים להיכלל בגיליון אלקטרוני.
SortOrderSortOrderספירה של סדר המיון.
TextDirectionTextDirectionזהו מספר של הנחיות טקסט חוקיות.
TextToColumnsDelimiterTextToColumnsDelimiterספירה של תווי ההפרדה הקבועים מראש לפיצול טקסט לעמודות.
ThemeColorTypeThemeColorTypeזהו המספור של סוגי צבעי העיצוב האפשריים.
ValueTypeValueTypeספירה של סוגי הערכים שהוחזרו על ידי Range.getValue() ו-Range.getValues() מהמחלקה Range של שירות הגיליון האלקטרוני. ערכי המספור שמפורטים בהמשך הם בנוסף ל-Number, ל-Boolean, ל-Date או ל-String.
WrapStrategyWrapStrategyספירה של האסטרטגיות המשמשות לגלישת תאים.

שיטות

שיטהסוג הערך שמוחזרתיאור קצר
create(name)Spreadsheetיצירת גיליון אלקטרוני חדש בשם שניתן.
create(name, rows, columns)Spreadsheetיוצרת גיליון אלקטרוני חדש בשם הנתון ובמספר השורות והעמודות שצוין.
enableAllDataSourcesExecution()voidהפעלת ההגדרה של הפעלת נתונים לכל הסוגים של מקורות הנתונים.
enableBigQueryExecution()voidהפעלת ההגדרה של הפעלת נתונים במקורות נתונים של BigQuery.
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());

פרמטרים

שםתיאורהתיאור
nameStringהשם של הגיליון האלקטרוני.

החזרות

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

פרמטרים

שםתיאורהתיאור
nameStringהשם של הגיליון האלקטרוני.
rowsIntegerמספר השורות בגיליון האלקטרוני.
columnsIntegerמספר העמודות בגיליון האלקטרוני.

החזרות

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

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 אם אין גיליון אלקטרוני.

פונקציות שרצות בהקשר של גיליון אלקטרוני יכולות לקבל הפניה לאובייקט המקביל ב-Sheets באמצעות קריאה לפונקציה הזו.

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

פרמטרים

שםתיאורהתיאור
fileFileהקובץ לפתיחה.

החזרות

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

פרמטרים

שםתיאורהתיאור
idStringהמזהה הייחודי של הגיליון האלקטרוני.

החזרות

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

פרמטרים

שםתיאורהתיאור
urlStringכתובת ה-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();

פרמטרים

שםתיאורהתיאור
rangeRangeהטווח שיש להגדיר כטווח הפעיל.

החזרות

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

פרמטרים

שםתיאורהתיאור
rangeListRangeListרשימת הטווחים לבחירה.

החזרות

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

פרמטרים

שםתיאורהתיאור
sheetSheetהגיליון הפעיל החדש.

החזרות

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

פרמטרים

שםתיאורהתיאור
sheetSheetהגיליון הפעיל החדש.
restoreSelectionBooleanאם 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);

פרמטרים

שםתיאורהתיאור
newActiveSpreadsheetSpreadsheetהגיליון האלקטרוני שיהפוך לגיליון האלקטרוני הפעיל.

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

פרמטרים

שםתיאורהתיאור
cellRangeהתא שיש להגדיר בתור התא הנוכחי.

החזרות

Range – התא הנוכחי שהוגדר

הרשאות

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

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