Cette page a été traduite par l'API Cloud Translation.

Class Spreadsheet

accéder aux fichiers Google Sheets et les modifier ; Les opérations courantes consistent à ajouter des feuilles et des collaborateurs.

Méthodes

Méthode	Type renvoyé	Brève description
`addDeveloperMetadata(key)`	`Spreadsheet`	Ajoute des métadonnées de développement avec la clé spécifiée à la feuille de calcul de premier niveau.
`addDeveloperMetadata(key, visibility)`	`Spreadsheet`	Ajoute des métadonnées de développeur avec la clé et la visibilité spécifiées à la feuille de calcul.
`addDeveloperMetadata(key, value)`	`Spreadsheet`	Ajoute des métadonnées de développeur avec la clé et la valeur spécifiées à la feuille de calcul.
`addDeveloperMetadata(key, value, visibility)`	`Spreadsheet`	Ajoute des métadonnées de développeur à la feuille de calcul avec la clé, la valeur et la visibilité spécifiées.
`addEditor(emailAddress)`	`Spreadsheet`	Ajoute l'utilisateur donné à la liste des éditeurs pour `Spreadsheet`.
`addEditor(user)`	`Spreadsheet`	Ajoute l'utilisateur donné à la liste des éditeurs pour `Spreadsheet`.
`addEditors(emailAddresses)`	`Spreadsheet`	Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de `Spreadsheet`.
`addMenu(name, subMenus)`	`void`	Crée un menu dans l'interface utilisateur de la feuille de calcul.
`addViewer(emailAddress)`	`Spreadsheet`	Ajoute l'utilisateur donné à la liste des spectateurs du `Spreadsheet`.
`addViewer(user)`	`Spreadsheet`	Ajoute l'utilisateur donné à la liste des spectateurs du `Spreadsheet`.
`addViewers(emailAddresses)`	`Spreadsheet`	Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de `Spreadsheet`.
`appendRow(rowContents)`	`Sheet`	Ajoute une ligne au bas de la région de données actuelle de la feuille.
`autoResizeColumn(columnPosition)`	`Sheet`	Définit la largeur de la colonne donnée pour qu'elle s'adapte à son contenu.
`copy(name)`	`Spreadsheet`	Copie la feuille de calcul et renvoie la nouvelle.
`createDeveloperMetadataFinder()`	`DeveloperMetadataFinder`	Renvoie un `DeveloperMetadataFinder` pour rechercher des métadonnées de développement dans le champ d'application de cette feuille de calcul.
`createTextFinder(findText)`	`TextFinder`	Crée un outil de recherche de texte pour la feuille de calcul, qui peut être utilisé pour rechercher et remplacer du texte dans la feuille de calcul.
`deleteActiveSheet()`	`Sheet`	Supprime la feuille active.
`deleteColumn(columnPosition)`	`Sheet`	Supprime la colonne à la position indiquée.
`deleteColumns(columnPosition, howMany)`	`void`	Supprime un certain nombre de colonnes à partir de la position de colonne indiquée.
`deleteRow(rowPosition)`	`Sheet`	Supprime la ligne à la position indiquée.
`deleteRows(rowPosition, howMany)`	`void`	Supprime un certain nombre de lignes à partir de la position de ligne indiquée.
`deleteSheet(sheet)`	`void`	Supprime la feuille spécifiée.
`duplicateActiveSheet()`	`Sheet`	Duplique la feuille active et la définit comme feuille active.
`getActiveCell()`	`Range`	Renvoie la cellule active de cette feuille.
`getActiveRange()`	`Range`	Renvoie la plage sélectionnée dans la feuille active ou `null` s'il n'y a pas de plage active.
`getActiveRangeList()`	`RangeList`	Renvoie la liste des plages actives dans la feuille active ou `null` s'il n'y a pas de plages actives.
`getActiveSheet()`	`Sheet`	Récupère la feuille active d'une feuille de calcul.
`getAs(contentType)`	`Blob`	Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié.
`getBandings()`	`Banding[]`	Renvoie toutes les bandes de cette feuille de calcul.
`getBlob()`	`Blob`	Renvoie les données de cet objet sous forme de blob.
`getColumnWidth(columnPosition)`	`Integer`	Récupère la largeur en pixels de la colonne spécifiée.
`getCurrentCell()`	`Range`	Renvoie la cellule actuelle dans la feuille active ou `null` s'il n'y a pas de cellule actuelle.
`getDataRange()`	`Range`	Renvoie un `Range` correspondant aux dimensions dans lesquelles les données sont présentes.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Obtient toutes les formules de source de données.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Récupère tous les tableaux croisés dynamiques de source de données.
`getDataSourceRefreshSchedules()`	`DataSourceRefreshSchedule[]`	Récupère les plannings d'actualisation de cette feuille de calcul.
`getDataSourceSheets()`	`DataSourceSheet[]`	Renvoie toutes les feuilles de source de données de la feuille de calcul.
`getDataSourceTables()`	`DataSourceTable[]`	Récupère toutes les tables de la source de données.
`getDataSources()`	`DataSource[]`	Renvoie toutes les sources de données de la feuille de calcul.
`getDeveloperMetadata()`	`DeveloperMetadata[]`	Récupère les métadonnées de développement associées à la feuille de calcul de premier niveau.
`getEditors()`	`User[]`	Obtient la liste des éditeurs pour ce `Spreadsheet`.
`getFormUrl()`	`String`	Renvoie l'URL du formulaire qui envoie ses réponses à cette feuille de calcul, ou `null` si cette feuille de calcul n'est associée à aucun formulaire.
`getFrozenColumns()`	`Integer`	Affiche le nombre de colonnes figées.
`getFrozenRows()`	`Integer`	Renvoie le nombre de lignes figées.
`getId()`	`String`	Obtient un identifiant unique pour cette feuille de calcul.
`getImages()`	`OverGridImage[]`	Renvoie toutes les images hors grille de la feuille.
`getIterativeCalculationConvergenceThreshold()`	`Number`	Renvoie la valeur de seuil utilisée lors du calcul itératif.
`getLastColumn()`	`Integer`	Renvoie la position de la dernière colonne contenant du contenu.
`getLastRow()`	`Integer`	Renvoie la position de la dernière ligne contenant du contenu.
`getMaxIterativeCalculationCycles()`	`Integer`	Renvoie le nombre maximal d'itérations à utiliser lors du calcul itératif.
`getName()`	`String`	Récupère le nom du document.
`getNamedRanges()`	`NamedRange[]`	Récupère toutes les plages nommées de cette feuille de calcul.
`getNumSheets()`	`Integer`	Renvoie le nombre de feuilles de calcul dans cette feuille de calcul.
`getOwner()`	`User`	Renvoie le propriétaire du document ou `null` pour un document dans un Drive partagé.
`getPredefinedSpreadsheetThemes()`	`SpreadsheetTheme[]`	Renvoie la liste des thèmes prédéfinis.
`getProtections(type)`	`Protection[]`	Renvoie un tableau d'objets représentant toutes les plages ou feuilles protégées de la feuille de calcul.
`getRange(a1Notation)`	`Range`	Renvoie la plage spécifiée dans la notation A1 ou R1C1.
`getRangeByName(name)`	`Range`	Renvoie une plage nommée ou `null` si aucune plage portant le nom donné n'est trouvée.
`getRangeList(a1Notations)`	`RangeList`	Renvoie la collection `RangeList` représentant les plages de la même feuille spécifiées par une liste non vide de notations A1 ou R1C1.
`getRecalculationInterval()`	`RecalculationInterval`	Renvoie l'intervalle de calcul pour cette feuille de calcul.
`getRowHeight(rowPosition)`	`Integer`	Récupère la hauteur en pixels de la ligne donnée.
`getSelection()`	`Selection`	Renvoie la `Selection` actuelle dans la feuille de calcul.
`getSheetById(id)`	`Sheet`	Récupère la feuille avec l'ID donné.
`getSheetByName(name)`	`Sheet`	Renvoie une feuille portant le nom indiqué.
`getSheetId()`	`Integer`	Renvoie l'ID de la feuille représentée par cet objet.
`getSheetName()`	`String`	Renvoie le nom de la feuille.
`getSheetValues(startRow, startColumn, numRows, numColumns)`	`Object[][]`	Renvoie la grille rectangulaire de valeurs pour cette plage en commençant aux coordonnées indiquées.
`getSheets()`	`Sheet[]`	Récupère toutes les feuilles de calcul.
`getSpreadsheetLocale()`	`String`	Récupère les paramètres régionaux de la feuille de calcul.
`getSpreadsheetTheme()`	`SpreadsheetTheme`	Renvoie le thème actuel de la feuille de calcul ou `null` si aucun thème n'est appliqué.
`getSpreadsheetTimeZone()`	`String`	Récupère le fuseau horaire de la feuille de calcul.
`getUrl()`	`String`	Renvoie l'URL de la feuille de calcul donnée.
`getViewers()`	`User[]`	Obtient la liste des lecteurs et des commentateurs pour ce `Spreadsheet`.
`hideColumn(column)`	`void`	Masque la ou les colonnes de la plage indiquée.
`hideRow(row)`	`void`	Masque les lignes de la plage indiquée.
`insertColumnAfter(afterPosition)`	`Sheet`	Insère une colonne après la position de colonne indiquée.
`insertColumnBefore(beforePosition)`	`Sheet`	Insère une colonne avant la position de colonne indiquée.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	Insère un nombre donné de colonnes après la position de colonne indiquée.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Insère un certain nombre de colonnes avant la position de colonne indiquée.
`insertDataSourceSheet(spec)`	`DataSourceSheet`	Insère un `DataSourceSheet` dans la feuille de calcul et lance l'exécution des données.
`insertImage(blobSource, column, row)`	`OverGridImage`	Insère un `Spreadsheet` en tant qu'image dans le document, à une ligne et une colonne données.
`insertImage(blobSource, column, row, offsetX, offsetY)`	`OverGridImage`	Insère un `Spreadsheet` en tant qu'image dans le document, à une ligne et une colonne données, avec un décalage en pixels.
`insertImage(url, column, row)`	`OverGridImage`	Insère une image dans le document à une ligne et une colonne données.
`insertImage(url, column, row, offsetX, offsetY)`	`OverGridImage`	Insère une image dans le document à une ligne et une colonne données, avec un décalage en pixels.
`insertRowAfter(afterPosition)`	`Sheet`	Insère une ligne après la position de ligne donnée.
`insertRowBefore(beforePosition)`	`Sheet`	Insère une ligne avant la position de ligne donnée.
`insertRowsAfter(afterPosition, howMany)`	`Sheet`	Insère un certain nombre de lignes après la position de ligne donnée.
`insertRowsBefore(beforePosition, howMany)`	`Sheet`	Insère un certain nombre de lignes avant la position de ligne indiquée.
`insertSheet()`	`Sheet`	Insère une nouvelle feuille dans la feuille de calcul, en utilisant un nom de feuille par défaut.
`insertSheet(sheetIndex)`	`Sheet`	Insère une feuille dans la feuille de calcul à l'index indiqué.
`insertSheet(sheetIndex, options)`	`Sheet`	Insère une nouvelle feuille dans la feuille de calcul à l'index donné et utilise des arguments avancés facultatifs.
`insertSheet(options)`	`Sheet`	Insère une nouvelle feuille dans la feuille de calcul, en utilisant un nom de feuille par défaut et des arguments avancés facultatifs.
`insertSheet(sheetName)`	`Sheet`	Insère une nouvelle feuille dans la feuille de calcul avec le nom indiqué.
`insertSheet(sheetName, sheetIndex)`	`Sheet`	Insère une feuille dans la feuille de calcul avec le nom et l'index spécifiés.
`insertSheet(sheetName, sheetIndex, options)`	`Sheet`	Insère une nouvelle feuille dans la feuille de calcul avec le nom donné à l'index donné et utilise des arguments avancés facultatifs.
`insertSheet(sheetName, options)`	`Sheet`	Insère une nouvelle feuille dans la feuille de calcul avec le nom donné et utilise des arguments avancés facultatifs.
`insertSheetWithDataSourceTable(spec)`	`Sheet`	Insère une feuille dans la feuille de calcul, crée un `DataSourceTable` couvrant toute la feuille avec la spécification de source de données donnée et lance l'exécution des données.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	Indique si la colonne spécifiée est masquée par l'utilisateur.
`isIterativeCalculationEnabled()`	`Boolean`	Indique si le calcul itératif est activé dans cette feuille de calcul.
`isRowHiddenByFilter(rowPosition)`	`Boolean`	Indique si la ligne donnée est masquée par un filtre (et non par une vue filtrée).
`isRowHiddenByUser(rowPosition)`	`Boolean`	Indique si la ligne donnée est masquée par l'utilisateur.
`moveActiveSheet(pos)`	`void`	Déplace la feuille active à la position indiquée dans la liste des feuilles.
`moveChartToObjectSheet(chart)`	`Sheet`	Crée une feuille `SheetType.OBJECT` et y déplace le graphique fourni.
`refreshAllDataSources()`	`void`	Actualise toutes les sources de données compatibles et leurs objets de source de données associés, en ignorant les objets de source de données non valides.
`removeEditor(emailAddress)`	`Spreadsheet`	Supprime l'utilisateur donné de la liste des éditeurs pour le `Spreadsheet`.
`removeEditor(user)`	`Spreadsheet`	Supprime l'utilisateur donné de la liste des éditeurs pour le `Spreadsheet`.
`removeMenu(name)`	`void`	Supprime un menu qui a été ajouté par `addMenu(name, subMenus)`.
`removeNamedRange(name)`	`void`	Supprime une plage nommée avec le nom donné.
`removeViewer(emailAddress)`	`Spreadsheet`	Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs du `Spreadsheet`.
`removeViewer(user)`	`Spreadsheet`	Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs du `Spreadsheet`.
`rename(newName)`	`void`	Renomme le document.
`renameActiveSheet(newName)`	`void`	Renomme la feuille active actuelle avec le nouveau nom indiqué.
`resetSpreadsheetTheme()`	`SpreadsheetTheme`	Supprime le thème appliqué et définit le thème par défaut dans la feuille de calcul.
`setActiveRange(range)`	`Range`	Définit la plage spécifiée comme `active range` dans la feuille active, avec la cellule en haut à gauche de la plage comme `current cell`.
`setActiveRangeList(rangeList)`	`RangeList`	Définit la liste de plages spécifiée comme `active ranges` dans la feuille active.
`setActiveSelection(range)`	`Range`	Définit la région de sélection active pour cette feuille.
`setActiveSelection(a1Notation)`	`Range`	Définit la sélection active, comme spécifié dans la notation A1 ou R1C1.
`setActiveSheet(sheet)`	`Sheet`	Définit la feuille donnée comme feuille active dans la feuille de calcul.
`setActiveSheet(sheet, restoreSelection)`	`Sheet`	Définit la feuille donnée comme feuille active dans la feuille de calcul, avec une option permettant de restaurer la sélection la plus récente dans cette feuille.
`setColumnWidth(columnPosition, width)`	`Sheet`	Définit la largeur de la colonne donnée en pixels.
`setCurrentCell(cell)`	`Range`	Définit la cellule spécifiée comme `current cell`.
`setFrozenColumns(columns)`	`void`	Fige le nombre de colonnes indiqué.
`setFrozenRows(rows)`	`void`	Gèle le nombre de lignes indiqué.
`setIterativeCalculationConvergenceThreshold(minThreshold)`	`Spreadsheet`	Définit la valeur de seuil minimale pour le calcul itératif.
`setIterativeCalculationEnabled(isEnabled)`	`Spreadsheet`	Indique si le calcul itératif est activé dans cette feuille de calcul.
`setMaxIterativeCalculationCycles(maxIterations)`	`Spreadsheet`	Définit le nombre maximal d'itérations de calcul à effectuer lors du calcul itératif.
`setNamedRange(name, range)`	`void`	Nomme une plage.
`setRecalculationInterval(recalculationInterval)`	`Spreadsheet`	Définit la fréquence à laquelle cette feuille de calcul doit être recalculée.
`setRowHeight(rowPosition, height)`	`Sheet`	Définit la hauteur de la ligne spécifiée en pixels.
`setSpreadsheetLocale(locale)`	`void`	Définit les paramètres régionaux de la feuille de calcul.
`setSpreadsheetTheme(theme)`	`SpreadsheetTheme`	Définit un thème dans la feuille de calcul.
`setSpreadsheetTimeZone(timezone)`	`void`	Définit le fuseau horaire de la feuille de calcul.
`show(userInterface)`	`void`	Affiche un composant d'interface utilisateur personnalisé dans une boîte de dialogue centrée dans la fenêtre d'affichage du navigateur de l'utilisateur.
`sort(columnPosition)`	`Sheet`	Trie une feuille par colonne, par ordre croissant.
`sort(columnPosition, ascending)`	`Sheet`	Trie une feuille par colonne.
`toast(msg)`	`void`	Affiche une fenêtre pop-up en bas à droite de la feuille de calcul avec le message indiqué.
`toast(msg, title)`	`void`	Affiche une fenêtre pop-up en bas à droite de la feuille de calcul avec le message et le titre indiqués.
`toast(msg, title, timeoutSeconds)`	`void`	Affiche une fenêtre pop-up en bas à droite de la feuille de calcul avec le titre et le message indiqués, qui reste visible pendant une certaine durée.
`unhideColumn(column)`	`void`	Affiche la colonne dans la plage spécifiée.
`unhideRow(row)`	`void`	Affiche la ligne dans la plage donnée.
`updateMenu(name, subMenus)`	`void`	Met à jour un menu ajouté par `addMenu(name, subMenus)`.
`waitForAllDataExecutionsCompletion(timeoutInSeconds)`	`void`	Attend que toutes les exécutions en cours dans la feuille de calcul soient terminées, avec un délai d'inactivité après le nombre de secondes indiqué.

