Opérations Sheets

L'API Google Sheets vous permet de créer, d'effacer, de copier et de supprimer des feuilles, ainsi que de contrôler leurs propriétés. Les exemples de cette page illustrent comment effectuer certaines opérations courantes dans Sheets avec l'API Sheets.

Ces exemples sont présentés sous la forme de requêtes HTTP pour être indépendants du langage. Pour découvrir comment implémenter une mise à jour groupée dans différents langages à l'aide des bibliothèques clientes de l'API Google, consultez Mettre à jour des feuilles de calcul.

Dans ces exemples, les espaces réservés SPREADSHEET_ID et SHEET_ID indiquent où vous devez fournir ces ID. Vous trouverez l'ID de la feuille de calcul dans l'URL de la feuille de calcul. Vous pouvez obtenir l'ID de la feuille à l'aide de la spreadsheets.get méthode. Les plages sont spécifiées à l'aide de la notation A1. Par exemple, Sheet1!A1:D5.

Ajouter une feuille

L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser AddSheetRequest pour ajouter une feuille à une feuille de calcul, tout en définissant le titre, la taille de la grille et la couleur de l'onglet.

La réponse se compose d'un AddSheetResponse, qui contient un objet avec les propriétés de la feuille créée (telles que son SHEET_ID).

Le protocole de requête est présenté ci-dessous.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "addSheet": {
        "properties": {
          "title": "Deposits",
          "gridProperties": {
            "rowCount": 20,
            "columnCount": 12
          },
          "tabColor": {
            "red": 1.0,
            "green": 0.3,
            "blue": 0.4
          }
        }
      }
    }
  ]
}

Effacer toutes les valeurs d'une feuille tout en conservant les formats

L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser UpdateCellsRequest pour supprimer toutes les valeurs d'une feuille sans modifier la mise en forme.

La spécification du userEnteredValue champ sans valeur correspondante est interprétée comme une instruction visant à effacer les valeurs de la plage. Ce paramètre peut également être utilisé avec d'autres champs. Par exemple, si vous remplacez la valeur fields par userEnteredFormat, vous supprimez toute la mise en forme compatible avec l'API Sheets de la feuille, mais vous laissez les valeurs des cellules inchangées.

Le protocole de requête est présenté ci-dessous.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "updateCells": {
        "range": {
          "sheetId": SHEET_ID
        },
        "fields": "userEnteredValue"
      }
    }
  ]
}

Copier une feuille d'une feuille de calcul à une autre

L'exemple de code spreadsheet.sheets.copyTo suivant montre comment copier une seule feuille spécifiée par SHEET_ID d'une feuille de calcul à une autre.

La variable TARGET_SPREADSHEET_ID dans le corps de la requête spécifie la feuille de calcul de destination. La copie conserve toutes les valeurs, la mise en forme, les formules et les autres propriétés de l'original. Le titre de la feuille copiée est défini sur "Copie de [titre de la feuille d'origine]".

La réponse se compose d'un SheetProperties objet décrivant les propriétés de la feuille créée.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID/sheets/SHEET_ID:copyTo

{
  "destinationSpreadsheetId": "TARGET_SPREADSHEET_ID"
}

Supprimer une feuille

L'exemple de code spreadsheets.batchUpdate suivant montre comment utiliser les DeleteSheetRequest pour supprimer une feuille spécifiée par SHEET_ID.

Le protocole de requête est présenté ci-dessous.

POST https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID:batchUpdate

{
  "requests": [
    {
      "deleteSheet": {
        "sheetId": SHEET_ID
      }
    }
  ]
}

Lire les données d'une feuille

L'exemple de code suivant montre comment obtenir des informations sur les propriétés d'une feuille à partir d'une feuille de calcul, spécifiées par et.spreadsheets.getSHEET_IDSPREADSHEET_ID Cette méthode est souvent utilisée pour déterminer les métadonnées des feuilles d'une feuille de calcul spécifique, afin que des opérations supplémentaires puissent cibler ces feuilles. Le paramètre de requête fields spécifie que seules les données de propriété de la feuille doivent être renvoyées (par opposition aux données de valeur de cellule ou aux données liées à l'ensemble de la feuille de calcul).

GET https://sheets.googleapis.com/v4/spreadsheets/SPREADSHEET_ID?&fields=sheets.properties

La réponse se compose d'une Spreadsheet ressource, qui contient un Sheet objet avec des SheetProperties éléments. Si un champ de réponse donné est défini sur la valeur par défaut, il est omis de la réponse.

{
  "sheets": [
    {
      "properties": {
        "sheetId": SHEET_ID,
        "title": "Sheet1",
        "index": 0,
        "sheetType": "GRID",
        "gridProperties": {
          "rowCount": 100,
          "columnCount": 20,
          "frozenRowCount": 1
        }
        "tabColor": {
          "blue": 1.0
        }
      },
      ...
  ],
}