Method: spreadsheets.batchUpdate

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

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

Certaines demandes sont accompagnées de replies pour vous donner des informations sur leur application. Les réponses refléteront les demandes. Par exemple, si vous avez appliqué quatre mises à jour et que la troisième a reçu 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 cette opération terminée. Toutefois, il est garanti que les modifications de la demande seront appliquées de manière atomique. Vos modifications peuvent être modifiées en fonction de celles apportées par les collaborateurs. Si la feuille de calcul ne comporte aucun collaborateur, vos modifications devraient s'y refléter.

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,
  "commentsViewMode": enum (CommentsViewMode)
}
Champs
requests[]

object (Request)

Liste des mises à jour à appliquer à la feuille de calcul. Les demandes seront appliquées dans l'ordre dans lequel elles sont spécifiées. Si une demande n'est pas valide, aucune demande ne sera appliquée.
includeSpreadsheetInResponse

boolean

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

string

Limite les plages incluses dans la feuille de calcul de réponse. Pertinent uniquement si includeSpreadsheetInResponse est défini sur "true".
responseIncludeGridData

boolean

True si les données de la grille doivent être renvoyées. Pertinent uniquement 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.
commentsViewMode

enum (CommentsViewMode)

Mode d'affichage des commentaires à appliquer à la feuille de calcul. Cela permet d'afficher la feuille de calcul avec ou sans les commentaires. Si aucune valeur n'est spécifiée, COMMENTS_VIEW_MODE_OMITTED est utilisé. Pertinent uniquement si includeSpreadsheetInResponse est défini sur "true".

Corps de la réponse

Réponse pour 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)
  },
  "commentUpdateState": enum (CommentUpdateState)
}
Champs
spreadsheetId

string

La feuille de calcul à laquelle les modifications ont été appliquées.
replies[]

object (Response)

Réponse aux actualités. Cette valeur correspond aux mises à jour, même si les réponses à certaines requêtes peuvent être vides.
updatedSpreadsheet

object (Spreadsheet)

La feuille de calcul après l'application des modifications. Cette valeur n'est définie que si BatchUpdateSpreadsheetRequest.include_spreadsheet_in_response est true.
commentUpdateState

enum (CommentUpdateState)

Indique si les modifications apportées aux commentaires ont été appliquées dans la requête par lot.

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 d'autorisation.

CommentUpdateState

État des mises à jour des commentaires dans la requête par lot.

Enums
COMMENT_UPDATE_STATE_UNSPECIFIED L'état des mises à jour des commentaires n'est pas spécifié.
NO_UPDATES_REQUESTED Aucune mise à jour de commentaire n'a été demandée dans la requête par lot.
ALL_SAVED Toutes les modifications demandées pour les commentaires ont été appliquées dans la requête par lot.
ALL_FAILED_UNKNOWN_REASON Échec de toutes les modifications demandées pour les commentaires.