Class SpreadsheetApp

ApplicationSpreadsheet

accéder aux fichiers Google Sheets et en créer. Cette classe est la classe parente du service Spreadsheet.

Propriétés

PropriétéTypeDescription
AutoFillSeriesAutoFillSeriesÉnumération des types de séries utilisés pour calculer les valeurs remplies automatiquement.
BandingThemeBandingThemeÉnumération des thèmes de banding possibles.
BooleanCriteriaBooleanCriteriaÉnumération des critères booléens de mise en forme conditionnelle.
BorderStyleBorderStyleÉnumération des styles valides pour définir des bordures sur un Range.
ColorTypeColorTypeÉnumération des types de couleurs possibles.
CopyPasteTypeCopyPasteTypeÉnumération des types de collage possibles.
DataExecutionErrorCodeDataExecutionErrorCodeÉnumération des codes d'erreur d'exécution des données possibles.
DataExecutionStateDataExecutionStateÉnumération des états d'exécution des données possibles.
DataSourceParameterTypeDataSourceParameterTypeÉnumération des types de paramètres de source de données possibles.
DataSourceRefreshScopeDataSourceRefreshScopeÉnumération des portées d'actualisation possibles pour les sources de données.
DataSourceTypeDataSourceTypeÉnumération des types de sources de données possibles.
DataValidationCriteriaDataValidationCriteriaÉnumération représentant les critères de validation des données qui peuvent être définis sur une plage.
DateTimeGroupingRuleTypeDateTimeGroupingRuleTypeÉnumération de la règle de regroupement par date/heure.
DeveloperMetadataLocationTypeDeveloperMetadataLocationTypeÉnumération des types d'emplacement possibles pour les métadonnées de développeur.
DeveloperMetadataVisibilityDeveloperMetadataVisibilityÉnumération des visibilités possibles des métadonnées de développement.
DimensionDimensionÉnumération des dimensions possibles d'une feuille de calcul.
DirectionDirectionÉnumération des directions possibles dans une feuille de calcul à l'aide des touches fléchées.
FrequencyTypeFrequencyTypeÉnumération des types de fréquence possibles.
GroupControlTogglePositionGroupControlTogglePositionÉnumération des positions dans lesquelles le bouton bascule de contrôle de groupe peut se trouver.
InterpolationTypeInterpolationTypeÉnumération des types d'interpolation de dégradé de mise en forme conditionnelle.
PivotTableSummarizeFunctionPivotTableSummarizeFunctionÉnumération des fonctions pouvant être utilisées pour résumer les valeurs d'un tableau croisé dynamique.
PivotValueDisplayTypePivotValueDisplayTypeÉnumération des façons dont une valeur de tableau croisé dynamique peut être affichée.
ProtectionTypeProtectionTypeÉnumération représentant les parties d'une feuille de calcul qui peuvent être protégées contre les modifications.
RecalculationIntervalRecalculationIntervalÉnumération des intervalles possibles pouvant être utilisés dans le recalcul d'une feuille de calcul.
RelativeDateRelativeDateÉnumération des options de date relative pour calculer une valeur à utiliser dans BooleanCriteria basées sur la date.
SheetTypeSheetTypeÉnumération des différents types de feuilles pouvant exister dans une feuille de calcul.
SortOrderSortOrderÉnumération de l'ordre de tri.
TextDirectionTextDirectionÉnumération des directions de texte valides.
TextToColumnsDelimiterTextToColumnsDelimiterÉnumération des délimiteurs prédéfinis pour la division du texte en colonnes.
ThemeColorTypeThemeColorTypeÉnumération des types de couleurs de thème possibles.
ValueTypeValueTypeÉnumération des types de valeurs renvoyées par Range.getValue() et Range.getValues() à partir de la classe Range du service Spreadsheet. Les valeurs d'énumération listées ci-dessous s'ajoutent à Number, Boolean, Date ou String.
WrapStrategyWrapStrategyÉnumération des stratégies utilisées pour l'habillage des cellules.

Méthodes

