En plus des données de valeur contenues dans ses cellules, une feuille de calcul inclut de nombreux autres types de données, par exemple:
- Dimensions
- Mise en forme et bordures des cellules
- Plages nommées
- Plages protégées
- Mise en forme conditionnelle
Il s'agit de 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 n'importe lequel de ces détails de la feuille de calcul. Les modifications sont regroupées dans un lot afin que, si une requête échoue, aucune des autres modifications (potentiellement dépendantes) ne soit é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 valeur de cellule, vous pouvez également utiliser la ressource spreadsheets.values
décrite dans la section Lire et écrire des valeurs de cellule.
Catégories d'opération
Les opérations particulières compatibles avec spreadsheets.batchUpdate
peuvent être regroupées dans les grandes catégories suivantes:
Catégorie | Description |
---|---|
Ajouter (et Dupliquer) | Ajouter de nouveaux objets (parfois basés sur d'anciens, comme dans les requêtes en double) |
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 | Supprimez les 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 groupée
La méthode spreadsheets.batchUpdate
utilise un ou plusieurs objets Request, chacun spécifiant un seul type de requête à effectuer. Il existe de nombreux types de requêtes. Voici une répartition des types de requêtes, regroupés en différentes catégories.
Certaines requêtes supplémentaires imitent les actions des utilisateurs pour manipuler les données:
- AutoFillRequest
- CutPasteRequest
- CopyPasteRequest
- FindReplaceRequest
- PasteDataRequest
- TextToColumnsRequest
- SortRangeRequest
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 pour ne mettre à jour que certains champs d'un objet, en laissant les autres champs inchangés. Un masque de champ *
est traité comme une valeur générique et permet de 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 ne mettre à jour que 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 indice que la requête correspondante. Certaines requêtes n'ont pas de réponse, et pour celles-ci, la réponse est vide.
En règle générale, les requêtes "add" renvoient des réponses contenant des informations telles que l'ID de l'objet ajouté. Pour obtenir la liste des réponses acceptées, consultez la section Réponses.
Exemple
L'exemple de code suivant effectue les actions suivantes:
- Met à jour le titre de la feuille de calcul à l'aide de la variable
title
. - Recherche et remplace les valeurs de cellule dans la feuille de calcul à l'aide des variables
find
etreplacement
.