Method: spreadsheets.batchUpdate

Applique une ou plusieurs mises à jour à la feuille de calcul.

Chaque request est validé avant d'être appliqué. Si une requête n'est pas valide, l'intégralité de la requête échoue, et rien n'est appliqué.

Certaines requêtes comportent replies pour vous fournir des informations sur la manière dont elles sont appliquées. Les réponses reflètent les requêtes. Par exemple, si vous avez appliqué quatre mises à jour et que la troisième en a reçu une, la réponse aura 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 qu'elles reflètent exactement vos modifications une fois ces opérations terminées. Cependant, il est possible que les mises à jour de la demande soient appliquées de manière atomique. Vos modifications peuvent être modifiées en fonction de celles d'un collaborateur. 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 modifications.

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 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 de réponse. Signification uniquement si includeSpreadsheetInResponse est "true".

responseIncludeGridData

boolean

Défini sur "true" si les données de la grille doivent être renvoyées. Signification uniquement si includeSpreadsheetInResponse est "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 pour 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 des mises à jour. Cette méthode permet un mappage individuel avec les mises à jour, mais les réponses à certaines requêtes peuvent être vides.

updatedSpreadsheet

object (Spreadsheet)

Feuille de calcul après l'application des mises à jour. Ce champ n'est défini 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 sur les autorisations.