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

Class Spreadsheet

accéder et modifier des fichiers Google Sheets ; 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 les métadonnées de développement avec la clé et la visibilité spécifiées à la feuille de calcul.
`addDeveloperMetadata(key, value)`	`Spreadsheet`	Ajoute les métadonnées de développement 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éveloppement à 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 de l'`Spreadsheet`.
`addEditor(user)`	`Spreadsheet`	Ajoute l'utilisateur donné à la liste des éditeurs de l'`Spreadsheet`.
`addEditors(emailAddresses)`	`Spreadsheet`	Ajoute le tableau d'utilisateurs donné à la liste des éditeurs de l'`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 de l'`Spreadsheet`.
`addViewer(user)`	`Spreadsheet`	Ajoute l'utilisateur donné à la liste des spectateurs de l'`Spreadsheet`.
`addViewers(emailAddresses)`	`Spreadsheet`	Ajoute le tableau d'utilisateurs donné à la liste des spectateurs de l'`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`	Copier la feuille de calcul et renvoyer 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 permet de rechercher et de remplacer du texte dans la feuille de calcul.
`deleteActiveSheet()`	`Sheet`	Supprime la feuille active.
`deleteColumn(columnPosition)`	`Sheet`	Supprime la colonne à la position donnée.
`deleteColumns(columnPosition, howMany)`	`void`	Supprime un certain nombre de colonnes à partir de la position de colonne donnée.
`deleteRow(rowPosition)`	`Sheet`	Supprime la ligne à la position donnée.
`deleteRows(rowPosition, howMany)`	`void`	Supprime un certain nombre de lignes à partir de la position de ligne donné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 tous les groupes de cette feuille de calcul.
`getBlob()`	`Blob`	Renvoyez les données de cet objet sous forme de blob.
`getColumnWidth(columnPosition)`	`Integer`	Récupère la largeur en pixels de la colonne donnée.
`getCurrentCell()`	`Range`	Renvoie la cellule active de la feuille active ou `null` si aucune cellule n'est active.
`getDataRange()`	`Range`	Renvoie un `Range` correspondant aux dimensions dans lesquelles les données sont présentes.
`getDataSourceFormulas()`	`DataSourceFormula[]`	Récupère toutes les formules de la source de données.
`getDataSourcePivotTables()`	`DataSourcePivotTable[]`	Récupère tous les tableaux croisés dynamiques de la source de données.
`getDataSourceRefreshSchedules()`	`DataSourceRefreshSchedule[]`	Récupère les calendriers 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[]`	Récupère la liste des éditeurs de cet objet `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'a pas de formulaire associé.
`getFrozenColumns()`	`Integer`	Affiche le nombre de colonnes figées.
`getFrozenRows()`	`Integer`	Renvoie le nombre de lignes figées.
`getId()`	`String`	Récupère 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 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[]`	Récupère 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ée par une liste non vide de notations A1 ou R1C1.
`getRecalculationInterval()`	`RecalculationInterval`	Renvoie l'intervalle de calcul de cette feuille de calcul.
`getRowHeight(rowPosition)`	`Integer`	Récupère la hauteur en pixels de la ligne donnée.
`getSelection()`	`Selection`	Renvoie l'`Selection` actuelle dans la feuille de calcul.
`getSheetByName(name)`	`Sheet`	Renvoie une feuille avec le nom donné.
`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 des valeurs pour cette plage à partir des coordonnées données.
`getSheets()`	`Sheet[]`	Récupère toutes les feuilles de cette feuille 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[]`	Récupère la liste des lecteurs et des commentateurs de cet `Spreadsheet`.
`hideColumn(column)`	`void`	Masque la ou les colonnes de la plage donnée.
`hideRow(row)`	`void`	Masque les lignes de la plage donnée.
`insertColumnAfter(afterPosition)`	`Sheet`	Insère une colonne après la position de colonne donnée.
`insertColumnBefore(beforePosition)`	`Sheet`	Insère une colonne avant la position de colonne donnée.
`insertColumnsAfter(afterPosition, howMany)`	`Sheet`	Insère un nombre donné de colonnes après la position de colonne donnée.
`insertColumnsBefore(beforePosition, howMany)`	`Sheet`	Insère un certain nombre de colonnes avant la position de colonne donnée.
`insertDataSourceSheet(spec)`	`DataSourceSheet`	Insère un nouvel élément `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 de pixel.
`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 de 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 donné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 nouvelle feuille dans la feuille de calcul à l'index donné.
`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, à l'aide d'un nom de feuille par défaut et d'arguments avancés facultatifs.
`insertSheet(sheetName)`	`Sheet`	Insère une nouvelle feuille dans la feuille de calcul avec le nom donné.
`insertSheet(sheetName, sheetIndex)`	`Sheet`	Insère une nouvelle feuille dans la feuille de calcul avec le nom donné à l'index donné.
`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 nouvelle feuille dans la feuille de calcul, crée une `DataSourceTable` couvrant l'ensemble de la feuille avec la spécification de la source de données donnée et lance l'exécution des données.
`isColumnHiddenByUser(columnPosition)`	`Boolean`	Indique si la colonne donné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 donné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 de l'`Spreadsheet`.
`removeEditor(user)`	`Spreadsheet`	Supprime l'utilisateur donné de la liste des éditeurs de l'`Spreadsheet`.
`removeMenu(name)`	`void`	Supprime un menu ajouté par `addMenu(name, subMenus)`.
`removeNamedRange(name)`	`void`	Supprime une plage nommée avec le nom donné.
`removeViewer(emailAddress)`	`Spreadsheet`	Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'`Spreadsheet`.
`removeViewer(user)`	`Spreadsheet`	Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'`Spreadsheet`.
`rename(newName)`	`void`	Renomme le document.
`renameActiveSheet(newName)`	`void`	Renomme la feuille active actuelle avec le nouveau nom donné.
`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 supérieure 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 de 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 donné.
`setFrozenRows(rows)`	`void`	Gèle le nombre de lignes donné.
`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`	Nommez 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 donné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 pour 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 le viewport 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 donné.
`toast(msg, title)`	`void`	Affiche une fenêtre pop-up en bas à droite de la feuille de calcul avec le message et le titre donnés.
`toast(msg, title, timeoutSeconds)`	`void`	Affiche une fenêtre pop-up dans le coin inférieur droit de la feuille de calcul avec le titre et le message donnés, qui reste visible pendant un certain temps.
`unhideColumn(column)`	`void`	Affiche la colonne dans la plage donnée.
`unhideRow(row)`	`void`	Affiche la ligne de 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 de la feuille de calcul soient terminées, et expire 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 de la feuille actuelle.
`isAnonymousView()`	`Boolean`	Indique si le document permet la visualisation anonyme.
`isAnonymousWrite()`	`Boolean`	Indique si le document autorise les modifications de la part d'utilisateurs anonymes.
`setAnonymousAccess(anonymousReadAllowed, anonymousWriteAllowed)`	`void`	Définit la stratégie du document concernant la lecture et l'écriture anonymes.
`setSheetProtection(permissions)`	`void`	Définit les autorisations pour la feuille 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 champs d'application suivants:

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

`addDeveloperMetadata(key, visibility)`

Ajoute les métadonnées de développement 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 champs d'application suivants:

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

`addDeveloperMetadata(key, value)`

Ajoute les métadonnées de développement 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 champs d'application 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éveloppement à 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 champs d'application suivants:

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

`addEditor(emailAddress)`

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

Paramètres

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

Renvois

Spreadsheet : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`addEditor(user)`

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

Paramètres

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

Renvois

Spreadsheet : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 l'Spreadsheet. Si l'un des utilisateurs figurait déjà dans la liste des spectateurs, cette méthode le fait sortir de la liste.

Paramètres

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

Renvois

Spreadsheet : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 devez l'appeler à partir de la fonction onOpen() pour 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() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  var 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 des paramètres `name` et `functionName`. Vous pouvez utiliser les 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 champs d'application suivants:

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

`addViewer(emailAddress)`

Ajoute l'utilisateur donné à la liste des spectateurs de l'Spreadsheet. Si l'utilisateur figurait 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 : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`addViewer(user)`

Ajoute l'utilisateur donné à la liste des spectateurs de l'Spreadsheet. Si l'utilisateur figurait 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 : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 l'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 d'adresses e-mail des utilisateurs à ajouter.

Renvois

Spreadsheet : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la 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 champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 donnée à redimensionner.

Renvois

Sheet : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`copy(name)`

Copier la feuille de calcul et renvoyer la nouvelle

// This code makes a copy of the current spreadsheet and names it appropriately
var 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 champs d'application 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, toutes les métadonnées associées à la feuille de calcul, aux feuilles, aux lignes et aux colonnes sont prises en compte.

// 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 permet de rechercher et de remplacer du texte dans la feuille de calcul. La recherche commence à partir de la première feuille de la feuille de calcul.

var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();

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

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

// Replaces the last found occurrence of 'dog' with 'cat' and returns the number
// of occurrences replaced.
var numOccurrencesReplaced = findOccurrence.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
var 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 champs d'application suivants:

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

`deleteColumn(columnPosition)`

Supprime la colonne à la position donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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, commençant par 1 pour la première colonne.

Renvois

Sheet : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application suivants:

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

`deleteRow(rowPosition)`

Supprime la ligne à la position donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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, commençant à 1 pour la première ligne.

Renvois

Sheet : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application 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.
var ss = SpreadsheetApp.getActive();
var 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 champs d'application 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 : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 en surbrillance actuelle.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var sheet = ss.getSheets()[0];
// Returns the active cell
var 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 champs d'application 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.

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

Renvois

Range : plage active

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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().

var sheet = SpreadsheetApp.getActiveSheet();
// Returns the list of active ranges.
var 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 champs d'application 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 s'affiche dans l'interface utilisateur de la feuille de calcul.

var 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, "monfichier.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 afficher les quotas quotidiens pour les conversions, consultez la section Quotas pour les services Google. Les nouveaux domaines Google Workspace 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 valeurs `'image/bmp'`, `'image/gif'`, `'image/jpeg'` ou `'image/png'` sont également valides. Pour un document Google Docs, `'text/markdown'` est également valide.

Renvois

Blob : données sous forme de blob.

`getBandings()`

Renvoie tous les groupes 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[] : bandes de cette feuille de calcul.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`getBlob()`

Renvoyez 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 donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application suivants:

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

`getCurrentCell()`

Renvoie la cellule active de la feuille active ou null si aucune cellule n'est active. La cellule active est celle qui est sélectionnée dans l'interface utilisateur de Google Sheets et est mise en surbrillance par une bordure sombre. Il n'y a jamais plus d'une cellule active. Lorsqu'un utilisateur sélectionne une ou plusieurs plages de cellules, l'une des cellules de la sélection est la cellule active.

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

Renvois

Range : cellule active

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 limitée par A1 et (Sheet.getLastColumn(), Sheet.getLastRow()).

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

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

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

Renvois

Range : plage composée de 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 champs d'application suivants:

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

`getDataSourceFormulas()`

Récupère toutes les formules de la 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 la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 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 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 la source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`getDataSourceRefreshSchedules()`

Récupère les calendriers 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[] : calendriers d'actualisation de cette feuille de calcul.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 champs d'application 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 champs d'application 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 champs d'application 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 champs d'application suivants:

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

`getEditors()`

Récupère la liste des éditeurs de cet objet Spreadsheet.

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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'a pas de formulaire associé. 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().

// 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 champs d'application suivants:

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

`getFrozenColumns()`

Affiche le nombre de colonnes figées.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application suivants:

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

`getFrozenRows()`

Renvoie le nombre de lignes figées.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application suivants:

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

`getId()`

Récupère un identifiant unique pour cette feuille de calcul. Vous pouvez extraire l'ID d'une feuille de calcul à partir 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 (ou clé) unique 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[] : tableau d'images superposées.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 des calculs successifs diffèrent de moins de 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 champs d'application 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.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var 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 champs d'application 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.

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

// This logs the value in the very last cell of this sheet
var lastRow = sheet.getLastRow();
var lastColumn = sheet.getLastColumn();
var 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 champs d'application 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 champs d'application suivants:

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

`getName()`

Récupère le nom du document.

var 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 champs d'application 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.
var namedRanges = SpreadsheetApp.getActiveSpreadsheet().getNamedRanges();
for (var 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 champs d'application suivants:

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

`getNumSheets()`

Renvoie le nombre de feuilles de 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é.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application 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.
var 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 champs d'application suivants:

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

`getProtections(type)`

Récupère 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.
var ss = SpreadsheetApp.getActive();
var protections = ss.getProtections(SpreadsheetApp.ProtectionType.RANGE);
for (var i = 0; i < protections.length; i++) {
  var protection = protections[i];
  if (protection.canEdit()) {
    protection.remove();
  }
}

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

Paramètres

Nom	Type	Description
`type`	`ProtectionType`	Type d'espace protégé, `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 champs d'application 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"
var ss = SpreadsheetApp.getActiveSpreadsheet();
var range = ss.getRange("Invoices!A1:D4");

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