Méthodes obsolètes

Méthode	Type renvoyé	Brève description
`getSheetProtection()`	`PageProtection`	Renvoie une instance `PageProtection` décrivant les autorisations pour la feuille de calcul actuelle.
`isAnonymousView()`	`Boolean`	Indique si le document autorise la consultation anonyme.
`isAnonymousWrite()`	`Boolean`	Indique si le document autorise les modifications apportées par des utilisateurs anonymes.
`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`	`void`	Définit la règle du document concernant la lecture et l'écriture anonymes.
`setSheetProtection(permissions)`	`void`	Définit les autorisations pour la feuille de calcul actuelle.

Documentation détaillée

`addDeveloperMetadata(key)`

Ajoute des métadonnées de développement avec la clé spécifiée à la feuille de calcul de premier niveau.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds the key 'NAME' in the developer metadata for the spreadsheet.
ss.addDeveloperMetadata('NAME');

// Gets the first developer metadata object and logs its key.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());

Paramètres

Nom	Type	Description
`key`	`String`	Clé des nouvelles métadonnées de développement.

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`addDeveloperMetadata(key, visibility)`

Ajoute des métadonnées de développeur avec la clé et la visibilité spécifiées à la feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds the key 'NAME' in the developer metadata for the spreadsheet and sets
// the visibility to the developer project that created the metadata.
ss.addDeveloperMetadata(
    'NAME',
    SpreadsheetApp.DeveloperMetadataVisibility.PROJECT,
);

