Outre les données de valeur contenues dans ses cellules, une feuille de calcul inclut de nombreux autres types de données, par exemple:
- Dimensions
- Formats et bordures des cellules
- Plages nommées
- Plages protégées
- Mise en forme conditionnelle
Ce sont 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 de sorte qu'en cas d'échec d'une requête, 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 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 particulières compatibles avec 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 les anciens, comme dans les requêtes Duplicate ). |
Mettre à jour (et Définir) | Met à jour certaines propriétés d'un objet, en laissant généralement les anciennes propriétés telles (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 groupée
La méthode spreadsheets.batchUpdate
fonctionne en acceptant un ou plusieurs objets Request, chacun spécifiant un seul type de requête à effectuer. Il existe de nombreux types de requêtes différents. Voici une répartition des types de requêtes,
regroupées en différentes catégories.
D'autres requêtes imitent également les actions de l'utilisateur pour manipuler les données:
- AutoFillRequest
- CutPasteRequest
- CopyPasteRequest
- FindReplaceRequest
- PasteDataRequest
- TextToColumnsRequest
- SortRangeRequest
Limites
Pour en savoir plus sur le nombre maximal 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, tout en laissant les autres champs inchangés. Un masque de champ *
est traité comme un caractère générique et sert à 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 dans la requête).
Pour en savoir plus sur les masques de champ, consultez la section Utiliser des masques de champ.
L'exemple suivant utilise UpdateSpreadsheetPropertiesRequest
pour ne mettre à jour que le titre d'une feuille de calcul:
Demande :
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
Lors de la mise à jour d'une feuille de calcul, certains types de requêtes peuvent renvoyer des réponses. Celles-ci sont renvoyées dans un tableau et chaque réponse occupe le même index que la requête correspondante. Certaines requêtes n'ont pas de réponse. Dans ce cas, la réponse est vide.
En règle générale, les requêtes "add" comportent des réponses qui renvoient 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 ces actions:
- 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
.