Accéder à une feuille selon son GID avec Apps Script

Le GID dans une URL permet de préciser la feuille à afficher à l'ouverture.

Par exemple, en précisant le GID dans l'URL de ce document, c'est la troisième feuille qui est affichée à l'ouverture :

https://docs.google.com/spreadsheets/d/1XspFDspoZwJGHuoc5zbnmhV_1ZxX6162Qmmzs7dXoOc/edit#gid=1587721123

Apps Script

Il est parfois utile de pouvoir accéder à une feuille en fonction de son GID avec Apps Script.

Dans ce cas, commencez par copier la fonction getSheetByGID mise à disposition ici :

function getSheetByGID(spreadsheet, gid) {
  // Source : https://www.sheets-pratique.com/fr/codes/feuille-selon-gid
  return spreadsheet.getSheets().reduce((a, v) => !a && v.getSheetId() === Number(gid) ? v : a, 0);
}

Et voici maintenant un exemple d'utilisation de cette fonction qui vous permet de récupérer la troisième feuille du document cité en début de page :

function test() {

  // Document d'exemple
  const ss = SpreadsheetApp.openById('1XspFDspoZwJGHuoc5zbnmhV_1ZxX6162Qmmzs7dXoOc');

  // Récupération de la feuille 3 à l'aide de la fonction getSheetByGID
  const feuille3 = getSheetByGID(ss, 1587721123);

  // Vérification
  console.log(feuille3.getName()); // Affiche "Example 3"
}