// Gets the first developer metadata object and logs its key and visibility
// setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(`Key: ${developerMetaData.getKey()},
.             Visibility: ${developerMetaData.getVisibility()}`);

Paramètres

Nom	Type	Description
`key`	`String`	Clé des nouvelles métadonnées de développement.
`visibility`	`DeveloperMetadataVisibility`	Visibilité des nouvelles métadonnées de développement.

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`addDeveloperMetadata(key, value)`

Ajoute des métadonnées de développeur avec la clé et la valeur spécifiées à la feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds the key 'NAME' and sets the value to 'GOOGLE' in the developer metadata
// for the spreadsheet.
ss.addDeveloperMetadata('NAME', 'GOOGLE');

// Gets the first developer metadata object and logs its key and value.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(developerMetaData.getKey());
console.log(
    `Key: ${developerMetaData.getKey()}, Value: ${
        developerMetaData.getValue()}`,
);

Paramètres

Nom	Type	Description
`key`	`String`	Clé des nouvelles métadonnées de développement.
`value`	`String`	Valeur des nouvelles métadonnées de développement.

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`addDeveloperMetadata(key, value, visibility)`

Ajoute des métadonnées de développeur à la feuille de calcul avec la clé, la valeur et la visibilité spécifiées.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds the key 'NAME', sets the value to 'GOOGLE', and sets the visibility
// to any developer project with document access.
ss.addDeveloperMetadata(
    'NAME',
    'GOOGLE',
    SpreadsheetApp.DeveloperMetadataVisibility.DOCUMENT,
);

// Gets the first developer metadata object and logs its key, value, and
// visibility setting.
const developerMetaData = ss.getDeveloperMetadata()[0];
console.log(`Key: ${developerMetaData.getKey()},
             Value: ${developerMetaData.getValue()},
             Visibility: ${developerMetaData.getVisibility()}`);

Paramètres

Nom	Type	Description
`key`	`String`	Clé des nouvelles métadonnées de développement.
`value`	`String`	Valeur des nouvelles métadonnées de développement.
`visibility`	`DeveloperMetadataVisibility`	Visibilité des nouvelles métadonnées de développement.

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`addEditor(emailAddress)`

Ajoute l'utilisateur donné à la liste des éditeurs pour Spreadsheet. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.

Paramètres

Nom	Type	Description
`emailAddress`	`String`	Adresse e-mail de l'utilisateur à ajouter.

Renvois

Spreadsheet : ce Spreadsheet, pour le chaînage.

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

`addEditor(user)`

Ajoute l'utilisateur donné à la liste des éditeurs pour Spreadsheet. Si l'utilisateur figurait déjà dans la liste des spectateurs, cette méthode le retire de cette liste.

Paramètres

Nom	Type	Description
`user`	`User`	Représentation de l'utilisateur à ajouter.

Renvois

Spreadsheet : ce Spreadsheet, pour le chaînage.

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

`addEditors(emailAddresses)`

Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de Spreadsheet. Si l'un des utilisateurs figure déjà dans la liste des spectateurs, cette méthode le retire de cette liste.

Paramètres

Nom	Type	Description
`emailAddresses`	`String[]`	Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Spreadsheet : ce Spreadsheet, pour le chaînage.

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

`addMenu(name, subMenus)`

Crée un menu dans l'interface utilisateur de la feuille de calcul.

Chaque entrée de menu exécute une fonction définie par l'utilisateur. En général, vous souhaitez l'appeler à partir de la fonction onOpen() afin que le menu soit créé automatiquement lorsque la feuille de calcul est chargée.

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  const menuEntries = [];
  // When the user clicks on "addMenuExample" then "Menu Entry 1", the function
  // function1 is executed.
  menuEntries.push({name: 'Menu Entry 1', functionName: 'function1'});
  menuEntries.push(null);  // line separator
  menuEntries.push({name: 'Menu Entry 2', functionName: 'function2'});

  ss.addMenu('addMenuExample', menuEntries);
}

Paramètres

Nom	Type	Description
`name`	`String`	Nom du menu à créer.
`subMenus`	`Object[]`	Tableau de cartes JavaScript avec les paramètres `name` et `functionName`. Vous pouvez utiliser des fonctions des bibliothèques incluses, telles que `Library.libFunction1`.

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

`addViewer(emailAddress)`

Ajoute l'utilisateur donné à la liste des spectateurs du Spreadsheet. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

Nom	Type	Description
`emailAddress`	`String`	Adresse e-mail de l'utilisateur à ajouter.

Renvois

Spreadsheet : ce Spreadsheet, pour le chaînage.

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

`addViewer(user)`

Ajoute l'utilisateur donné à la liste des spectateurs du Spreadsheet. Si l'utilisateur figure déjà dans la liste des éditeurs, cette méthode n'a aucun effet.

Paramètres

Nom	Type	Description
`user`	`User`	Représentation de l'utilisateur à ajouter.

Renvois

Spreadsheet : ce Spreadsheet, pour le chaînage.

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

`addViewers(emailAddresses)`

Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de Spreadsheet. Si l'un des utilisateurs figurait déjà dans la liste des éditeurs, cette méthode n'a aucun effet pour lui.

Paramètres

Nom	Type	Description
`emailAddresses`	`String[]`	Tableau des adresses e-mail des utilisateurs à ajouter.

Renvois

Spreadsheet : ce Spreadsheet, pour le chaînage.

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

`appendRow(rowContents)`

Ajoute une ligne au bas de la région de données actuelle de la feuille. Si le contenu d'une cellule commence par =, il est interprété comme une formule.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Appends a new row with 3 columns to the bottom of the current
// data region in the sheet containing the values in the array.
sheet.appendRow(['a man', 'a plan', 'panama']);

Paramètres

Nom	Type	Description
`rowContents`	`Object[]`	Tableau de valeurs à insérer après la dernière ligne de la feuille.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`autoResizeColumn(columnPosition)`

Définit la largeur de la colonne donnée pour qu'elle s'adapte à son contenu.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.getRange('a1').setValue(
    'Whenever it is a damp, drizzly November in my soul...');

// Sets the first column to a width which fits the text
sheet.autoResizeColumn(1);

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Position de la colonne à redimensionner.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`copy(name)`

Copie la feuille de calcul et renvoie la nouvelle.

// This code makes a copy of the current spreadsheet and names it appropriately
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.copy(`Copy of ${ss.getName()}`);

Paramètres

Nom	Type	Description
`name`	`String`	Nom de la copie.

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`createDeveloperMetadataFinder()`

Renvoie un DeveloperMetadataFinder pour rechercher des métadonnées de développement dans le champ d'application de cette feuille de calcul. Par défaut, cela prend en compte toutes les métadonnées associées à la feuille de calcul, aux feuilles, aux lignes et aux colonnes.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds developer metadata to the spreadsheet.
ss.addDeveloperMetadata('NAME', 'CHARLIE');
ss.addDeveloperMetadata('COMPANY', 'EXAMPLE ORGANIZATION');
ss.addDeveloperMetadata('TECHNOLOGY', 'JAVASCRIPT');

// Creates a developer metadata finder.
const developerMetadataFinder = ss.createDeveloperMetadataFinder();

// Finds the developer metadata objects with 'COMPANY' as the key.
const googleMetadataFromSpreadsheet =
    developerMetadataFinder.withKey('COMPANY').find();

// Gets the first result of developer metadata that has the key 'COMPANY' and
// logs its value.
console.log(googleMetadataFromSpreadsheet[0].getValue());

Renvois

DeveloperMetadataFinder : outil de recherche de métadonnées de développement permettant de rechercher des métadonnées dans le champ d'application de cette feuille de calcul.

`createTextFinder(findText)`

Crée un outil de recherche de texte pour la feuille de calcul, qui peut être utilisé pour rechercher et remplacer du texte dans la feuille de calcul. La recherche commence à partir de la première feuille de calcul.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

// Creates  a text finder.
const textFinder = spreadsheet.createTextFinder('dog');

// Returns the first occurrence of 'dog' in the spreadsheet.
const firstOccurrence = textFinder.findNext();

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
const numOccurrencesReplaced = textFinder.replaceWith('cat');

Paramètres

Nom	Type	Description
`findText`	`String`	Texte à rechercher.

Renvois

TextFinder : TextFinder de la feuille de calcul.

`deleteActiveSheet()`

Supprime la feuille active.

// The code below deletes the currently active sheet and stores the new active
// sheet in a variable
const newSheet = SpreadsheetApp.getActiveSpreadsheet().deleteActiveSheet();

Renvois

Sheet : 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

`deleteColumn(columnPosition)`

Supprime la colonne à la position indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first column
sheet.deleteColumn(1);

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Position de la colonne, en commençant par 1 pour la première colonne.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`deleteColumns(columnPosition, howMany)`

Supprime un certain nombre de colonnes à partir de la position de colonne indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Columns start at "1" - this deletes the first two columns
sheet.deleteColumns(1, 2);

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Position de la première colonne à supprimer.
`howMany`	`Integer`	Nombre de colonnes à supprimer.

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

`deleteRow(rowPosition)`

Supprime la ligne à la position indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first row
sheet.deleteRow(1);

Paramètres

Nom	Type	Description
`rowPosition`	`Integer`	Position de la ligne, en commençant par 1 pour la première ligne.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`deleteRows(rowPosition, howMany)`

Supprime un certain nombre de lignes à partir de la position de ligne indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Rows start at "1" - this deletes the first two rows
sheet.deleteRows(1, 2);

Paramètres

Nom	Type	Description
`rowPosition`	`Integer`	Position de la première ligne à supprimer.
`howMany`	`Integer`	Nombre de lignes à supprimer.

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

`deleteSheet(sheet)`

Supprime la feuille spécifiée.

// The code below deletes the specified sheet.
const ss = SpreadsheetApp.getActive();
const sheet = ss.getSheetByName('My Sheet');
ss.deleteSheet(sheet);

Paramètres

Nom	Type	Description
`sheet`	`Sheet`	Feuille à supprimer.

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

`duplicateActiveSheet()`

Duplique la feuille active et la définit comme feuille active.

// The code below makes a duplicate of the active sheet
SpreadsheetApp.getActiveSpreadsheet().duplicateActiveSheet();

Renvois

Sheet : la nouvelle feuille.

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

`getActiveCell()`

Renvoie la cellule active de cette feuille.

Remarque : Il est préférable d'utiliser getCurrentCell(), qui renvoie la cellule actuellement mise en surbrillance.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];
// Returns the active cell
const cell = sheet.getActiveCell();

Renvois

Range : cellule active 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

`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.

Le terme "plage active" fait référence à la plage qu'un utilisateur a sélectionnée dans la feuille active, mais dans une fonction personnalisée, il fait référence à la cellule en cours de recalcul.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const activeRange = sheet.getActiveRange();

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

Voir aussi

setActiveRange(range)

`getActiveRangeList()`

Renvoie la liste des plages actives dans la feuille active ou null s'il n'y a pas de plages actives.

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

const sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
const activeRangeList = sheet.getActiveRangeList();

Renvois

RangeList : 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

Voir aussi

setActiveRangeList(rangeList)

`getActiveSheet()`

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

La feuille active d'une feuille de calcul est celle qui est affichée dans l'interface utilisateur de la feuille de calcul.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();

Renvois

Sheet : feuille active de la feuille de calcul.

`getAs(contentType)`

Renvoie les données de cet objet sous forme de blob converti au type de contenu spécifié. Cette méthode ajoute l'extension appropriée au nom de fichier (par exemple, "myfile.pdf"). Toutefois, il suppose que la partie du nom de fichier qui suit le dernier point (le cas échéant) est une extension existante qui doit être remplacée. Par conséquent, "ShoppingList.12.25.2014" devient "ShoppingList.12.25.pdf".

Pour consulter les quotas quotidiens pour les conversions, consultez Quotas pour les services Google. Les domaines Google Workspace nouvellement créés peuvent être temporairement soumis à des quotas plus stricts.

Paramètres

Nom	Type	Description
`contentType`	`String`	Type MIME vers lequel effectuer la conversion. Pour la plupart des blobs, `'application/pdf'` est la seule option valide. Pour les images au format BMP, GIF, JPEG ou PNG, les extensions `'image/bmp'`, `'image/gif'`, `'image/jpeg'` ou `'image/png'` sont également valides. Pour un document Google Docs, `'text/markdown'` est également une valeur valide.

Renvois

Blob : données sous forme de blob.

`getBandings()`

Renvoie toutes les bandes de cette feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets an array of the bandings in the spreadsheet.
const bandings = ss.getBandings();

// Logs the range of the first banding in the spreadsheet to the console.
console.log(bandings[0].getRange().getA1Notation());

Renvois

Banding[] : les bandes de cette 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getBlob()`

Renvoie les données de cet objet sous forme de blob.

Renvois

Blob : données sous forme de blob.

`getColumnWidth(columnPosition)`

Récupère la largeur en pixels de la colonne spécifiée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.getColumnWidth(1));

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Position de la colonne à examiner.

Renvois

Integer : largeur de la colonne en pixels.

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 dans la feuille active ou null s'il n'y a pas de cellule actuelle. La cellule actuelle est celle qui est sélectionnée dans l'interface utilisateur de Google Sheets et qui est mise en surbrillance par une bordure sombre. Il n'y a jamais plus d'une cellule actuelle. Lorsqu'un utilisateur sélectionne une ou plusieurs plages de cellules, l'une des cellules de la sélection est la cellule actuelle.

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

Renvois

Range : 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

`getDataRange()`

Renvoie un Range correspondant aux dimensions dans lesquelles les données sont présentes.

D'un point de vue fonctionnel, cela revient à créer une plage délimitée par A1 et (Sheet.getLastColumn(), Sheet.getLastRow()).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This represents ALL the data
const range = sheet.getDataRange();
const values = range.getValues();

// This logs the spreadsheet in CSV format with a trailing comma
for (let i = 0; i < values.length; i++) {
  let row = '';
  for (let j = 0; j < values[i].length; j++) {
    if (values[i][j]) {
      row = row + values[i][j];
    }
    row = `${row},`;
  }
  Logger.log(row);
}

Renvois

Range : plage contenant toutes les données de 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getDataSourceFormulas()`

Obtient toutes les formules de source de données.