MéthodeType renvoyéBrève description
create(name)SpreadsheetCrée une feuille de calcul avec le nom indiqué.
create(name, rows, columns)SpreadsheetCrée une feuille de calcul avec le nom donné et le nombre de lignes et de colonnes spécifié.
enableAllDataSourcesExecution()voidActive l'exécution des données pour tous les types de sources de données.
enableBigQueryExecution()voidActive l'exécution des données pour les sources de données BigQuery.
enableLookerExecution()voidActive l'exécution des données pour les sources de données Looker.
flush()voidApplique toutes les modifications en attente apportées à la feuille de calcul.
getActive()SpreadsheetRenvoie la feuille de calcul actuellement active ou null si aucune n'est active.
getActiveRange()RangeRenvoie la plage sélectionnée dans la feuille active ou null s'il n'y a pas de plage active.
getActiveRangeList()RangeList|nullRenvoie la liste des plages actives dans la feuille active ou null si aucune plage n'est sélectionnée.
getActiveSheet()SheetRécupère la feuille active d'une feuille de calcul.
getActiveSpreadsheet()SpreadsheetRenvoie la feuille de calcul actuellement active ou null si aucune n'est active.
getCurrentCell()Range|nullRenvoie la cellule actuelle (mise en surbrillance) sélectionnée dans l'une des plages actives de la feuille active ou null s'il n'y a pas de cellule actuelle.
getSelection()SelectionRenvoie la Selection actuelle dans la feuille de calcul.
getUi()UiRenvoie une instance de l'environnement d'interface utilisateur de la feuille de calcul qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales.
newCellImage()CellImageBuilderCrée un compilateur pour un CellImage.
newColor()ColorBuilderCrée un compilateur pour un Color.
newConditionalFormatRule()ConditionalFormatRuleBuilderCrée un compilateur pour une règle de mise en forme conditionnelle.
newDataSourceSpec()DataSourceSpecBuilderCrée un compilateur pour un DataSourceSpec.
newDataValidation()DataValidationBuilderCrée un générateur pour une règle de validation des données.
newFilterCriteria()FilterCriteriaBuilderCrée un compilateur pour un FilterCriteria.
newRichTextValue()RichTextValueBuilderCrée un compilateur pour une valeur de texte enrichi.
newTextStyle()TextStyleBuilderCrée un compilateur pour un style de texte.
open(file)SpreadsheetOuvre la feuille de calcul correspondant à l'objet File donné.
openById(id)SpreadsheetOuvre la feuille de calcul dont l'ID est indiqué.
openByUrl(url)SpreadsheetOuvre la feuille de calcul avec l'URL indiquée.
setActiveRange(range)RangeDéfinit la plage spécifiée comme active range, avec la cellule en haut à gauche de la plage comme current cell.
setActiveRangeList(rangeList)RangeListDéfinit la liste des plages spécifiées comme active ranges.
setActiveSheet(sheet)SheetDéfinit la feuille active dans une feuille de calcul.
setActiveSheet(sheet, restoreSelection)SheetDéfinit la feuille active dans une feuille de calcul, avec la possibilité de restaurer la sélection la plus récente dans cette feuille.
setActiveSpreadsheet(newActiveSpreadsheet)voidDéfinit la feuille de calcul active.
setCurrentCell(cell)RangeDéfinit la cellule spécifiée comme current cell.

Documentation détaillée

create(name)

Crée une feuille de calcul avec le nom indiqué.

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

Paramètres

NomTypeDescription
nameStringNom de la feuille de calcul.

Renvois

Spreadsheet : une nouvelle feuille de calcul

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

create(name, rows, columns)

Crée une feuille de calcul avec le nom donné et le nombre de lignes et de colonnes spécifié.

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

Paramètres

NomTypeDescription
nameStringNom de la feuille de calcul.
rowsIntegerNombre de lignes de la feuille de calcul.
columnsIntegerNombre de colonnes de la feuille de calcul.

Renvois

Spreadsheet : une nouvelle feuille de calcul

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

enableAllDataSourcesExecution()

Active l'exécution des données pour tous les types de sources de données.

L'exécution des données génère une exception si le type de source de données n'est pas activé. Utilisez cette méthode pour activer l'exécution des données pour tous les types de sources de données.

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

enableBigQueryExecution()

Active l'exécution des données pour les sources de données BigQuery.

L'exécution des données pour la source de données BigQuery génère une exception si elle n'est pas activée.

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

enableLookerExecution()

Active l'exécution des données pour les sources de données Looker.

L'exécution des données pour la source de données Looker génère une exception si elle n'est pas activée.

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

Applique toutes les modifications en attente apportées à la feuille de calcul.

Les opérations sur les feuilles de calcul sont parfois regroupées pour améliorer les performances, par exemple lorsque plusieurs appels sont effectués à Range.getValue(). Toutefois, vous pouvez parfois vouloir vous assurer que toutes les modifications en attente sont effectuées immédiatement, par exemple pour afficher les données aux utilisateurs lors de l'exécution d'un script.

