Method: documents.batchUpdate

Applique une ou plusieurs mises à jour du document.

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. Il n'est pas nécessaire que les autres requêtes renvoient des informations, qui renvoient chacune une réponse vide. L'ordre des réponses correspond à celui des requêtes.

Par exemple, supposons que vous appeliez BatchUpdate avec quatre mises à jour et que seule la troisième renvoie des informations. La réponse contiendra deux réponses vides, la troisième à la demande et une autre 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 les changements effectués: les modifications apportées par vos collaborateurs le sont également. En l'absence de collaborateurs, le document doit refléter vos modifications. Dans tous les cas, les mises à jour de votre requête seront appliquées 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 des mises à jour. Cette méthode permet un mappage individuel avec les mises à jour, mais les réponses à certaines requêtes peuvent être vides.
writeControl

object (WriteControl)

Mise à jour du contrôle de l'écriture 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 sur les autorisations.

Commande d'écriture

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 le comportement de la requête si cette révision ne correspond 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.

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

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

Si des modifications sont apportées aux collaborateurs après la lecture du document à l'aide de l'API, les changements générés par cette requête d'écriture sont appliqués aux modifications du collaborateur. Il en résulte 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 conflits de modifications. Lorsque vous utilisez l'ID de révision cible, le client API peut être considéré 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 400 "Requête incorrecte". La requête doit être relancée après extraction de 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, mais pour les documents fréquemment modifiés, cette fenêtre peut être plus courte.