Paramètres

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

Renvois

Range : plage à l'emplacement désigné

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.
var 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 donné.

`getRangeList(a1Notations)`

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

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

Paramètres

Nom	Type	Description
`a1Notations`	`String[]`	Liste des plages à renvoyer, comme spécifié dans la 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 champs d'application suivants:

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

`getRecalculationInterval()`

Renvoie l'intervalle de calcul 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');

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

Renvois

RecalculationInterval : intervalle de calcul de cette feuille de calcul.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application suivants:

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

`getSelection()`

Renvoie l'Selection actuelle dans la feuille de calcul.

var selection = SpreadsheetApp.getActiveSpreadsheet().getSelection();
var 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 champs d'application suivants:

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

`getSheetByName(name)`

Renvoie une feuille avec le nom donné.

Si plusieurs feuilles portent le même nom, la feuille la plus à gauche est renvoyée. Renvoie null si aucune feuille ne porte le nom donné.

// The code below logs the index of a sheet named "Expenses"
var 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 : la feuille portant le nom donné.

`getSheetId()`

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

Il s'agit d'un identifiant unique de la feuille de calcul. L'ID est un entier croissant attribué au moment de la création de la feuille, et qui est indépendant de sa position. Cela est utile 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.

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

Logger.log(sheet.getSheetId());

