Method: spreadsheets.batchUpdate

Applique une ou plusieurs modifications à la feuille de calcul.

Chaque request est validée avant d'être appliquée. Si l'une des requêtes n'est pas valide, l'ensemble de la requête échoue et aucune modification n'est appliquée.

Certaines requêtes contiennent replies pour vous fournir des informations sur leur application. Les réponses reflèteront 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 le processus terminé. En revanche, les mises à jour de la requête 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 spécifiées. Si une requête n'est pas valide, aucune requête 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 de réponse. 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. 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 par lot 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. Cette correspondance est un à un avec les mises à jour, bien que les réponses à certaines requêtes puissent être vides.
updatedSpreadsheet

object (Spreadsheet)

Feuille de calcul après l'application des mises à jour. Cette valeur n'est définie que si BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response est 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.