Method: documents.batchUpdate

Applique une ou plusieurs mises à jour au document.

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 autres requêtes n'ont pas besoin de renvoyer d'informations. renvoient chacune une réponse vide. L'ordre des réponses correspond à celui des requêtes.

Par exemple, supposons que vous appelez batchUpdate avec quatre mises à jour et que seule la troisième renvoie des informations. La réponse aurait deux réponses vides, la réponse à la troisième demande et une autre réponse vide, dans cet ordre.

Étant donné que d'autres utilisateurs sont susceptibles de modifier le document, il est possible que celui-ci ne reflète pas exactement vos modifications: celles-ci peuvent l'être également par les collaborateurs. En l'absence de collaborateurs, le document doit refléter vos modifications. Dans tous les cas, l'application des mises à jour de votre requête est garantie de manière atomique.

Requête HTTP

POST https://docs.googleapis.com/v1/documents/{documentId}:batchUpdate

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
documentId

string

ID du document à mettre à 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)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Champs
requests[]

object (Request)

Liste des mises à jour à appliquer au document.
writeControl

object (WriteControl)

Permet de contrôler l'exécution des requêtes d'écriture.

Corps de la réponse

Message de réponse à une requête documents.batchUpdate.

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

Représentation JSON 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Champs
documentId

string

ID du document auquel 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.
writeControl

object (WriteControl)

Contrôle d'écriture mis à jour après l'application de la requête.

Champs d'application des autorisations

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

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

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

WriteControl

Permet de contrôler l'exécution des requêtes d'écriture.

Représentation JSON 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Champs
Champ d'union control. Détermine la révision du document dans laquelle écrire et comment la requête doit se comporter si cette révision n'est pas la révision actuelle du document. Si aucun champ n'est spécifié, les mises à jour sont appliquées à la dernière révision. control ne peut être qu'un des éléments suivants :
requiredRevisionId

string

revision ID facultatif du document auquel la requête d'écriture est appliquée. S'il ne s'agit pas de la dernière révision du document, la requête n'est pas traitée et renvoie une erreur 400 (requête incorrecte).

Lorsqu'un ID de révision requis est renvoyé dans une réponse, il indique l'ID de révision du document après l'application de la requête.
targetRevisionId

string

Cible facultative revision ID du document auquel la requête d'écriture est appliquée.

Si des modifications apportées par un collaborateur ont eu lieu après la lecture du document à l'aide de l'API, les modifications générées par cette demande d'écriture sont appliquées aux modifications effectuées par les collaborateurs. Cela se traduit par une nouvelle révision du document qui intègre à la fois les modifications apportées par les collaborateurs et celles de la requête, le serveur Docs résolvant les modifications conflictuelles. Lorsque vous utilisez l'ID de révision cible, vous pouvez considérer le client API comme un autre collaborateur du document.

L'ID de révision cible ne peut être utilisé que pour écrire dans les versions récentes d'un document. Si la révision cible est trop éloignée de la dernière révision, la requête n'est pas traitée et renvoie une erreur de requête incorrecte 400. La requête doit être relancée après avoir récupéré la dernière version du document. Généralement, un ID de révision reste valide pour être utilisé comme révision cible pendant plusieurs minutes après sa lecture. Cependant, pour les documents fréquemment modifiés, cette fenêtre peut être plus courte.