// Opens the spreadsheet by its ID. If you created your script from within a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source formulas on Sheet1.
// To get an array of data source formulas for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceFormulas = sheet.getDataSourceFormulas();

// Logs the first data source formula in the array.
console.log(dataSourceFormulas[0].getFormula());

Renvois

DataSourceFormula[] : liste des formules de source de données.

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

`getDataSourcePivotTables()`

Récupère tous les tableaux croisés dynamiques de source de données.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of the data source pivot tables on Sheet1.
// To get an array of data source pivot tables for the entire
// spreadsheet, replace 'sheet' with 'ss'.
const dataSourcePivotTables = sheet.getDataSourcePivotTables();

// Logs the last time that the first pivot table in the array was refreshed.
console.log(dataSourcePivotTables[0].getStatus().getLastRefreshedTime());

Renvois

DataSourcePivotTable[] : liste des tableaux croisés dynamiques de source de données.

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

`getDataSourceRefreshSchedules()`

Récupère les plannings d'actualisation de cette feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Activates BigQuery operations for the connected spreadsheet.
SpreadsheetApp.enableBigQueryExecution();

// Gets the frequency type of the first referesh schedule in the array.
const frequencyType = ss.getDataSourceRefreshSchedules()[0]
                          .getFrequency()
                          .getFrequencyType()
                          .toString();

// Logs the frequency type to the console.
console.log(frequencyType);

Renvois

DataSourceRefreshSchedule[] : les plannings d'actualisation de cette 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getDataSourceSheets()`

Renvoie toutes les feuilles de source de données de la feuille de calcul.

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the first data source sheet in the spreadsheet.
const dataSource = ss.getDataSourceSheets()[0];

// Gets the name of the data source sheet.
console.log(dataSource.asSheet().getName());

Renvois

DataSourceSheet[] : tableau de toutes les feuilles de source de données.

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

`getDataSourceTables()`

Récupère toutes les tables de la source de données.

// Opens the spreadsheet file by its ID. If you created your script from a
// Google Sheets file, use SpreadsheetApp.getActiveSpreadsheet().
// TODO(developer): Replace the ID with your own.
const ss = SpreadsheetApp.openById('abc123456');

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets an array of data source tables on Sheet1.
// To get an array of data source tables for the entire spreadsheet,
// replace 'sheet' with 'ss'.
const dataSourceTables = sheet.getDataSourceTables();

// Logs the last completed data execution time on the first data source table.
console.log(dataSourceTables[0].getStatus().getLastExecutionTime());

Renvois

DataSourceTable[] : liste des tables de la source de données.

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

`getDataSources()`

Renvoie toutes les sources de données de la feuille de calcul.

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

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the data sources on the spreadsheet.
const dataSources = ss.getDataSources();

// Logs the name of the first column on the first data source.
console.log(dataSources[0].getColumns()[0].getName());

Renvois

DataSource[] : tableau de toutes les sources de données.

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

`getDeveloperMetadata()`

Récupère les métadonnées de développement associées à la feuille de calcul de premier niveau.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds 'Google' as a key to the spreadsheet metadata.
ss.addDeveloperMetadata('Google');

// Gets the spreadsheet's metadata.
const ssMetadata = ss.getDeveloperMetadata();

// Gets the first set of the spreadsheet's metadata and logs the key to the
// console.
console.log(ssMetadata[0].getKey());

Renvois

DeveloperMetadata[] : métadonnées du développeur associées à cette plage.

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

`getEditors()`

Obtient la liste des éditeurs pour ce Spreadsheet.

Renvois

User[] : tableau des utilisateurs disposant des droits de modification.

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

`getFormUrl()`

Renvoie l'URL du formulaire qui envoie ses réponses à cette feuille de calcul, ou null si cette feuille de calcul n'est associée à aucun formulaire. Si plusieurs formulaires envoient des réponses à cette feuille de calcul, l'URL du formulaire renvoyée est indéterminée. Vous pouvez également récupérer les associations d'URL de formulaire par feuille à l'aide de la méthode Sheet.getFormUrl(). Génère une exception si l'utilisateur n'est pas autorisé à modifier la feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the form URL from the spreadsheet.
const formUrl = ss.getFormUrl();

// Logs the form URL to the console.
console.log(formUrl);

Renvois

String : URL du formulaire qui place ses réponses dans cette feuille de calcul, ou null si cette feuille de calcul n'a pas de formulaire associé.

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

`getFrozenColumns()`

Affiche le nombre de colonnes figées.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen columns: %s', sheet.getFrozenColumns());

Renvois

Integer : nombre de colonnes figées.

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

`getFrozenRows()`

Renvoie le nombre de lignes figées.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log('Number of frozen rows: %s', sheet.getFrozenRows());

Renvois

Integer : nombre de lignes figées.

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

`getId()`

Obtient un identifiant unique pour cette feuille de calcul. 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 logs the ID for the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getId());

Renvois

String : identifiant unique (ou clé) de la feuille de calcul.

`getImages()`

Renvoie toutes les images hors grille de la feuille.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets Sheet1 by its name.
const sheet = ss.getSheetByName('Sheet1');

// Gets the over-the-grid images from Sheet1.
// To get the over-the-grid images from the entire spreadsheet, use
// ss.getImages() instead.
const images = sheet.getImages();

// For each image, logs the anchor cell in A1 notation.
for (const image of images) {
  console.log(image.getAnchorCell().getA1Notation());
}

Renvois

OverGridImage[] : un tableau d'images superposées.

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

`getIterativeCalculationConvergenceThreshold()`

Renvoie la valeur de seuil utilisée lors du calcul itératif. Lorsque les résultats de calculs successifs diffèrent de moins que cette valeur, le calcul itératif s'arrête.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Renvois

Number : seuil de convergence.

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

`getLastColumn()`

Renvoie la position de la dernière colonne contenant du contenu.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Renvois

Integer : dernière colonne de la feuille contenant du contenu.

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

`getLastRow()`

Renvoie la position de la dernière ligne contenant du contenu.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This logs the value in the very last cell of this sheet
const lastRow = sheet.getLastRow();
const lastColumn = sheet.getLastColumn();
const lastCell = sheet.getRange(lastRow, lastColumn);
Logger.log(lastCell.getValue());

Renvois

Integer : dernière ligne de la feuille contenant du contenu.

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

`getMaxIterativeCalculationCycles()`

Renvoie le nombre maximal d'itérations à utiliser lors du calcul itératif.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Renvois

Integer : nombre maximal d'itérations 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getName()`

Récupère le nom du document.

const ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getName());

Renvois

String : nom de 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getNamedRanges()`

Récupère toutes les plages nommées de cette feuille de calcul.

// The code below logs the name of the first named range.
const namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (let i = 0; i < namedRanges.length; i++) {
  Logger.log(namedRanges[i].getName());
}

Renvois

NamedRange[] : tableau de toutes les plages nommées de 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getNumSheets()`

Renvoie le nombre de feuilles de calcul dans cette feuille de calcul.

// The code below logs the number of sheets in the active spreadsheet.
Logger.log(SpreadsheetApp.getActiveSpreadsheet().getNumSheets());

Renvois

Integer : nombre de feuilles dans la feuille de calcul.

`getOwner()`

Renvoie le propriétaire du document ou null pour un document dans un Drive partagé.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const owner = ss.getOwner();
Logger.log(owner.getEmail());

Renvois

User : propriétaire du document, ou null si le document se trouve dans un Drive partagé.

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

`getPredefinedSpreadsheetThemes()`

Renvoie la liste des thèmes prédéfinis.

// The code below returns the list of predefined themes.
const predefinedThemesList =
    SpreadsheetApp.getActiveSpreadsheet().getPredefinedSpreadsheetThemes();

Renvois

SpreadsheetTheme[] : liste des thèmes prédéfinis.

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

`getProtections(type)`

Renvoie un tableau d'objets représentant toutes les plages ou feuilles protégées de la feuille de calcul.

// Remove all range protections in the spreadsheet that the user has permission
// to edit.
const ss = SpreadsheetApp.getActive();
const protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

