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, l'ensemble de la requête échoue et rien n'est appliqué.

Certaines requêtes sont accompagnées de replies pour vous donner des informations sur leur application. Les autres requêtes n'ont pas besoin de renvoyer d'informations. Elles 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 comporterait deux réponses vides, la réponse à la troisième requête et une autre réponse vide, dans cet ordre.

Étant donné que d'autres utilisateurs peuvent modifier le document, il est possible qu'il ne reflète pas exactement vos modifications. En effet, vos modifications peuvent être modifiées par rapport à celles des collaborateurs. Si aucun collaborateur n'est associé au document, vos modifications devraient y être reflétées. Dans tous les cas, les modifications apportées à votre demande sont garanties d'être 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 d'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 modifications ont été appliquées.
replies[]

object (Response)

Réponse aux mises à jour. Cette valeur correspond à une mise à jour, même si la réponse à certaines requêtes peut être vide.
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 d'autorisation.

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 le comportement de la requête si cette révision n'est pas la révision actuelle du document. Si aucun champ n'est spécifié, les modifications 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. Si ce n'est pas 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

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

Si des modifications ont été apportées par des collaborateurs après la lecture du document à l'aide de l'API, les modifications produites par cette requête d'écriture sont appliquées aux modifications apportées par les collaborateurs. Une nouvelle révision du document est alors créée, intégrant à la fois les modifications apportées par le collaborateur et celles de la demande. Le serveur Docs résout 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 avoir récupéré la dernière version du document. En général, un ID de révision reste valide en tant que révision cible pendant plusieurs minutes après sa lecture, mais cette période peut être plus courte pour les documents fréquemment modifiés.