Method: spreadsheets.batchUpdate

Applique une ou plusieurs modifications à la feuille de calcul.

Chaque request est validée avant d'être appliquée. Si une requête n'est pas valide, toute la requête échouera et rien ne sera appliqué.

Certaines requêtes comportent des replies pour vous donner des informations sur leur application. Les réponses reflètent les requêtes. Par exemple, si vous avez appliqué quatre mises à jour et que la troisième comporte une réponse, la réponse comportera deux réponses vides, la réponse réelle et une autre réponse vide, dans cet ordre.

En raison de la nature collaborative des feuilles de calcul, il n'est pas garanti que la feuille de calcul reflète exactement vos modifications une fois l'opération terminée, mais il est garanti que les mises à jour de la demande seront appliquées ensemble de manière atomique. Vos modifications peuvent être apportées par rapport aux modifications apportées par les collaborateurs. En l'absence de collaborateurs, la feuille de calcul doit refléter vos modifications.

Requête HTTP

POST https://sheets.googleapis.com/v4/spreadsheets/{spreadsheetId}:batchUpdate

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
spreadsheetId

string

Feuille de calcul à laquelle appliquer les mises à jour.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "includeSpreadsheetInResponse": boolean,
  "responseRanges": [
    string
  ],
  "responseIncludeGridData": boolean
}
Champs
requests[]

object (Request)

Liste des modifications à appliquer à la feuille de calcul. Les requêtes seront appliquées dans l'ordre dans lequel elles sont indiquées. Si une demande n'est pas valide, aucune demande ne sera appliquée.
includeSpreadsheetInResponse

boolean

Détermine si la réponse de mise à jour doit inclure la ressource de feuille de calcul.
responseRanges[]

string

Limite les plages incluses dans la feuille de calcul des réponses. Cela n'a de sens que si includeSpreadsheetInResponse est défini sur "true".
responseIncludeGridData

boolean

"True" si des données de grille doivent être renvoyées. Cela n'a de sens que si includeSpreadsheetInResponse est défini sur "true". Ce paramètre est ignoré si un masque de champ a été défini dans la requête.

Corps de la réponse

Réponse à la mise à jour groupée d'une feuille de calcul.

Si la requête aboutit, le corps de la réponse contient des données qui ont la structure suivante :

Représentation JSON 
{
  "spreadsheetId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "updatedSpreadsheet": {
    object (Spreadsheet)
  }
}
Champs
spreadsheetId

string

Feuille de calcul à laquelle les mises à jour ont été appliquées.
replies[]

object (Response)

Réponse aux mises à jour. Il correspond à la version 1:1 des mises à jour, bien que les réponses à certaines demandes puissent être vides.
updatedSpreadsheet

object (Spreadsheet)

Feuille de calcul après l'application des mises à jour Il n'est défini que si BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response est défini sur true.

Champs d'application des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/spreadsheets

Pour en savoir plus, consultez le Guide relatif aux autorisations.