// Remove all sheet protections in the spreadsheet that the user has permission
// to edit.
const ss = SpreadsheetApp.getActive();
const protections = ss.getProtections(SpreadsheetApp.ProtectionType.SHEET);
for (let i = 0; i < protections.length; i++) {
  const protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

Paramètres

Nom	Type	Description
`type`	`ProtectionType`	Type de zone protégée, `SpreadsheetApp.ProtectionType.RANGE` ou `SpreadsheetApp.ProtectionType.SHEET`.

Renvois

Protection[] : tableau d'objets représentant toutes les plages ou feuilles protégées de 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getRange(a1Notation)`

Renvoie la plage spécifiée dans la notation A1 ou R1C1.

// Get a range A1:D4 on sheet titled "Invoices"
const ss = SpreadsheetApp.getActiveSpreadsheet();
const range = ss.getRange('Invoices!A1:D4');

// Get cell A1 on the first sheet
const sheet = ss.getSheets()[0];
const cell = sheet.getRange('A1');

Paramètres

Nom	Type	Description
`a1Notation`	`String`	Plage à renvoyer, spécifiée en notation A1 ou R1C1.

Renvois

Range : plage à l'emplacement indiqué.

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

`getRangeByName(name)`

Renvoie une plage nommée ou null si aucune plage portant le nom donné n'est trouvée. Si plusieurs feuilles de la feuille de calcul utilisent le même nom de plage, spécifiez le nom de la feuille sans guillemets supplémentaires (par exemple, getRangeByName('TaxRates') ou getRangeByName('Sheet Name!TaxRates'), mais pas getRangeByName('"Sheet Name"!TaxRates')).

// Log the number of columns for the range named 'TaxRates' in the active
// spreadsheet.
const range = SpreadsheetApp.getActiveSpreadsheet().getRangeByName('TaxRates');
if (range != null) {
  Logger.log(range.getNumColumns());
}

Paramètres

Nom	Type	Description
`name`	`String`	Nom de la plage à obtenir.

Renvois

Range : plage de cellules portant le nom indiqué.

`getRangeList(a1Notations)`

Renvoie la collection RangeList représentant les plages de la même feuille spécifiées par une liste non vide de notations A1 ou R1C1.

// Get a list of ranges A1:D4, F1:H4.
const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const rangeList = sheet.getRangeList(['A1:D4', 'F1:H4']);

Paramètres

Nom	Type	Description
`a1Notations`	`String[]`	Liste des plages à renvoyer, spécifiée en notation A1 ou R1C1.

Renvois

RangeList : liste des plages à l'emplacement désigné.

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

`getRecalculationInterval()`

Renvoie l'intervalle de calcul pour cette feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Logs the calculation interval for the spreadsheet to the console.
console.log(ss.getRecalculationInterval().toString());

Renvois

RecalculationInterval : intervalle de calcul pour cette 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getRowHeight(rowPosition)`

Récupère la hauteur en pixels de la ligne donnée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.getRowHeight(1));

Paramètres

Nom	Type	Description
`rowPosition`	`Integer`	Position de la ligne à examiner.

Renvois

Integer : hauteur de la ligne en pixels.

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.getActiveSpreadsheet().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

`getSheetById(id)`

Récupère la feuille avec l'ID donné. Utilisez Sheet.getSheetId().

const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetById(12345);

Paramètres

Nom	Type	Description
`id`	`Integer`	ID de la feuille à récupérer.

Renvois

Sheet : feuille associée à l'ID donné ou null si aucune feuille n'est trouvée.

`getSheetByName(name)`

Renvoie une feuille portant le nom indiqué.

Si plusieurs feuilles portent le même nom, celle située le plus à gauche est renvoyée. Renvoie null s'il n'existe aucune feuille portant le nom donné.

// The code below logs the index of a sheet named "Expenses"
const sheet = SpreadsheetApp.getActiveSpreadsheet().getSheetByName('Expenses');
if (sheet != null) {
  Logger.log(sheet.getIndex());
}

Paramètres

Nom	Type	Description
`name`	`String`	Nom de la feuille à obtenir.

Renvois

Sheet : feuille portant le nom indiqué.

`getSheetId()`

Renvoie l'ID de la feuille représentée par cet objet.

Il s'agit d'un identifiant unique pour la feuille de calcul. Il s'agit d'un entier croissant de manière monotone, attribué au moment de la création de la feuille et indépendant de sa position. Cela est utile en combinaison avec des méthodes telles que Range.copyFormatToRange(gridId, column, columnEnd, row, rowEnd) qui acceptent un paramètre gridId plutôt qu'une instance Sheet.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetId());

Renvois

Integer : identifiant de la feuille unique à 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getSheetName()`

Renvoie le nom de la feuille.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

Logger.log(sheet.getSheetName());

Renvois

String : nom de la feuille.

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

`getSheetValues(startRow, startColumn, numRows, numColumns)`

Renvoie la grille rectangulaire de valeurs pour cette plage en commençant aux coordonnées indiquées. Une valeur "-1" indiquée comme position de ligne ou de colonne équivaut à obtenir la toute dernière ligne ou colonne contenant des données dans la feuille.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// The two samples below produce the same output
let values = sheet.getSheetValues(1, 1, 3, 3);
Logger.log(values);

const range = sheet.getRange(1, 1, 3, 3);
values = range.getValues();
Logger.log(values);

Paramètres

Nom	Type	Description
`startRow`	`Integer`	Position de la ligne de départ.
`startColumn`	`Integer`	Position de la colonne de départ.
`numRows`	`Integer`	Nombre de lignes pour lesquelles renvoyer des valeurs.
`numColumns`	`Integer`	Nombre de colonnes pour lesquelles renvoyer des valeurs.

Renvois

Object[][] : tableau bidimensionnel de valeurs.

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

`getSheets()`

Récupère toutes les feuilles de calcul.

// The code below logs the name of the second sheet
const sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
// Iterates through the sheets and logs the name and ID of each sheet.
for (const sheet of sheets) {
  Logger.log(`name: ${sheet.getName()}, ID: ${sheet.getSheetId()}`);
}

Renvois

Sheet[] : tableau de toutes les feuilles du tableur.

`getSpreadsheetLocale()`

Récupère les paramètres régionaux de la feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Renvois

String : paramètres régionaux de 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.currentonly
https://www.googleapis.com/auth/spreadsheets

`getSpreadsheetTheme()`

Renvoie le thème actuel de la feuille de calcul ou null si aucun thème n'est appliqué.

// The code below returns the current theme of the spreadsheet.
const currentTheme =
    SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

Renvois

SpreadsheetTheme : thème actuellement appliqué.

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

`getSpreadsheetTimeZone()`

Récupère le fuseau horaire de la feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Renvois

String : fuseau horaire, spécifié au format "long" (par exemple, "America/New_York", tel qu'indiqué sur Joda.org).

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

`getUrl()`

Renvoie l'URL de la feuille de calcul donnée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
Logger.log(ss.getUrl());

Renvois

String : URL de la feuille de calcul concerné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

`getViewers()`

Obtient la liste des lecteurs et des commentateurs pour ce Spreadsheet.

Renvois

User[] : tableau d'utilisateurs disposant d'une autorisation d'affichage ou de commentaire.

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

`hideColumn(column)`

Masque la ou les colonnes de la plage indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first column
let range = sheet.getRange('A1');
sheet.hideColumn(range);

// This hides the first 3 columns
range = sheet.getRange('A:C');
sheet.hideColumn(range);

Paramètres

Nom	Type	Description
`column`	`Range`	Plage de colonnes à masquer.

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

`hideRow(row)`

Masque les lignes de la plage indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This hides the first row
const range = sheet.getRange('A1');
sheet.hideRow(range);

Paramètres

Nom	Type	Description
`row`	`Range`	Plage de lignes à masquer.

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

`insertColumnAfter(afterPosition)`

Insère une colonne après la position de colonne indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column after the first column position
sheet.insertColumnAfter(1);

Paramètres

Nom	Type	Description
`afterPosition`	`Integer`	Colonne après laquelle la nouvelle colonne doit être ajoutée.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`insertColumnBefore(beforePosition)`

Insère une colonne avant la position de colonne indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a column in the first column position
sheet.insertColumnBefore(1);

Paramètres

Nom	Type	Description
`beforePosition`	`Integer`	Colonne avant laquelle la nouvelle colonne doit être ajoutée.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`insertColumnsAfter(afterPosition, howMany)`

Insère un nombre donné de colonnes après la position de colonne indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Inserts two columns after the first column on the first sheet of the
// spreadsheet.
sheet.insertColumnsAfter(1, 2);

Paramètres

Nom	Type	Description
`afterPosition`	`Integer`	Colonne après laquelle la nouvelle colonne doit être ajoutée.
`howMany`	`Integer`	Nombre de colonnes à insérer.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`insertColumnsBefore(beforePosition, howMany)`

Insère un certain nombre de colonnes avant la position de colonne indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five columns before the first column
sheet.insertColumnsBefore(1, 5);

Paramètres

Nom	Type	Description
`beforePosition`	`Integer`	Colonne avant laquelle la nouvelle colonne doit être ajoutée.
`howMany`	`Integer`	Nombre de colonnes à insérer.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`insertDataSourceSheet(spec)`

Insère un DataSourceSheet dans la feuille de calcul et lance l'exécution des données. Par ailleurs, la nouvelle feuille devient la feuille active.

Génère une exception si le type de source de données n'est pas activé. Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour un type de source de données spécifique.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Builds a data source specification.
// TODO (developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
                           .asBigQuery()
                           .setProjectId('project-id-1')
                           .setTableProjectId('bigquery-public-data')
                           .setDatasetId('ncaa_basketball')
                           .setTableId('mbb_historical_teams_games')
                           .build();

// Adds the data source and its data to the spreadsheet.
ss.insertDataSourceSheet(dataSourceSpec);

Paramètres

Nom	Type	Description
`spec`	`DataSourceSpec`	Spécification de la source de données à insérer.

Renvois

DataSourceSheet : feuille de la nouvelle source de données.

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

`insertImage(blobSource, column, row)`

Insère un Spreadsheet en tant qu'image dans le document, à une ligne et une colonne données. La taille de l'image est extraite du contenu du blob. La taille maximale autorisée pour les blobs est de 2 Mo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Paramètres

Nom	Type	Description
`blobSource`	`BlobSource`	Objet blob contenant le contenu, le type MIME et (facultativement) le nom de l'image.
`column`	`Integer`	Position de la colonne.
`row`	`Integer`	Position de la ligne.

Renvois

OverGridImage : image inséré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

`insertImage(blobSource, column, row, offsetX, offsetY)`

Insère un Spreadsheet en tant qu'image dans le document, à une ligne et une colonne données, avec un décalage en pixels. La taille de l'image est récupérée à partir du contenu du blob. La taille maximale autorisée pour les blobs est de 2 Mo.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const binaryData = [];  // TODO(developer): Replace with your binary data.
const blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Paramètres

Nom	Type	Description
`blobSource`	`BlobSource`	Objet blob contenant le contenu, le type MIME et (facultativement) le nom de l'image.
`column`	`Integer`	Position de la colonne.
`row`	`Integer`	Position de la ligne.
`offsetX`	`Integer`	Décalage horizontal par rapport au coin de la cellule, en pixels.
`offsetY`	`Integer`	Décalage vertical par rapport au coin de la cellule, en pixels.

Renvois

OverGridImage : image inséré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

`insertImage(url, column, row)`

Insère une image dans le document à une ligne et une colonne données.

L'URL fournie doit être accessible au public.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage('https://www.google.com/images/srpr/logo3w.png', 1, 1);

Paramètres

Nom	Type	Description
`url`	`String`	URL de l'image
`column`	`Integer`	Position de la colonne dans la grille.
`row`	`Integer`	Position de la ligne dans la grille.

Renvois

OverGridImage : image inséré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

`insertImage(url, column, row, offsetX, offsetY)`

Insère une image dans le document à une ligne et une colonne données, avec un décalage en pixels.

L'URL fournie doit être accessible au public.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.insertImage(
    'https://www.google.com/images/srpr/logo3w.png',
    1,
    1,
    10,
    10,
);

Paramètres

Nom	Type	Description
`url`	`String`	URL de l'image.
`column`	`Integer`	Position de la colonne.
`row`	`Integer`	Position de la ligne.
`offsetX`	`Integer`	Décalage horizontal par rapport au coin de la cellule, en pixels.
`offsetY`	`Integer`	Décalage vertical par rapport au coin de la cellule, en pixels.

Renvois

OverGridImage : image inséré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

`insertRowAfter(afterPosition)`

Insère une ligne après la position de ligne donnée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row after the first row position
sheet.insertRowAfter(1);

Paramètres

Nom	Type	Description
`afterPosition`	`Integer`	Ligne après laquelle la nouvelle ligne doit être ajoutée.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`insertRowBefore(beforePosition)`

Insère une ligne avant la position de ligne donnée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts a row before the first row position
sheet.insertRowBefore(1);

Paramètres

Nom	Type	Description
`beforePosition`	`Integer`	Ligne avant laquelle la nouvelle ligne doit être ajoutée.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`insertRowsAfter(afterPosition, howMany)`

Insère un certain nombre de lignes après la position de ligne donnée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows after the first row
sheet.insertRowsAfter(1, 5);

Paramètres

Nom	Type	Description
`afterPosition`	`Integer`	Ligne après laquelle les nouvelles lignes doivent être ajoutées.
`howMany`	`Integer`	Nombre de lignes à insérer.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`insertRowsBefore(beforePosition, howMany)`

Insère un certain nombre de lignes avant la position de ligne indiquée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This inserts five rows before the first row
sheet.insertRowsBefore(1, 5);

Paramètres

Nom	Type	Description
`beforePosition`	`Integer`	Ligne avant laquelle les nouvelles lignes doivent être ajoutées.
`howMany`	`Integer`	Nombre de lignes à insérer.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`insertSheet()`

Insère une nouvelle feuille dans la feuille de calcul, en utilisant un nom de feuille par défaut. La nouvelle feuille devient la feuille active.

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet();

Renvois

Sheet : la nouvelle feuille.

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

`insertSheet(sheetIndex)`

Insère une feuille dans la feuille de calcul à l'index indiqué. La nouvelle feuille devient la feuille active.

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet(1);

Paramètres

Nom	Type	Description
`sheetIndex`	`Integer`	Index de la feuille nouvellement créée. Pour insérer une feuille en première position dans la feuille de calcul, définissez-la sur 0.

Renvois

Sheet : la nouvelle feuille.

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

`insertSheet(sheetIndex, options)`

Insère une nouvelle feuille dans la feuille de calcul à l'index donné et utilise des arguments avancés facultatifs. La nouvelle feuille devient la feuille active.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const templateSheet = ss.getSheetByName('Sales');
ss.insertSheet(1, {template: templateSheet});

Paramètres

Nom	Type	Description
`sheetIndex`	`Integer`	Index de la feuille nouvellement créée. Pour insérer une feuille en première position dans la feuille de calcul, définissez-la sur 0.
`options`	`Object`	Arguments avancés JavaScript facultatifs.

Paramètres avancés

Nom	Type	Description
`template`	`Sheet`	Toutes les données de l'objet de feuille modèle sont copiées dans la nouvelle feuille. Le modèle de feuille doit être l'une des feuilles de l'objet Spreadsheet.

Renvois

Sheet : la nouvelle feuille.

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

`insertSheet(options)`

Insère une nouvelle feuille dans la feuille de calcul, en utilisant un nom de feuille par défaut et des arguments avancés facultatifs. La nouvelle feuille devient la feuille active.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const templateSheet = ss.getSheetByName('Sales');
ss.insertSheet({template: templateSheet});

Paramètres

Nom	Type	Description
`options`	`Object`	Arguments avancés JavaScript facultatifs, listés ci-dessous.

Paramètres avancés

Nom	Type	Description
`template`	`Sheet`	Toutes les données de l'objet de feuille modèle sont copiées dans la nouvelle feuille. Le modèle de feuille doit être l'une des feuilles de cet objet Spreadsheet.

Renvois

Sheet : la nouvelle feuille.

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

`insertSheet(sheetName)`

Insère une nouvelle feuille dans la feuille de calcul avec le nom indiqué. La nouvelle feuille devient la feuille active.

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet');

Paramètres

Nom	Type	Description
`sheetName`	`String`	Nom de la nouvelle feuille.

Renvois

Sheet : la nouvelle feuille.

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

`insertSheet(sheetName, sheetIndex)`

Insère une feuille dans la feuille de calcul avec le nom et l'index spécifiés. La nouvelle feuille devient la feuille active.

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.insertSheet('My New Sheet', 1);

Paramètres

Nom	Type	Description
`sheetName`	`String`	Nom de la nouvelle feuille.
`sheetIndex`	`Integer`	Index de la feuille nouvellement créée. Pour insérer une feuille en première position dans la feuille de calcul, définissez-la sur 0.

Renvois

Sheet : la nouvelle feuille.

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

`insertSheet(sheetName, sheetIndex, options)`

Insère une nouvelle feuille dans la feuille de calcul avec le nom donné à l'index donné et utilise des arguments avancés facultatifs. La nouvelle feuille devient la feuille active.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', 1, {template: templateSheet});

