Opérations Sheets

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

Ces exemples sont présentés sous la forme de requêtes HTTP et neutres. Pour découvrir comment implémenter une mise à jour par lot dans différents langages à l'aide de les bibliothèques clientes de l'API Google, consultez la section Mettre à jour feuilles de calcul.

Dans ces exemples, les espaces réservés SPREADSHEET_ID et SHEET_ID indique où vous devez fournir ces identifiants. Vous pouvez accéder à la feuille de calcul ID dans l'URL de la feuille de calcul. Vous pouvez obtenir l'ID de la feuille de calcul à l'aide de l'élément spreadsheets.get. La sont spécifiées au format A1. Une exemple de plage est Feuille1!A1:D5.

Ajouter une feuille

Les éléments suivants : spreadsheets.batchUpdate exemple de code montre comment utiliser AddSheetRequest pour ajouter une feuille à une feuille de calcul, tout en définissant le titre, la taille de la grille et 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 (comme 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 une feuille de toutes les valeurs tout en conservant les formats

Les éléments suivants : spreadsheets.batchUpdate exemple de code montre comment utiliser UpdateCellsRequest pour supprimer toutes les valeurs d'une feuille sans modifier la mise en forme.

Spécifier le Champ userEnteredValue sans valeur correspondante est interprétée comme une instruction permettant d'effacer les valeurs dans la plage. Ce paramètre peut également être utilisé avec d'autres champs. Par exemple : remplacer la valeur fields par userEnteredFormat supprime toutes les mises en forme compatibles avec l'API Sheets de la feuille, mais les valeurs des cellules ne sont pas modifié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 dans une autre

Les éléments suivants : spreadsheet.sheets.copyTo exemple de code montre comment copier une seule feuille spécifiée par SHEET_ID d'une feuille de calcul à une autre feuille de calcul.

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

La réponse se compose d'un SheetProperties 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

Les éléments suivants : spreadsheets.batchUpdate exemple de code montre comment utiliser 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 de la feuille

Les éléments suivants : Exemple de code spreadsheets.get montre comment obtenir les informations sur une propriété sheet. à partir d'une feuille de calcul spécifiée par SHEET_ID et SPREADSHEET_ID. Cette méthode est souvent utilisée pour déterminer des métadonnées de feuilles dans une feuille de calcul spécifique, de sorte que d'autres opérations puissent cibler ces feuilles. Le paramètre de requête fields spécifie uniquement une propriété de feuille. des données doivent être renvoyées (par opposition aux données de valeur des cellules ou aux données liées au l'intégralité d'une feuille de calcul).

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

La réponse se compose d'un Spreadsheet ressource, qui contient Objet Sheet avec 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
        }
      },
      ...
  ],
}