Renvois

Integer : identifiant unique de la feuille de calcul

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`getSheetName()`

Renvoie le nom de la feuille.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application suivants:

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

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

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

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

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

var 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 des valeurs doivent être renvoyées.
`numColumns`	`Integer`	Nombre de colonnes pour lesquelles des valeurs doivent être renvoyées.

Renvois

Object[][] : tableau bidimensionnel de valeurs

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`getSheets()`

Récupère toutes les feuilles de cette feuille de calcul.

// The code below logs the name of the second sheet
var sheets = SpreadsheetApp.getActiveSpreadsheet().getSheets();
if (sheets.length > 1) {
  Logger.log(sheets[1].getName());
}

Renvois

Sheet[] : tableau de toutes les feuilles de la feuille de calcul.

`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 champs d'application 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.
var currentTheme = SpreadsheetApp.getActiveSpreadsheet().getSpreadsheetTheme();

Renvois

SpreadsheetTheme : thème appliqué actuellement.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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, "Amérique/New_York", comme indiqué sur Joda.org).

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

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

Renvois

String : URL de la feuille de calcul donnée.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`getViewers()`

Récupère la liste des lecteurs et des commentateurs de cet Spreadsheet.

Renvois

User[] : tableau d'utilisateurs autorisés à afficher ou à commenter.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`hideColumn(column)`

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

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

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

// This hides the first 3 columns
let 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 champs d'application suivants:

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

`hideRow(row)`

Masque les lignes de la plage donnée.

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

// This hides the first row
var 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 champs d'application 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 donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 donnée.

let ss = SpreadsheetApp.getActiveSpreadsheet();
let 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 : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`insertDataSourceSheet(spec)`

Insère un nouvel élément DataSourceSheet dans la feuille de calcul et lance l'exécution des données. En conséquence, 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 : nouvelle feuille de source de données.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 récupérée à partir du contenu du blob. La taille maximale autorisée pour les blobs est de 2 Mo.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1);

Paramètres

Nom	Type	Description
`blobSource`	`BlobSource`	Blob contenant le contenu de l'image, le type MIME et (facultatif) le nom.
`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 champs d'application 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 de pixel. 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.

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