// 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() {
  const sheet = SpreadsheetApp.getActiveSheet();
  for (let 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()

Renvoie la feuille de calcul actuellement active ou null si aucune n'est active.

Les fonctions exécutées dans le contexte d'une feuille de calcul peuvent obtenir une référence à l'objet Spreadsheet correspondant en appelant cette fonction.

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

Renvois

Spreadsheet : objet Spreadsheet actif

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getActiveRange()

Renvoie la plage sélectionnée dans la feuille active ou null s'il n'y a pas de plage active. Si plusieurs plages sont sélectionnées, cette méthode ne renvoie que la dernière plage sélectionnée.

Cela signifie généralement la plage qu'un utilisateur a sélectionnée dans la feuille active, mais dans une fonction personnalisée, cela fait référence à la cellule en cours de recalcul.

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

Renvois

Range : plage active.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getActiveRangeList()

Renvoie la liste des plages actives dans la feuille active ou null si aucune plage n'est sélectionnée. La plage active contenant la cellule actuellement mise en surbrillance est placée en dernier dans la liste.

Si une seule plage est sélectionnée, cela se comporte comme un appel getActiveRange().

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

Renvois

RangeList|null : liste des plages actives

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getActiveSheet()

Récupère la feuille active d'une feuille de calcul.

La feuille active d'une feuille de calcul est celle qui s'affiche dans l'interface utilisateur de la feuille de calcul.

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

Renvois

Sheet : objet Sheet actif

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getActiveSpreadsheet()

Renvoie la feuille de calcul actuellement active ou null si aucune n'est active.

Les fonctions exécutées dans le contexte d'une feuille de calcul peuvent obtenir une référence à l'objet Spreadsheet correspondant en appelant cette fonction.

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

Renvois

Spreadsheet : objet Spreadsheet actif

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getCurrentCell()

Renvoie la cellule actuelle (mise en surbrillance) sélectionnée dans l'une des plages actives de la feuille active ou null s'il n'y a pas de cellule actuelle.

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

Renvois

Range|null : cellule actuelle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getSelection()

Renvoie la Selection actuelle dans la feuille de calcul.

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

Renvois

Selection : sélection actuelle

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

getUi()

Renvoie une instance de l'environnement d'interface utilisateur de la feuille de calcul qui permet au script d'ajouter des fonctionnalités telles que des menus, des boîtes de dialogue et des barres latérales. Un script ne peut interagir avec l'UI que pour l'instance actuelle d'une feuille de calcul ouverte, et uniquement s'il est lié à la feuille de calcul. Pour en savoir plus, consultez les guides sur les menus et les boîtes de dialogue et barres latérales.

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

Renvois

Ui : instance de l'environnement d'interface utilisateur de cette feuille de calcul


newCellImage()

Crée un compilateur pour un 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);

Renvois

CellImageBuilder : le nouveau compilateur.


newColor()

Crée un compilateur pour un Color.

const rgbColor = SpreadsheetApp.newColor().setRgbColor('#FF0000').build();

Renvois

ColorBuilder : le nouveau compilateur.


newConditionalFormatRule()

Crée un compilateur pour une règle de mise en forme conditionnelle.

// 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.
const sheet = SpreadsheetApp.getActive().getActiveSheet();
const range = sheet.getRange('A1:B3');
const rule = SpreadsheetApp.newConditionalFormatRule()
                 .whenNumberBetween(1, 10)
                 .setBackground('#FF0000')
                 .setRanges([range])
                 .build();
const rules = sheet.getConditionalFormatRules();
rules.push(rule);
sheet.setConditionalFormatRules(rules);

Renvois

ConditionalFormatRuleBuilder : nouveau compilateur.


newDataSourceSpec()

Crée un compilateur pour un 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);

Renvois

DataSourceSpecBuilder : le nouveau compilateur.


newDataValidation()

Crée un générateur pour une règle de validation des données.

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

Renvois

DataValidationBuilder : le nouveau compilateur.


newFilterCriteria()

Crée un compilateur pour un 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);

Renvois

FilterCriteriaBuilder : le nouveau compilateur


newRichTextValue()

Crée un compilateur pour une valeur de texte enrichi.

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

Renvois

RichTextValueBuilder : le nouveau compilateur.


newTextStyle()

Crée un compilateur pour un style de texte.

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

