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 l'autorisation 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 a reçu une réponse, celle-ci contiendra 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 celles-ci reflèteront exactement vos modifications une fois l'opération terminée. Toutefois, il est garanti que les mises à jour de la demande seront appliquées ensemble de manière atomique. Les changements effectués par vos collaborateurs sont susceptibles d'être modifiés. 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 mises à jour à appliquer à la feuille de calcul. Les requêtes sont appliquées dans l'ordre dans lequel elles sont spécifiées. Si une requête n'est pas valide, aucune requête n'est 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'est pertinent que si la valeur de includeSpreadsheetInResponse est "true".
responseIncludeGridData

boolean

"True" si les données de la grille doivent être renvoyées. N'est pertinent que si la valeur de 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 concernant 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. Ce mappage affiche les mises à jour de manière individuelle, bien que les réponses à certaines requêtes 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.