var blob = Utilities.newBlob(binaryData, 'image/png', 'MyImageName');
sheet.insertImage(blob, 1, 1, 10, 10);

Paramètres

Nom	Type	Description
`blobSource`	`BlobSource`	Blob contenant le contenu de l'image, le type MIME et (facultatif) le nom.
`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 champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 de la grille.
`row`	`Integer`	Position de la ligne de 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 champs d'application 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 de pixels.

L'URL fournie doit être accessible au public.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 donnée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

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

Renvois

Sheet : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`insertSheet(sheetIndex)`

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

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

Paramètres

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

Renvois

Sheet : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

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

Paramètres

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

Paramètres avancés

Nom	Type	Description
`template`	`Sheet`	Toutes les données de l'objet de feuille de 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 : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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, à l'aide d'un nom de feuille par défaut et d'arguments avancés facultatifs. La nouvelle feuille devient la feuille active.

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

Paramètres

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

Paramètres avancés

Nom	Type	Description
`template`	`Sheet`	Toutes les données de l'objet de feuille de 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 : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 donné. La nouvelle feuille devient la feuille active.

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

Paramètres

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

Renvois

Sheet : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`insertSheet(sheetName, sheetIndex)`

Insère une nouvelle feuille dans la feuille de calcul avec le nom donné à l'index donné. La nouvelle feuille devient la feuille active.

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

Paramètres

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

Renvois

Sheet : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 nouvellement insérée. Pour insérer une feuille en tant que première dans une feuille de calcul, définissez-la sur 0.
`options`	`Object`	Arguments JavaScript avancés facultatifs.

Paramètres avancés

Nom	Type	Description
`template`	`Sheet`	Toutes les données de l'objet de feuille de 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 : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 JavaScript avancés facultatifs.

Paramètres avancés

Nom	Type	Description
`template`	`Sheet`	Toutes les données de l'objet de feuille de 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 : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`insertSheetWithDataSourceTable(spec)`

Insère une nouvelle feuille dans la feuille de calcul, crée une DataSourceTable couvrant l'ensemble de la feuille avec la spécification de la source de données donnée et lance l'exécution des données. En conséquence, 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 : nouvelle feuille.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`isColumnHiddenByUser(columnPosition)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application 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 champs d'application 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).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application suivants:

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

