Ce document explique comment regrouper les appels d'API pour réduire le nombre de connexions que votre client doit établir. Cette opération peut améliorer l'efficacité d'une application en diminuant les allers-retours réseau et en augmentant le débit.
Présentation
Chaque connexion effectuée par votre client entraîne une certaine surcharge. L'API Google Sheets accepte les requêtes par lot, ce qui permet à votre client de placer plusieurs objets de requête, chacun spécifiant un type de requête à exécuter, dans une seule requête par lot. Une requête par lot peut améliorer les performances en combinant plusieurs sous-requêtes en un seul appel au serveur, récupérant ainsi une seule réponse.
Nous encourageons les utilisateurs à toujours regrouper les requêtes par lot. Voici quelques exemples de situations dans lesquelles vous pouvez utiliser le traitement par lot:
- Vous venez de commencer à utiliser l'API et vous avez beaucoup de données à importer.
- Vous devez mettre à jour les métadonnées ou les propriétés, telles que la mise en forme, sur plusieurs objets.
- Vous devez supprimer de nombreux objets.
Limites, autorisations et dépendances
Voici une liste d'autres éléments à prendre en compte lors de l'utilisation de la mise à jour groupée:
- Chaque requête par lot, y compris toutes les sous-requêtes, est comptabilisée comme une requête API dans votre limite d'utilisation.
- Une requête par lot est authentifiée une seule fois. Cette authentification unique s'applique à tous les objets de mise à jour par lot de la requête.
- Le serveur traite les sous-requêtes dans l'ordre dans lequel elles apparaissent dans la requête par lot. Ces sous-requêtes peuvent dépendre des actions entreprises lors des sous-requêtes précédentes. Par exemple, dans la même requête par lot, les utilisateurs peuvent insérer du texte dans un document existant, puis lui appliquer un style.
Informations sur les lots
Une requête par lot consiste en un appel de méthode batchUpdate avec plusieurs sous-requêtes pour, par exemple, ajouter, puis mettre en forme une feuille de calcul.
Chaque demande est validée avant d'être appliquée. Toutes les sous-requêtes de la mise à jour par lot sont appliquées de manière atomique. Autrement dit, si une requête n'est pas valide, la mise à jour entière échoue et aucune des modifications (potentiellement dépendantes) n'est appliquée.
Certaines requêtes fournissent des réponses sur les requêtes appliquées. Par exemple, toutes les requêtes de mise à jour par lot visant à ajouter des objets renvoient des réponses afin que vous puissiez accéder aux métadonnées de l'objet nouvellement ajouté, telles que l'ID ou le titre.
Cette approche vous permet de créer un document Google complet à l'aide d'une requête API de mise à jour groupée avec plusieurs sous-requêtes.
Format d'une requête par lot
Une requête est une requête JSON unique contenant plusieurs sous-requêtes imbriquées avec une propriété obligatoire: requests. Les requêtes sont construites dans un tableau de requêtes individuelles. Chaque requête utilise JSON pour représenter l'objet de la requête et contenir ses propriétés.
Format d'une réponse par lot
Le format de réponse à une requête par lot est semblable au format de requête. La réponse du serveur contient une réponse complète de l'objet de réponse unique.
La propriété de l'objet JSON principal est nommée replies. Les réponses sont renvoyées dans un tableau, chaque réponse à l'une des requêtes occupant le même ordre d'index que la requête correspondante. Certaines requêtes n'ont pas de réponse et la réponse à cet index de tableau est vide.
Exemple
L'exemple suivant illustre l'utilisation du traitement par lot avec l'API Sheets.
Requête
Cet exemple de requête par lot montre comment:
- Ajoutez une feuille à une feuille de calcul existante, avec un
sheetIdde 12 345, à l'aide deAddSheetRequest. - Ajoutez des données à la nouvelle feuille, en commençant par la cellule A1, à l'aide de
UpdateCellsRequest. - Ajoutez une
namedRangeou une vue filtrée à la nouvelle feuille.
En ajoutant l'ID de la feuille dans la requête, les utilisateurs peuvent l'utiliser pour d'autres sous-requêtes dans le même appel d'API. Cela améliore les performances en évitant un cycle écriture-lecture-écriture.
Pour obtenir la liste des types de requêtes de mise à jour groupée, regroupés en différentes catégories, consultez le tableau sous Opérations de mise à jour groupée.
{
"requests":[
{
"addSheet":{
"properties":{
"sheetId":123456
}
}
},
{
"updateCells":{
"start":{
"sheetId":123456
},
"rows":[
{
"values":[
{
"userEnteredValue":{
"stringValue":"hello"
}
}
]
},
{
"values":[
{
"userEnteredValue":{
"stringValue":"world"
}
}
]
}
],
"fields":"userEnteredValue"
}
},
{
"addNamedRange":{
"namedRange":{
"name":"newRange",
"range":{
"sheetId":123456,
"endRowIndex":2
}
}
}
}
]
}
Réponse
Cet exemple de réponse par lot affiche des informations sur la manière dont chaque sous-requête au sein de la requête par lot a été appliquée. Notez que UpdateCellsRequest ne contient pas de réponse. Par conséquent, la valeur d'index du tableau [1] est constituée d'accolades vides.
"replies":[
{
"addSheet":{
"properties":{
"sheetId":123456,
"title":"Sheet3",
"index":2,
"sheetType":"GRID",
"gridProperties":{
"rowCount":1000,
"columnCount":26
}
}
}
},
{
},
{
"addNamedRange":{
"namedRange":{
"namedRangeId":"2104325079",
"name":"newRange",
"range":{
"sheetId":123456,
"startRowIndex":0,
"endRowIndex":2,
"startColumnIndex":0,
"endColumnIndex":26
}
}
}
}
]