Renvois

TextStyleBuilder : le nouveau compilateur.


open(file)

Ouvre la feuille de calcul correspondant à l'objet File donné.

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

Paramètres

NomTypeDescription
fileFileFichier à ouvrir.

Renvois

Spreadsheet : la feuille de calcul

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

openById(id)

Ouvre la feuille de calcul dont l'ID est indiqué. L'ID d'une feuille de calcul peut être extrait de son URL. Par exemple, l'ID de la feuille de calcul dans l'URL https://docs.google.com/spreadsheets/d/abc1234567/edit#gid=0 est "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).
const ss = SpreadsheetApp.openById('abc1234567');
Logger.log(ss.getName());

Paramètres

NomTypeDescription
idStringIdentifiant unique de la feuille de calcul.

Renvois

Spreadsheet : objet Spreadsheet avec l'ID donné

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

openByUrl(url)

Ouvre la feuille de calcul avec l'URL indiquée. Génère une exception de script si l'URL n'existe pas ou si l'utilisateur n'est pas autorisé à y accéder.

// 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).
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc1234567/edit',
);
console.log(ss.getName());

Paramètres

NomTypeDescription
urlStringURL de la feuille de calcul.

Renvois

Spreadsheet : objet de feuille de calcul avec l'URL indiquée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setActiveRange(range)

Définit la plage spécifiée comme active range, avec la cellule en haut à gauche de la plage comme current cell.

L'interface utilisateur de la feuille de calcul affiche la feuille contenant la plage choisie et sélectionne les cellules définies dans cette plage.

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

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

Paramètres

NomTypeDescription
rangeRangePlage à définir comme plage active.

Renvois

Range : nouvelle plage active


setActiveRangeList(rangeList)

Définit la liste des plages spécifiées comme active ranges. La dernière plage de la liste est définie comme active range.

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

const selection = SpreadsheetApp.getSelection();
// Current cell: B2
const currentCell = selection.getCurrentCell();
// Active range: B2:C4
const activeRange = selection.getActiveRange();
// Active range list: [D4, B2:C4]
const activeRangeList = selection.getActiveRangeList();

Paramètres

NomTypeDescription
rangeListRangeListListe des plages à sélectionner.

Renvois

RangeList : la nouvelle liste de plages sélectionnée

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setActiveSheet(sheet)

Définit la feuille active dans une feuille de calcul. L'interface utilisateur de Google Sheets affiche la feuille choisie, sauf si elle appartient à une autre feuille de calcul.

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

Paramètres

NomTypeDescription
sheetSheetNouvelle feuille active.

Renvois

Sheet : feuille qui a été définie comme la nouvelle feuille active


setActiveSheet(sheet, restoreSelection)

Définit la feuille active dans une feuille de calcul, avec la possibilité de restaurer la sélection la plus récente dans cette feuille. L'interface utilisateur Google Sheets affiche la feuille choisie, sauf si elle appartient à une autre feuille de calcul.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
const firstSheet = spreadsheet.getSheets()[0];
const 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
const range = spreadsheet.getActiveSheet().getSelection().getActiveRange();
Logger.log(range.getA1Notation());

Paramètres

NomTypeDescription
sheetSheetNouvelle feuille active.
restoreSelectionBooleanSi la valeur est true, la sélection la plus récente de la nouvelle feuille active est à nouveau sélectionnée lorsque la nouvelle feuille devient active. Si la valeur est false, la nouvelle feuille devient active sans modifier la sélection actuelle.

Renvois

Sheet : la nouvelle feuille active

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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

setActiveSpreadsheet(newActiveSpreadsheet)

Définit la feuille de calcul active.

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

Paramètres

NomTypeDescription
newActiveSpreadsheetSpreadsheetFeuille de calcul à définir comme feuille de calcul active.

setCurrentCell(cell)

Définit la cellule spécifiée comme current cell.

Si la cellule spécifiée se trouve dans une plage déjà sélectionnée, cette plage devient la plage active et la cellule devient la cellule actuelle.

Si la cellule spécifiée n'est présente dans aucune plage sélectionnée, la sélection existante est supprimée, et la cellule devient la cellule actuelle et la plage active.

Remarque : Le Range spécifié doit être constitué d'une seule cellule, sinon cette méthode génère une exception.

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

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

Paramètres

NomTypeDescription
cellRangeCellule à définir comme cellule actuelle.

Renvois

Range : la nouvelle cellule active

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des scopes suivants :

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