`moveActiveSheet(pos)`

Déplace la feuille active à la position donné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.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
// Gets the "first" sheet and activates it.
var 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 de l'index 1 vers 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 champs d'application 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 en créer une autre.

var sheet = SpreadsheetApp.getActiveSheet();
var chart = sheet.newChart().setPosition(1, 1, 0, 0).build();
sheet.insertChart(chart);
var 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 champs d'application 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 champs d'application 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 de l'Spreadsheet. Cette méthode n'empêche pas les utilisateurs d'accéder à l'Spreadsheet s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si l'Spreadsheet est partagé avec l'ensemble du domaine de l'utilisateur ou si l'Spreadsheet se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

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

Paramètres

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

Renvois

Spreadsheet : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`removeEditor(user)`

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

Paramètres

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

Renvois

Spreadsheet : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`removeMenu(name)`

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

// The onOpen function is executed automatically every time a Spreadsheet is loaded
function onOpen() {
  var ss = SpreadsheetApp.getActiveSpreadsheet();
  ss.addMenu("badMenu", [{name: "remove bad menu", functionName: "removeBadMenu"},
                                       {name: "foo", functionName: "foo"}]);
}
function removeBadMenu() {
  var 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 champs d'application 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.
var 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 champs d'application suivants:

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

`removeViewer(emailAddress)`

Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'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 à l'Spreadsheet s'ils appartiennent à une classe d'utilisateurs disposant d'un accès général. Par exemple, si l'Spreadsheet est partagé avec l'ensemble du domaine de l'utilisateur ou si l'Spreadsheet se trouve dans un Drive partagé auquel l'utilisateur peut accéder.

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

Paramètres

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

Renvois

Spreadsheet : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`removeViewer(user)`

Supprime l'utilisateur donné de la liste des spectateurs et des commentateurs de l'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, l'utilisateur est également supprimé de la liste des éditeurs.

Paramètres

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

Renvois

Spreadsheet : Spreadsheet pour le chaînage.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`rename(newName)`

Renomme le document.

var 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 champs d'application 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 donné.

// 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 champs d'application 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 champs d'application 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 supérieure gauche de la plage comme current cell.

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

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

Paramètres

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

Renvois

Range : plage nouvellement active

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

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

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

Paramètres

Nom	Type	Description
`rangeList`	`RangeList`	Liste des plages à sélectionner.

Renvois

RangeList : nouvelle liste de plages sélectionnées

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

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

var range = sheet.getRange("A1:D4");
sheet.setActiveSelection(range);

Paramètres

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

Renvois

Range : plage nouvellement active

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.

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

sheet.setActiveSelection("A1:D4");

Paramètres

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

Renvois

Range : plage nouvellement active

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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.
var spreadsheet = SpreadsheetApp.getActiveSpreadsheet();
spreadsheet.setActiveSheet(spreadsheet.getSheets()[0]);

Paramètres

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

Renvois

Sheet : feuille active.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 de la feuille de calcul, avec une option permettant de restaurer la sélection la plus récente dans cette feuille. L'interface utilisateur de Google Sheets affiche la feuille choisie, sauf si elle appartient à une autre feuille de calcul.

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

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

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

Paramètres

Nom	Type	Description
`sheet`	`Sheet`	Nouvelle feuille active.
`restoreSelection`	`Boolean`	Si `true`, la sélection la plus récente de la nouvelle feuille active est de nouveau sélectionnée lorsque la nouvelle feuille devient active. Si `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 champs d'application 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.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 donnée à définir.
`width`	`Integer`	Largeur, en pixels, à définir.

Renvois

Sheet : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 est présente dans une plage déjà sélectionnée, cette plage devient la plage active, et la cellule est la cellule active.

Si la cellule spécifiée ne figure dans aucune plage sélectionnée, toute sélection existante est supprimée, et la cellule devient la cellule active et la plage active.

Remarque:L'Range spécifié doit être constitué d'une seule cellule, sinon une exception est générée.

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

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

Paramètres

Nom	Type	Description
`cell`	`Range`	Cellule à définir comme cellule active.

Renvois

Range : nouvelle cellule active définie

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`setFrozenColumns(columns)`

Fige le nombre de colonnes donné. Si la valeur est nulle, aucune colonne n'est figée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application suivants:

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

`setFrozenRows(rows)`

Gèle le nombre de lignes donné. Si la valeur est nulle, aucune ligne n'est figée.

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 champs d'application 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 des calculs successifs diffèrent de moins de cette valeur, le calcul itératif s'arrête. Cette valeur doit être non négative et la valeur par défaut est 0, 05.

// 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 positif).

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 champs d'application 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 précédemment lorsque le calcul est activé, ils sont définis par défaut sur 50 et 0,05, respectivement. Si l'un d'eux a déjà été défini, il conserve sa valeur précédente.

// 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 champs d'application 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 champs d'application suivants:

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

`setNamedRange(name, range)`

Nommez une plage.

// The code below creates a new named range "TaxRates" in the active spreadsheet
var 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 champs d'application 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 champs d'application suivants:

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

`setRowHeight(rowPosition, height)`

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

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 : la 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 champs d'application 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 de 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 champs d'application suivants:

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

`setSpreadsheetTheme(theme)`

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

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

Paramètres

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

Renvois

SpreadsheetTheme : nouveau thème actuel.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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", comme indiqué sur Joda.org).

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 le viewport 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 vers le script côté serveur.

Si le script côté serveur a déjà affiché une boîte de dialogue qui n'a pas encore été fermée, la boîte de dialogue existante est remplacée par l'interface utilisateur de la boîte de dialogue nouvellement 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:

var 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`	Un `HtmlOutput`.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`sort(columnPosition)`

Trie une feuille par colonne, par ordre croissant.

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

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

Paramètres

Nom	Type	Description
`columnPosition`	`Integer`	Colonne à utiliser pour le tri.

Renvois

Sheet : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 un ordre croissant ou décroissant.

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

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

Paramètres

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

Renvois

Sheet : la feuille, utile pour le chaînage de méthodes

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 donné.

// 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 champs d'application 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 donné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 de la notification.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application suivants:

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

`toast(msg, title, timeoutSeconds)`

Affiche une fenêtre pop-up dans le coin inférieur droit de la feuille de calcul avec le titre et le message donnés, qui reste visible pendant un certain temps.

// 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 de la notification.
`timeoutSeconds`	`Number`	Délai avant expiration en secondes. Si la valeur est `null`, la valeur par défaut du toast est de 5 secondes. 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 champs d'application suivants:

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

`unhideColumn(column)`

Affiche la colonne dans la plage donnée.

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

// This unhides the first column if it was previously hidden
var 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 champs d'application suivants:

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

`unhideRow(row)`

Affiche la ligne de la plage donnée.

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

// This unhides the first row if it was previously hidden
var 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 champs d'application 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).

var ss = SpreadsheetApp.getActiveSpreadsheet();
var 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 des paramètres `name` et `functionName`. Vous pouvez utiliser les 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 champs d'application suivants:

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

`waitForAllDataExecutionsCompletion(timeoutInSeconds)`

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

Paramètres

Nom	Type	Description
`timeoutInSeconds`	`Integer`	Durée d'attente pour l'exécution des 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 champs d'application 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 de la feuille actuelle.

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

var 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.
var 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 champs d'application 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 plus disponible dans la nouvelle version de Google Sheets.

Indique si le document permet la visualisation anonyme. 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var 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 champs d'application 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 plus disponible dans la nouvelle version de Google Sheets.

Indique si le document autorise les modifications de la part d'utilisateurs anonymes. 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.
var ss = SpreadsheetApp.getActiveSpreadsheet();
var file = DriveApp.getFileById(ss.getId());
var access = file.getSharingAccess();
var permission = file.getSharingPermission();
var isAnonymousAccess =
    access == DriveApp.Access.ANYONE || access == DriveApp.Access.ANYONE_WITH_LINK;
var isAnonymousEdit = isAnonymousAccess && permission == DriveApp.Permission.EDIT;

Renvois

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

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 plus disponible dans la nouvelle version de Google Sheets.

Définit la stratégie du document concernant la lecture et l'écriture anonymes. Cette fonctionnalité n'est plus disponible dans la nouvelle version de Google Sheets. Utilisez plutôt File.setSharing(accessType, permissionType).

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

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

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

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

Paramètres

Nom	Type	Description
`anonymousReadAllowed`	`Boolean`	`true` pour autoriser les lectures anonymes, `false` dans le cas contraire.
`anonymousWriteAllowed`	`Boolean`	`true` pour autoriser les lectures anonymes, `false` dans le cas contraire.

Autorisation

Les scripts qui utilisent cette méthode nécessitent une autorisation avec un ou plusieurs des champs d'application 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 actuelle.

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

var permissions = sheet.getSheetProtection();

// This copies the permissions on the first sheet to the second sheet
var 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 champs d'application suivants:

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