Method: documents.batchUpdate

Dokümanda bir veya daha fazla güncelleme uygular.

Her request, uygulanmadan önce doğrulanır. Geçerli bir istek olmaması durumunda, isteğin tamamı başarısız olur ve hiçbir şey uygulanmaz.

Bazı isteklerde, nasıl uygulandıkları hakkında size bilgi veren replies bulunur. Diğer isteklerin bilgi döndürmesi gerekmez; her istek boş yanıt döndürecektir. Yanıtların sırası, isteklerin sırası ile eşleşir.

Örneğin, dört güncellemeyle toplu güncelleme aradığınızı ve yalnızca üçüncüsünün bilgi döndürdüğünü varsayalım. Yanıtta iki boş yanıt, üçüncü isteğe verilen yanıt ve bu sırayla başka bir boş yanıt bulunur.

Diğer kullanıcılar dokümanı düzenlediği için doküman değişikliklerinizi tam olarak yansıtmayabilir: Yaptığınız değişiklikler ortak çalışan değişikliklerine göre değiştirilebilir. Ortak çalışan yoksa doküman, değişikliklerinizi yansıtmalıdır. Her durumda, isteğinizdeki güncellemelerin atom olarak birlikte uygulanacağı garanti edilir.

HTTP isteği

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

URL, gRPC Kod Dönüştürme söz dizimini kullanır.

Yol parametreleri

Parametreler
documentId

string

Güncellenecek dokümanın kimliği.

İstek içeriği

İstek gövdesi aşağıdaki yapıya sahip veriler içerir:

JSON gösterimi 
{
  "requests": [
    {
      object (Request)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Alanlar
requests[]

object (Request)

Dokümana uygulanacak güncellemelerin listesi.
writeControl

object (WriteControl)

Yazma isteklerinin nasıl yürütüleceği üzerinde kontrol sağlar.

Yanıt gövdesi

Bir documents.batchUpdate isteğinden gelen yanıt mesajı.

Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:

JSON gösterimi 
{
  "documentId": string,
  "replies": [
    {
      object (Response)
    }
  ],
  "writeControl": {
    object (WriteControl)
  }
}
Alanlar
documentId

string

Güncellemelerin uygulandığı dokümanın kimliği.
replies[]

object (Response)

Güncellemelerin yanıtı. Bu işlem, güncellemeleri 1:1 olarak eşler ancak bazı isteklere yanıt verilmeyebilir.
writeControl

object (WriteControl)

İstek uygulandıktan sonra güncellenmiş yazma kontrolü.

Yetkilendirme kapsamları

Aşağıdaki OAuth kapsamlarından birini gerektirir:

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

Daha fazla bilgi için Yetkilendirme kılavuzuna bakın.

Yazma Denetimi

Yazma isteklerinin nasıl yürütüleceği üzerinde kontrol sağlar.

JSON gösterimi 
{

  // Union field control can be only one of the following:
  "requiredRevisionId": string,
  "targetRevisionId": string
  // End of list of possible types for union field control.
}
Alanlar
Birlik alanı control. Belgenin yazılacağı düzeltmeyi ve düzeltme, dokümanın geçerli düzeltmesi değilse nasıl davranması gerektiğini belirler. Hiçbir alan belirtilmezse güncellemeler en son düzeltmeye uygulanır. control aşağıdakilerden yalnızca biri olabilir:
requiredRevisionId

string

Yazma isteğinin uygulandığı dokümanın isteğe bağlı revision ID öğesi. Bu, dokümanın en son düzeltmesi değilse istek işleme alınmaz ve 400 hatalı istek hatası döndürür.

Yanıtta gerekli bir düzeltme kimliği döndürüldüğünde bu, istek uygulandıktan sonra dokümanın düzeltme kimliğini belirtir.
targetRevisionId

string

Yazma isteğinin uygulandığı dokümanın isteğe bağlı revision ID hedefi.

Doküman API kullanılarak okunduktan sonra ortak çalışan değişiklikleri gerçekleştiyse bu yazma isteği tarafından oluşturulan değişiklikler, ortak çalışan değişikliklerine uygulanır. Bu durum, hem doküman üzerinde ortak çalışan tarafından yapılan değişiklikleri hem de istekteki değişiklikleri içeren yeni bir düzeltmeye yol açar. Böylece, Dokümanlar sunucusu çakışan değişiklikleri çözümler. Hedef düzeltme kimliği kullanılırken API istemcisi, dokümanın başka bir ortak çalışanı olarak düşünülebilir.

Hedef düzeltme kimliği, yalnızca bir dokümanın son sürümlerine veri yazmak için kullanılabilir. Hedef düzeltme son düzeltmenin çok gerisindeyse istek işlenmez ve 400 hatalı istek hatası döndürür. Doküman, dokümanın en son sürümünü aldıktan sonra tekrar denenmelidir. Düzeltme kimliği genellikle okunduktan sonra birkaç dakika boyunca hedef düzeltme olarak kullanılabilir, ancak sık düzenlenen dokümanlar için bu pencere daha kısa olabilir.