Mettre à jour les feuilles de calcul (original) (raw)

En plus des données de valeur contenues dans ses cellules, une feuille de calcul inclut de nombreux autres types de données, tels que :

Voici quelques-uns des nombreux types de données qui contrôlent l'apparence et le fonctionnement d'une feuille de calcul. La méthode spreadsheets.batchUpdate vous permet de mettre à jour l'un de ces détails de la feuille de calcul. Les modifications sont regroupées dans un lot. Ainsi, si une requête échoue, aucune des autres modifications (potentiellement dépendantes) n'est écrite.

Cette page décrit les principes de base de l'utilisation de la méthode spreadsheets.batchUpdate. Si vous devez lire et écrire des données de valeurs de cellules, vous pouvez également utiliser la ressource spreadsheets.values décrite dans Lire et écrire des valeurs de cellules.

Catégories d'opérations

Les opérations spécifiques prises en charge par spreadsheets.batchUpdate peuvent être regroupées dans les grandes catégories suivantes :

Catégorie Description
Ajouter (et Dupliquer) Ajoutez de nouveaux objets (parfois basés sur d'anciens, comme dans les requêtes de duplication).
Mettre à jour (et Définir) Mettez à jour certaines propriétés d'un objet, en laissant généralement les anciennes propriétés intactes (alors qu'une requête Set écrase les données précédentes).
Supprimer Supprimer des objets.

Ces catégories sont utilisées dans la section suivante pour décrire le comportement d'opérations spécifiques.

Opérations de mise à jour par lot

La méthode spreadsheets.batchUpdate fonctionne en prenant un ou plusieurs objets Request, chacun spécifiant un seul type de requête à effectuer. Il existe de nombreux types de demandes. Vous trouverez ci-dessous une répartition des types de demandes, regroupées en différentes catégories.

Objet AJOUTER / DUPLIQUER UPDATE / SET SUPPRIMER
Propriétés de la feuille de calcul UpdateSpreadsheetPropertiesRequest
Sheets AddSheetRequest DuplicateSheetRequest UpdateSheetPropertiesRequest DeleteSheetRequest
Dimensions (y compris la plage de dimensions) InsertDimensionRequest AppendDimensionRequest UpdateDimensionPropertiesRequest MoveDimensionRequest AutoResizeDimensionsRequest DeleteDimensionRequest
Cellules (y compris les valeurs, les formats, la validation des données, etc.) RepeatCellRequest UpdateCellsRequest AppendCellsRequest
Plages nommées AddNamedRangeRequest UpdateNamedRangeRequest DeleteNamedRangeRequest
Bordures UpdateBordersRequest
Filtres (y compris les vues filtrées et le filtre de base) AddFilterViewRequest DuplicateFilterViewRequest UpdateFilterViewRequest SetBasicFilterRequest ClearBasicFilterRequest
Validation des données SetDataValidationRequest
Règles de mise en forme conditionnelle AddConditionalFormatRuleRequest UpdateConditionalFormatRuleRequest DeleteConditionalFormatRuleRequest
Plages protégées AddProtectedRangeRequest UpdateProtectedRangeRequest DeleteProtectedRangeRequest
Objets intégrés (y compris les graphiques) AddChartRequest UpdateChartSpecRequest UpdateEmbeddedObjectPositionRequest DeleteEmbeddedObjectRequest
Fusions MergeCellsRequest UnmergeCellsRequest

Il existe également des requêtes supplémentaires qui imitent les actions des utilisateurs pour manipuler les données :

Limites

Pour en savoir plus sur les limites de cellules et de lignes dans Google Sheets, consultez Fichiers pouvant être stockés dans Google Drive.

Masques de champ

De nombreuses requêtes de mise à jour nécessitent des masques de champ. Il s'agit d'une liste de champs séparés par une virgule permettant de ne mettre à jour que certains champs d'un objet en laissant les autres champs inchangés. Un masque de champ * est traité comme un caractère générique et est une abréviation pour spécifier chaque champ d'un message (ce qui signifie qu'un champ peut revenir à son état par défaut si vous ne spécifiez pas de valeur pour celui-ci dans la requête). Pour en savoir plus sur les masques de champ, consultez Utiliser des masques de champ.

L'exemple suivant utilise UpdateSpreadsheetPropertiesRequest pour mettre à jour uniquement le titre d'une feuille de calcul :

Requête :

POST .../v4/spreadsheets/spreadsheetId:batchUpdate

Corps de la requête :

{
  "requests": [{
      "updateSpreadsheetProperties": {
          "properties": {"title": "TITLE"},
          "fields": "title"
      }
  }]
}

Remplacez TITLE par le nouveau titre de la feuille de calcul.

Réponses

Lorsque vous mettez à jour une feuille de calcul, certains types de requêtes peuvent renvoyer des réponses. Elles sont renvoyées dans un tableau, chaque réponse occupant le même index que la requête correspondante. Certaines requêtes n'ont pas de réponse, et la réponse est vide pour celles-ci.

En général, les réponses aux requêtes "add" renvoient des informations telles que l'ID de l'objet ajouté. Pour obtenir la liste des réponses acceptées, consultez Réponses.

Exemple

L'exemple de code suivant effectue les actions suivantes :

  1. Met à jour le titre de la feuille de calcul à l'aide de la variable title.
  2. Recherche et remplace les valeurs de cellule dans la feuille de calcul à l'aide des variables find et replacement.

Apps Script

Java

JavaScript

Node.js

PHP

Python

Ruby