Résumer les données de plusieurs feuilles

Niveau de programmation : débutant
Durée : 5 minutes
Type de projet : Fonction personnalisée

Objectifs

• Comprendre ce que fait la solution
• Comprendre le rôle des services Apps Script dans la solution
• Configurez le script.
• Exécutez le script.

À propos de cette solution

Si vous disposez de données structurées de façon similaire sur plusieurs feuilles d'une même feuille de calcul, comme des métriques de service client pour les membres d'une équipe, vous pouvez utiliser cette fonction personnalisée pour résumer chaque feuille. Cette solution se concentre sur les demandes d'assistance client, mais vous pouvez la façonner selon vos besoins.

Fonctionnement

La fonction personnalisée, appelée getSheetsData(), résume les données de chaque feuille du tableur en fonction de la colonne État de la feuille. Le script ignore les feuilles qui ne doivent pas être incluses dans l'agrégation, telles que les feuilles ReadMe et Summary.

Services Apps Script

Cette solution utilise le service suivant :

• Service de feuille de calcul : récupère les feuilles à résumer et compte le nombre d'éléments correspondant à une chaîne spécifiée. Le script ajoute ensuite les informations calculées à une plage relative à l'endroit où la fonction personnalisée a été appelée dans la feuille de calcul.

Prérequis

Pour utiliser cet exemple, vous devez remplir les conditions préalables suivantes :

• Un compte Google (l'approbation de l'administrateur peut être nécessaire pour les comptes Google Workspace).
• Un navigateur Web avec accès à Internet.

Configurer le script

Cliquez sur le bouton ci-dessous pour copier la feuille de calcul de la fonction personnalisée "Synthétiser les données de feuille de calcul". Le projet Apps Script pour cette solution est joint à la feuille de calcul.
Créer une copie

Exécuter le script

1. Dans la feuille de calcul que vous avez copiée, accédez à la feuille Récapitulatif.
2. Cliquez sur la cellule A4. La fonction getSheetsData() se trouve dans cette cellule.
3. Accédez à l'une des feuilles du propriétaire et mettez à jour ou ajoutez des données à la feuille. Voici quelques actions que vous pouvez essayer :
   • Ajoutez une ligne avec des informations sur un exemple de ticket.
   • Dans la colonne État, modifiez l'état d'une demande d'assistance existante.
   • Modifiez la position de la colonne État. Par exemple, dans la feuille Propriétaire1, déplacez la colonne État de la colonne C vers la colonne D.
4. Accédez à la feuille Récapitulatif et examinez le tableau récapitulatif mis à jour que getSheetsData() a créé à partir de la cellule A4. Vous devrez peut-être cocher la case de la ligne 10 pour actualiser les résultats mis en cache de la fonction personnalisée. Google met en cache les fonctions personnalisées pour optimiser les performances.
   • Si vous avez ajouté ou modifié des lignes, le script met à jour le nombre de tickets et d'états.
   • Si vous avez déplacé la colonne État, le script fonctionne toujours comme prévu avec le nouvel index de colonne.

Examiner le code

Pour consulter le code Apps Script de cette solution, cliquez sur Afficher le code source ci-dessous :

Afficher le code source

Code.gs

solutions/custom-functions/summarize-sheets-data/Code.js

Afficher sur GitHub

// To learn how to use this script, refer to the documentation:
// https://developers.google.com/apps-script/samples/custom-functions/summarize-sheets-data

/*
Copyright 2022 Google LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

/**
 * Gets summary data from other sheets. The sheets you want to summarize must have columns with headers that match the names of the columns this function summarizes data from.
 * 
 * @return {string} Summary data from other sheets.
 * @customfunction
 */

// The following sheets are ignored. Add additional constants for other sheets that should be ignored.
const READ_ME_SHEET_NAME = "ReadMe";
const PM_SHEET_NAME = "Summary";

/**
 * Reads data ranges for each sheet. Filters and counts based on 'Status' columns. To improve performance, the script uses arrays 
 * until all summary data is gathered. Then the script writes the summary array starting at the cell of the custom function.
 */
function getSheetsData() {
  let ss = SpreadsheetApp.getActiveSpreadsheet();
  let sheets = ss.getSheets();
  let outputArr = [];

  // For each sheet, summarizes the data and pushes to a temporary array.
  for (let s in sheets) {
    // Gets sheet name.
    let sheetNm = sheets[s].getName();
    // Skips ReadMe and Summary sheets.
    if (sheetNm === READ_ME_SHEET_NAME || sheetNm === PM_SHEET_NAME) { continue; }
    // Gets sheets data.
    let values = sheets[s].getDataRange().getValues();
    // Gets the first row of the sheet which is the header row.
    let headerRowValues = values[0];
    // Finds the columns with the heading names 'Owner Name' and 'Status' and gets the index value of each.
    // Using 'indexOf()' to get the position of each column prevents the script from breaking if the columns change positions in a sheet.
    let columnOwner = headerRowValues.indexOf("Owner Name");
    let columnStatus = headerRowValues.indexOf("Status");
    // Removes header row.
    values.splice(0,1);
    // Gets the 'Owner Name' column value by retrieving the first data row in the array.
    let owner = values[0][columnOwner];
    // Counts the total number of tasks.
    let taskCnt = values.length;
    // Counts the number of tasks that have the 'Complete' status.
    // If the options you want to count in your spreadsheet differ, update the strings below to match the text of each option.
    // To add more options, copy the line below and update the string to the new text.
    let completeCnt = filterByPosition(values,'Complete', columnStatus).length;
    // Counts the number of tasks that have the 'In-Progress' status.
    let inProgressCnt = filterByPosition(values,'In-Progress', columnStatus).length;
    // Counts the number of tasks that have the 'Scheduled' status.
    let scheduledCnt = filterByPosition(values,'Scheduled', columnStatus).length;
    // Counts the number of tasks that have the 'Overdue' status.
    let overdueCnt = filterByPosition(values,'Overdue', columnStatus).length;
    // Builds the output array.
    outputArr.push([owner,taskCnt,completeCnt,inProgressCnt,scheduledCnt,overdueCnt,sheetNm]);
  }
  // Writes the output array.
  return outputArr;
}

/**
 * Below is a helper function that filters a 2-dimenstional array.
 */
function filterByPosition(array, find, position) {
  return array.filter(innerArray => innerArray[position] === find);
}

Modifications

Vous pouvez modifier la fonction personnalisée autant que vous le souhaitez pour l'adapter à vos besoins. Vous trouverez ci-dessous un ajout facultatif permettant d'actualiser manuellement les résultats des fonctions personnalisées.

Actualiser les résultats mis en cache

Contrairement aux fonctions intégrées, Google met en cache les fonctions personnalisées pour optimiser les performances. Cela signifie que si vous modifiez un élément dans votre fonction personnalisée, comme une valeur calculée, la mise à jour ne sera peut-être pas forcée immédiatement. Pour actualiser manuellement le résultat de la fonction, procédez comme suit :

1. Ajoutez une case à cocher à une cellule vide en cliquant sur Insérer > Case à cocher.
2. Ajoutez la cellule contenant la case à cocher en tant que paramètre de la fonction personnalisée, par exemple getSheetsData(B11).
3. Cochez ou décochez la case pour actualiser les résultats de la fonction personnalisée.

Contributeurs

Cet exemple est géré par Google avec l'aide des Google Developer Experts.

Étapes suivantes

• Fonctions personnalisées dans Google Sheets
• Étendre Google Sheets