Paramètres

Nom	Type	Description
`sheetName`	`String`	Nom de la nouvelle feuille.
`sheetIndex`	`Integer`	Index de la feuille insérée. Pour insérer une feuille en première position dans une feuille de calcul, définissez-la sur 0.
`options`	`Object`	Arguments avancés JavaScript facultatifs.

Paramètres avancés

Nom	Type	Description
`template`	`Sheet`	Toutes les données de l'objet de feuille modèle sont copiées dans la nouvelle feuille. Le modèle de feuille doit être l'une des feuilles de l'objet Spreadsheet.

Renvois

Sheet : la nouvelle feuille.

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

`insertSheet(sheetName, options)`

Insère une nouvelle feuille dans la feuille de calcul avec le nom donné et utilise des arguments avancés facultatifs. La nouvelle feuille devient la feuille active.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const templateSheet = ss.getSheetByName('Sales');
ss.insertSheet('My New Sheet', {template: templateSheet});

Paramètres

Nom	Type	Description
`sheetName`	`String`	Nom de la nouvelle feuille.
`options`	`Object`	Arguments avancés JavaScript facultatifs.

Paramètres avancés

Nom	Type	Description
`template`	`Sheet`	Toutes les données de l'objet de feuille modèle sont copiées dans la nouvelle feuille. Le modèle de feuille doit être l'une des feuilles de l'objet Spreadsheet.

Renvois

Sheet : la nouvelle feuille.

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

`insertSheetWithDataSourceTable(spec)`

Insère une feuille dans la feuille de calcul, crée un DataSourceTable couvrant toute la feuille avec la spécification de source de données donnée et lance l'exécution des données. Par ailleurs, la nouvelle feuille devient la feuille active.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Adds a sheet and sets cell A1 as the parameter cell.
const parameterCell = ss.insertSheet('parameterSheet').getRange('A1');

// Sets the value of the parameter cell to 'Duke'.
parameterCell.setValue('Duke');

const query = 'select * from `bigquery-public-data`.`ncaa_basketball`.' +
    '`mbb_historical_tournament_games` WHERE win_school_ncaa = @SCHOOL';

// Adds a data source with a query parameter.
// TODO(developer): Update the project ID to your own Google Cloud project ID.
const dataSourceSpec = SpreadsheetApp.newDataSourceSpec()
                           .asBigQuery()
                           .setProjectId('project-id-1')
                           .setRawQuery(query)
                           .setParameterFromCell('SCHOOL', 'parameterSheet!A1')
                           .build();

// Adds sheets for the data source and data source table to the spreadsheet.
ss.insertSheetWithDataSourceTable(dataSourceSpec);

Paramètres

Nom	Type	Description
`spec`	`DataSourceSpec`	Spécification de la source de données à insérer.

Renvois

Sheet : la nouvelle feuille.

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

`isColumnHiddenByUser(columnPosition)`

Indique si la colonne spécifiée est masquée par l'utilisateur.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Columns start at 1
Logger.log(sheet.isColumnHiddenByUser(1));

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Position de la colonne à examiner.

Renvois

Boolean : true si la colonne est masquée, false sinon.

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

`isIterativeCalculationEnabled()`

Indique si le calcul itératif est activé dans cette feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Renvois

Boolean : true si le calcul itératif est activé, false dans le cas contraire.

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

`isRowHiddenByFilter(rowPosition)`

Indique si la ligne donnée est masquée par un filtre (et non par une vue filtrée).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByFilter(1));

Paramètres

Nom	Type	Description
`rowPosition`	`Integer`	Position de la ligne à examiner.

Renvois

Boolean : true si la ligne est masquée, false sinon.

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

`isRowHiddenByUser(rowPosition)`

Indique si la ligne donnée est masquée par l'utilisateur.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Rows start at 1
Logger.log(sheet.isRowHiddenByUser(1));

Paramètres

Nom	Type	Description
`rowPosition`	`Integer`	Position de la ligne à examiner.

Renvois

Boolean : true si la ligne est masquée, false sinon.

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

`moveActiveSheet(pos)`

Déplace la feuille active à la position indiquée dans la liste des feuilles. Génère une exception si la position est négative ou supérieure au nombre de feuilles.

// This example assumes that there are 2 sheets in the current
// active spreadsheet: one named "first" in position 1 and another named
// "second" in position 2.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
const sheet = spreadsheet.getSheetByName('first').activate();

// Logs 'Current index of sheet: 1'
console.log('Current index of sheet: %s', sheet.getIndex());

spreadsheet.moveActiveSheet(2);

// Logs 'New index of sheet: 2'
console.log('New index of sheet: %s', sheet.getIndex());

Paramètres

Nom	Type	Description
`pos`	`Integer`	Position (indexée à 1) à laquelle déplacer la feuille active dans la liste des feuilles.

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

`moveChartToObjectSheet(chart)`

Crée une feuille SheetType.OBJECT et y déplace le graphique fourni. Si le graphique se trouve déjà sur sa propre feuille, cette feuille est renvoyée sans qu'une nouvelle soit créée.

const sheet = SpreadsheetApp.getActiveSheet();
const chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
const objectSheet = SpreadsheetApp.getActive().moveChartToObjectSheet(chart);

Paramètres

Nom	Type	Description
`chart`	`EmbeddedChart`	Graphique à déplacer.

Renvois

Sheet : feuille sur laquelle se trouve le graphique.

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

`refreshAllDataSources()`

Actualise toutes les sources de données compatibles et leurs objets de source de données associés, en ignorant les objets de source de données non valides.

Utilisez les méthodes SpreadsheetApp#enable...Execution() pour activer l'exécution des données pour un type de source de données spécifique.

// Activates BigQuery operations.
SpreadsheetApp.enableBigQueryExecution();

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Gets the first data source sheet on the spreadsheet.
const dataSheet = ss.getDataSourceSheets()[0];

// Refreshes all data sources on the spreadsheet.
ss.refreshAllDataSources();

// Logs the last refreshed time of the first data source sheet.
console.log(
    `Last refresh time: ${dataSheet.getStatus().getLastRefreshedTime()}`,
);

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

`removeEditor(emailAddress)`

Supprime l'utilisateur donné de la liste des éditeurs pour le Spreadsheet. Cette méthode n'empêche pas les utilisateurs d'accéder à Spreadsheet s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si Spreadsheet est partagé avec l'ensemble du domaine de l'utilisateur ou si Spreadsheet se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

Nom	Type	Description
`emailAddress`	`String`	Adresse e-mail de l'utilisateur à supprimer.

Renvois

Spreadsheet : ce Spreadsheet, pour le chaînage.

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

`removeEditor(user)`

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des lecteurs.

Paramètres

Nom	Type	Description
`user`	`User`	Représentation de l'utilisateur à supprimer.

Renvois

Spreadsheet : ce Spreadsheet, pour le chaînage.

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

`removeMenu(name)`

Supprime un menu qui a été ajouté par addMenu(name, subMenus). L'argument name doit avoir la même valeur que l'appel addMenu(name, subMenus) correspondant.

// The onOpen function is executed automatically every time a Spreadsheet is
// loaded
function onOpen() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu('badMenu', [
    {name: 'remove bad menu', functionName: 'removeBadMenu'},
    {name: 'foo', functionName: 'foo'},
  ]);
}
function removeBadMenu() {
  const ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.removeMenu(
      'badMenu');  // name must match the name used when added the menu
}
function foo() {
  // Do nothing
}

Paramètres

Nom	Type	Description
`name`	`String`	Nom du menu à supprimer.

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

`removeNamedRange(name)`

Supprime une plage nommée avec le nom donné. Génère une exception si aucune plage portant le nom donné n'est trouvée dans la feuille de calcul.

// The code below creates a new named range "foo", and then remove it.
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange('foo', ss.getActiveRange());
ss.removeNamedRange('foo');

Paramètres

Nom	Type	Description
`name`	`String`	Nom de la plage.

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

`removeViewer(emailAddress)`

Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs du Spreadsheet. Cette méthode n'a aucun effet si l'utilisateur est un éditeur, et non un lecteur ou un commentateur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder à Spreadsheet s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si Spreadsheet est partagé avec l'ensemble du domaine de l'utilisateur ou si Spreadsheet se trouve dans un Drive partagé auquel l'utilisateur peut accéder).Spreadsheet

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des éditeurs.

Paramètres

Nom	Type	Description
`emailAddress`	`String`	Adresse e-mail de l'utilisateur à supprimer.

