string

The ID of the document to update.

{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}

object (Request)

A list of updates to apply to the document.

object (WriteControl)

Provides control over how write requests are executed.

{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}

string

The ID of the document to which the updates were applied to.

object (Response)

The reply of the updates. This maps 1:1 with the updates, although replies to some requests may be empty.

object (WriteControl)

The updated write control after applying the request.

{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}

string

The revision ID of the document that the write request will be applied to. If this is not the latest revision of the document, the request will not be processed and will return a 400 bad request error.

When a required revision ID is returned in a response, it indicates the revision ID of the document after the request was applied.

string

The target revision ID of the document that the write request will be applied to.

If collaborator changes have occurred after the document was read using the API, the changes produced by this write request will be transformed against the collaborator changes. This results in a new revision of the document which incorporates both the changes in the request and the collaborator changes, and the Docs server will resolve conflicting changes. When using targetRevisionId, the API client can be thought of as another collaborator of the document.

The target revision ID may only be used to write to recent versions of a document. If the target revision is too far behind the latest revision, the request will not be processed and will return a 400 bad request error and the request should be retried after reading the latest version of the document. In most cases a revisionId will remain valid for use as a target revision for several minutes after it is read, but for frequently-edited documents this window may be shorter.