Renvois

Spreadsheet : ce Spreadsheet pour le chaînage.

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

`removeViewer(user)`

Supprime l'utilisateur spécifié de la liste des spectateurs et des commentateurs du Spreadsheet. Cette méthode n'a aucun effet si l'utilisateur est un éditeur et non un lecteur. Cette méthode n'empêche pas non plus les utilisateurs d'accéder à Spreadsheet s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général (par exemple, si Spreadsheet est partagé avec l'ensemble du domaine de l'utilisateur ou si Spreadsheet se trouve dans un Drive partagé auquel l'utilisateur peut accéder).

Pour les fichiers Drive, cela supprime également l'utilisateur de la liste des éditeurs.

Paramètres

Nom	Type	Description
`user`	`User`	Représentation de l'utilisateur à supprimer.

Renvois

Spreadsheet : ce Spreadsheet pour le chaînage.

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

`rename(newName)`

Renomme le document.

const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.rename('This is the new name');

Paramètres

Nom	Type	Description
`newName`	`String`	Nouveau nom du document.

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

`renameActiveSheet(newName)`

Renomme la feuille active actuelle avec le nouveau nom indiqué.

// The code below renames the active sheet to "Hello world"
SpreadsheetApp.getActiveSpreadsheet().renameActiveSheet('Hello world');

Paramètres

Nom	Type	Description
`newName`	`String`	Nouveau nom de la feuille active 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

`resetSpreadsheetTheme()`

Supprime le thème appliqué et définit le thème par défaut dans la feuille de calcul.

// The code below applies default theme on the spreadsheet.
SpreadsheetApp.getActiveSpreadsheet().resetSpreadsheetTheme();

Renvois

SpreadsheetTheme : thème par défaut.

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

`setActiveRange(range)`

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

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const range = sheet.getRange('A1:D4');
sheet.setActiveRange(range);

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

Paramètres

Nom	Type	Description
`range`	`Range`	Plage à définir comme plage active.

Renvois

Range : la nouvelle 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

`setActiveRangeList(rangeList)`

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

const sheet = SpreadsheetApp.getActiveSheet();
const rangeList = sheet.getRangeList(['D4', 'B2:C4']);
sheet.setActiveRangeList(rangeList);

const selection = sheet.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

Nom	Type	Description
`rangeList`	`RangeList`	Liste 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

`setActiveSelection(range)`

Définit la région de sélection active pour cette feuille.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const range = sheet.getRange('A1:D4');
sheet.setActiveSelection(range);

Paramètres

Nom	Type	Description
`range`	`Range`	Plage à définir comme sélection active.

Renvois

Range : la nouvelle 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

`setActiveSelection(a1Notation)`

Définit la sélection active, comme spécifié dans la notation A1 ou R1C1.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

sheet.setActiveSelection('A1:D4');

Paramètres

Nom	Type	Description
`a1Notation`	`String`	Plage à définir comme active, spécifiée dans la notation A1 ou R1C1.

Renvois

Range : la nouvelle 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

`setActiveSheet(sheet)`

Définit la feuille donnée comme feuille active dans la 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 first sheet active in the active spreadsheet.
const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

Paramètres

Nom	Type	Description
`sheet`	`Sheet`	Feuille à définir comme feuille active.

Renvois

Sheet : 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

`setActiveSheet(sheet, restoreSelection)`

Définit la feuille donnée comme feuille active dans la feuille de calcul, avec une option permettant 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

Nom	Type	Description
`sheet`	`Sheet`	Nouvelle feuille active.
`restoreSelection`	`Boolean`	Si 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 : 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

`setColumnWidth(columnPosition, width)`

Définit la largeur de la colonne donnée en pixels.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first column to a width of 200 pixels
sheet.setColumnWidth(1, 200);

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Position de la colonne à définir.
`width`	`Integer`	Largeur en pixels à définir.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`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, toute 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 une exception est générée.

const sheet = SpreadsheetApp.getActiveSpreadsheet().getActiveSheet();
const cell = sheet.getRange('B5');
sheet.setCurrentCell(cell);

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

Paramètres

Nom	Type	Description
`cell`	`Range`	Cellule à 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

`setFrozenColumns(columns)`

Fige le nombre de colonnes indiqué. Si la valeur est zéro, aucune colonne n'est figée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first column
sheet.setFrozenColumns(1);

Paramètres

Nom	Type	Description
`columns`	`Integer`	Nombre de colonnes à figer.

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

`setFrozenRows(rows)`

Gèle le nombre de lignes indiqué. Si la valeur est zéro, aucune ligne n'est figée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Freezes the first row
sheet.setFrozenRows(1);

Paramètres

Nom	Type	Description
`rows`	`Integer`	Nombre de lignes à figer.

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

`setIterativeCalculationConvergenceThreshold(minThreshold)`

Définit la valeur de seuil minimale pour le calcul itératif. Lorsque les résultats de calculs successifs diffèrent de moins que cette valeur, le calcul itératif s'arrête. Cette valeur doit être non négative et est définie sur 0, 05 par défaut.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the iterative calculation convergence threshold for the spreadsheet.
ss.setIterativeCalculationConvergenceThreshold(2);

// Logs the threshold to the console.
console.log(ss.getIterativeCalculationConvergenceThreshold());

Paramètres

Nom	Type	Description
`minThreshold`	`Number`	Seuil de convergence minimal (doit être non négatif).

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`setIterativeCalculationEnabled(isEnabled)`

Indique si le calcul itératif est activé dans cette feuille de calcul. Si le nombre maximal de cycles de calcul et le seuil de convergence n'ont pas été définis auparavant lorsque le calcul est activé, ils sont définis par défaut sur 50 et 0,05, respectivement. Si l'un ou l'autre a été défini précédemment, ils conservent leurs valeurs précédentes.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Activates iterative calculation on the spreadsheet.
ss.setIterativeCalculationEnabled(true);

// Logs whether iterative calculation is activated for the spreadsheet.
console.log(ss.isIterativeCalculationEnabled());

Paramètres

Nom	Type	Description
`isEnabled`	`Boolean`	`true` si le calcul itératif doit être activé, `false` dans le cas contraire.

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`setMaxIterativeCalculationCycles(maxIterations)`

Définit le nombre maximal d'itérations de calcul à effectuer lors du calcul itératif. Cette valeur doit être comprise entre 1 et 10 000 (inclus). La valeur par défaut est 50.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the max iterative calculation cycles for the spreadsheet.
ss.setMaxIterativeCalculationCycles(10);

// Logs the max iterative calculation cycles to the console.
console.log(ss.getMaxIterativeCalculationCycles());

Paramètres

Nom	Type	Description
`maxIterations`	`Integer`	Nombre maximal d'itérations de calcul (entre 1 et 10 000).

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`setNamedRange(name, range)`

Nomme une plage.

// The code below creates a new named range "TaxRates" in the active spreadsheet
const ss = SpreadsheetApp.getActiveSpreadsheet();
ss.setNamedRange('TaxRates', SpreadsheetApp.getActiveRange());

Paramètres

Nom	Type	Description
`name`	`String`	Nom à attribuer à la plage.
`range`	`Range`	Spécification de la plage.

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

`setRecalculationInterval(recalculationInterval)`

Définit la fréquence à laquelle cette feuille de calcul doit être recalculée.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets file, you can use SpreadsheetApp.getActiveSpreadsheet()
// instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the  calculation interval for the spreadsheet to 'ON_CHANGE'.
const interval = ss.setRecalculationInterval(
    SpreadsheetApp.RecalculationInterval.ON_CHANGE,
);

// Logs the calculation interval to the console.
console.log(interval);

Paramètres

Nom	Type	Description
`recalculationInterval`	`RecalculationInterval`	Nouvel intervalle de recalcul.

Renvois

Spreadsheet : cette feuille de calcul, pour le chaînage.

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

`setRowHeight(rowPosition, height)`

Définit la hauteur de la ligne spécifiée en pixels. Par défaut, les lignes s'étendent pour s'adapter au contenu des cellules. Si vous souhaitez forcer les lignes à une hauteur spécifique, utilisez Sheet.setRowHeightsForced(startRow, numRows, height).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sets the first row to a height of 200 pixels
sheet.setRowHeight(1, 200);

Paramètres

Nom	Type	Description
`rowPosition`	`Integer`	Position de la ligne à modifier.
`height`	`Integer`	Hauteur en pixels à définir.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`setSpreadsheetLocale(locale)`

Définit les paramètres régionaux de la feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the spreadsheet locale.
ss.setSpreadsheetLocale('fr');

// Gets the spreadsheet locale.
const ssLocale = ss.getSpreadsheetLocale();

// Logs the locale to the console.
console.log(ssLocale);

Paramètres

Nom	Type	Description
`locale`	`String`	Code des paramètres régionaux à utiliser (par exemple, "en", "fr" ou "en_US").

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

`setSpreadsheetTheme(theme)`

Définit un thème dans la feuille de calcul.

const spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// The code below sets the second predefined theme as the current theme of the
// spreadsheet.
const predefinedThemesList = spreadsheet.getPredefinedSpreadsheetThemes();
spreadsheet.setSpreadsheetTheme(predefinedThemesList[1]);

Paramètres

Nom	Type	Description
`theme`	`SpreadsheetTheme`	Thème à appliquer.

Renvois

SpreadsheetTheme : le nouveau thème actuel.

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

`setSpreadsheetTimeZone(timezone)`

Définit le fuseau horaire de la feuille de calcul.

// Opens the spreadsheet file by its URL. If you created your script from within
// a Google Sheets spreadsheet, you can use
// SpreadsheetApp.getActiveSpreadsheet() instead.
// TODO(developer): Replace the URL with your own.
const ss = SpreadsheetApp.openByUrl(
    'https://docs.google.com/spreadsheets/d/abc123456/edit',
);

// Sets the time zone of the spreadsheet.
ss.setSpreadsheetTimeZone('America/New_York');

// Gets the time zone of the spreadsheet.
const ssTimeZone = ss.getSpreadsheetTimeZone();

// Logs the time zone to the console.
console.log(ssTimeZone);

Paramètres

Nom	Type	Description
`timezone`	`String`	Fuseau horaire, spécifié au format "long" (par exemple, "America/New_York", tel que listé par Joda.org).

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

`show(userInterface)`

Affiche un composant d'interface utilisateur personnalisé dans une boîte de dialogue centrée dans la fenêtre d'affichage du navigateur de l'utilisateur. L'exécution du script côté serveur n'est pas suspendue. Pour communiquer avec le côté serveur, le composant d'interface utilisateur doit effectuer des rappels asynchrones au script côté serveur.

Si le script côté serveur a précédemment affiché une boîte de dialogue qui n'a pas encore été fermée, l'interface utilisateur de la boîte de dialogue existante est remplacée par celle de la nouvelle boîte de dialogue demandée.

L'extrait de code suivant affiche une application HtmlService simple dans une boîte de dialogue avec le titre, la hauteur et la largeur spécifiés :

const htmlApp = HtmlService
                    .createHtmlOutput(
                        '<p>A change of speed, a change of style...</p>',
                        )
                    .setTitle('My HtmlService Application')
                    .setWidth(250)
                    .setHeight(300);

SpreadsheetApp.getActiveSpreadsheet().show(htmlApp);

// The script resumes execution immediately after showing the dialog.

Paramètres

Nom	Type	Description
`userInterface`	`Object`	`HtmlOutput`

Autorisation

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

https://www.googleapis.com/auth/script.container.ui

`sort(columnPosition)`

Trie une feuille par colonne, par ordre croissant.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, ascending
sheet.sort(1);

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Colonne à trier.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`sort(columnPosition, ascending)`

Trie une feuille par colonne. Prend un paramètre pour spécifier l'ordre croissant ou décroissant.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// Sorts the sheet by the first column, descending
sheet.sort(1, false);

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Colonne à trier.
`ascending`	`Boolean`	`true` pour les tris croissants, `false` pour les tris décroissants.

Renvois

Sheet : feuille utile pour le chaînage des méthodes.

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

`toast(msg)`

Affiche une fenêtre pop-up en bas à droite de la feuille de calcul avec le message indiqué.

// Show a popup with the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started');

Paramètres

Nom	Type	Description
`msg`	`String`	Message à afficher dans le toast.

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

`toast(msg, title)`

Affiche une fenêtre pop-up en bas à droite de la feuille de calcul avec le message et le titre indiqués.

// Show a popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status');

Paramètres

Nom	Type	Description
`msg`	`String`	Message à afficher dans le toast.
`title`	`String`	Titre facultatif du toast.

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

`toast(msg, title, timeoutSeconds)`

Affiche une fenêtre pop-up en bas à droite de la feuille de calcul avec le titre et le message indiqués, qui reste visible pendant une certaine durée.

// Show a 3-second popup with the title "Status" and the message "Task started".
SpreadsheetApp.getActiveSpreadsheet().toast('Task started', 'Status', 3);

Paramètres

Nom	Type	Description
`msg`	`String`	Message à afficher dans le toast.
`title`	`String`	Titre facultatif du toast.
`timeoutSeconds`	`Number`	Délai d'expiration en secondes. Si la valeur est `null`, le délai d'expiration du toast est de 5 secondes par défaut. Si la valeur est négative, le toast reste affiché jusqu'à ce qu'il soit fermé.

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

`unhideColumn(column)`

Affiche la colonne dans la plage spécifiée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first column if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideColumn(range);

Paramètres

Nom	Type	Description
`column`	`Range`	Plage à afficher, si elle est masqué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

`unhideRow(row)`

Affiche la ligne dans la plage donnée.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

// This unhides the first row if it was previously hidden
const range = sheet.getRange('A1');
sheet.unhideRow(range);

Paramètres

Nom	Type	Description
`row`	`Range`	Plage à afficher, si elle est masqué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

`updateMenu(name, subMenus)`

Met à jour un menu ajouté par addMenu(name, subMenus). Fonctionne exactement comme addMenu(name, subMenus).

const ss = SpreadsheetApp.getActiveSpreadsheet();
const menuEntries = [];
menuEntries.push({name: 'Lone Menu Entry', functionName: 'function1'});
ss.updateMenu('addMenuExample', menuEntries);

Paramètres

Nom	Type	Description
`name`	`String`	Nom du menu à mettre à jour.
`subMenus`	`Object[]`	Tableau de cartes JavaScript avec les paramètres `name` et `functionName`. Vous pouvez utiliser des fonctions des bibliothèques incluses, telles que `Library.libFunction1`.

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

Attend que toutes les exécutions en cours dans la feuille de calcul soient terminées, avec un délai d'inactivité après le nombre de secondes indiqué. Génère une exception si les exécutions ne sont pas terminées lorsque le délai expire, mais n'annule pas les exécutions de données.

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Temps d'attente pour les exécutions de données, en secondes. La valeur maximale est de 300 secondes.

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

Méthodes obsolètes

`getSheetProtection()`

Obsolète. Pour les feuilles de calcul créées dans la nouvelle version de Google Sheets, utilisez Sheet.getProtections(type), qui renvoie la classe Protection plus puissante. Bien que cette méthode soit obsolète, elle reste disponible pour assurer la compatibilité avec l'ancienne version de Sheets.

Renvoie une instance PageProtection décrivant les autorisations pour la feuille de calcul actuelle.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

permissions.setProtected(true);
permissions.addUser('user@example.com');

// Logs the users that have access to edit this sheet. Note that this
// is different from access to the entire spreadsheet - getUsers()
// only returns users if permissions.isProtected() is set to true.
const users = permissions.getUsers();
Logger.log(users);

Renvois

PageProtection : objet décrivant les autorisations d'accès à la feuille.

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

`isAnonymousView()`

Obsolète. Depuis janvier 2014, cette fonction est obsolète et n'est pas disponible dans la nouvelle version de Google Sheets.

Indique si le document autorise la consultation anonyme. Comme cette fonctionnalité n'est plus disponible dans la nouvelle version de Google Sheets, utilisez plutôt File.getSharingAccess() et File.getSharingPermission().

// Determine if the document allows anonymous viewing via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());
const access = file.getSharingAccess();
const permission = file.getSharingPermission();
const isAnonymousAccess = access === DriveApp.Access.ANYONE ||
    access === DriveApp.Access.ANYONE_WITH_LINK;
const isAnonymousEdit =
    isAnonymousAccess && permission !== DriveApp.Permission.NONE;

Renvois

Boolean : true si le document autorise la consultation anonyme, false sinon.

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

Voir aussi

Service Drive

`isAnonymousWrite()`

Obsolète. Depuis janvier 2014, cette fonction est obsolète et n'est pas disponible dans la nouvelle version de Google Sheets.

Indique si le document autorise les modifications apportées par des utilisateurs anonymes. Comme cette fonctionnalité n'est plus disponible dans la nouvelle version de Google Sheets, utilisez plutôt File.getSharingAccess() et File.getSharingPermission().

// Determine if the document allow anonymous edits via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());
const access = file.getSharingAccess();
const permission = file.getSharingPermission();
const isAnonymousAccess = access === DriveApp.Access.ANYONE ||
    access === DriveApp.Access.ANYONE_WITH_LINK;
const isAnonymousEdit =
    isAnonymousAccess && permission === DriveApp.Permission.EDIT;

Renvois

Boolean : true si le document autorise la modification anonyme, false dans le cas contraire.

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

Voir aussi

Service Drive

`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`

Obsolète. Depuis janvier 2014, cette fonction est obsolète et n'est pas disponible dans la nouvelle version de Google Sheets.

Définit la règle du document concernant la lecture et l'écriture anonymes. Comme cette fonctionnalité n'est plus disponible dans la nouvelle version de Google Sheets, utilisez File.setSharing(accessType, permissionType) à la place.

// Set the document's policy on anonymous reading and writing via the Drive API.
const ss = SpreadsheetApp.getActiveSpreadsheet();
const file = DriveApp.getFileById(ss.getId());

// Set anonymous read.
file.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.VIEW);

// Set anonymous write.
file.setSharing(DriveApp.Access.ANYONE, DriveApp.Permission.EDIT);

// Disable anonymous access.
file.setSharing(DriveApp.Access.PRIVATE, file.getSharingPermission());

Paramètres

Nom	Type	Description
`anonymousReadAllowed`	`Boolean`	`true` pour autoriser les lectures anonymes, `false` sinon.
`anonymousWriteAllowed`	`Boolean`	`true` pour autoriser les lectures anonymes, `false` sinon.

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

Voir aussi

isAnonymousView()
isAnonymousWrite()
Service Drive

`setSheetProtection(permissions)`

Obsolète. Pour les feuilles de calcul créées dans la nouvelle version de Google Sheets, utilisez Sheet.protect(), qui renvoie la classe Protection plus puissante. Bien que cette méthode soit obsolète, elle reste disponible pour assurer la compatibilité avec l'ancienne version de Sheets.

Définit les autorisations pour la feuille de calcul actuelle.

const ss = SpreadsheetApp.getActiveSpreadsheet();
const sheet = ss.getSheets()[0];

const permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
const sheetToClonePermissionsTo = ss.getSheets()[1];
sheetToClonePermissionsTo.setSheetProtection(permissions);

Paramètres

Nom	Type	Description
`permissions`	`PageProtection`	Objet des autorisations d'accès à définir sur cette feuille.

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

Class Spreadsheet Restez organisé à l'aide des collections Enregistrez et classez les contenus selon vos préférences.

Méthodes

Méthodes obsolètes

Documentation détaillée

addDeveloperMetadata(key)

Paramètres

Renvois

Autorisation

addDeveloperMetadata(key, visibility)

Paramètres

Renvois

Autorisation

addDeveloperMetadata(key, value)

Paramètres

Renvois

Autorisation

addDeveloperMetadata(key, value, visibility)

Paramètres

Renvois

Autorisation

addEditor(emailAddress)

Paramètres

Renvois

Autorisation

addEditor(user)

Paramètres

Renvois

Autorisation

addEditors(emailAddresses)

Paramètres

Renvois

Autorisation

addMenu(name, subMenus)

Paramètres

Autorisation

addViewer(emailAddress)

Paramètres

Renvois

Autorisation

addViewer(user)

Paramètres

Renvois

Autorisation

addViewers(emailAddresses)

Paramètres

Renvois

Autorisation

appendRow(rowContents)

Paramètres

Renvois

Autorisation

autoResizeColumn(columnPosition)

Paramètres

Renvois

Autorisation

copy(name)

Paramètres

Renvois

Autorisation

createDeveloperMetadataFinder()

Renvois

createTextFinder(findText)

Paramètres

Renvois

deleteActiveSheet()

Renvois

Autorisation

deleteColumn(columnPosition)

Paramètres

Renvois

Autorisation

deleteColumns(columnPosition, howMany)

Paramètres

Autorisation

deleteRow(rowPosition)

Paramètres

Renvois

Autorisation

deleteRows(rowPosition, howMany)

Paramètres

Class Spreadsheet

`addDeveloperMetadata(key)`

`addDeveloperMetadata(key, visibility)`

`addDeveloperMetadata(key, value)`

`addDeveloperMetadata(key, value, visibility)`

`addEditor(emailAddress)`

`addEditor(user)`

`addEditors(emailAddresses)`

`addMenu(name, subMenus)`

`addViewer(emailAddress)`

`addViewer(user)`

`addViewers(emailAddresses)`

`appendRow(rowContents)`

`autoResizeColumn(columnPosition)`

`copy(name)`

`createDeveloperMetadataFinder()`

`createTextFinder(findText)`

`deleteActiveSheet()`

`deleteColumn(columnPosition)`

`deleteColumns(columnPosition, howMany)`

`deleteRow(rowPosition)`

`deleteRows(rowPosition, howMany)`

`deleteSheet(sheet)`

`duplicateActiveSheet()`

`getActiveCell()`

`getActiveRange()`

`getActiveRangeList()`

`getActiveSheet()`

`getAs(contentType)`

`getBandings()`

`getBlob()`

`getColumnWidth(columnPosition)`

`getCurrentCell()`

`getDataRange()`

`getDataSourceFormulas()`

`getDataSourcePivotTables()`

`getDataSourceRefreshSchedules()`

`getDataSourceSheets()`

`getDataSourceTables()`

`getDataSources()`

`getDeveloperMetadata()`

`getEditors()`

`getFormUrl()`

`getFrozenColumns()`

`getFrozenRows()`