Method: documents.batchUpdate

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

Her request uygulanmadan önce doğrulanır. Geçersiz olan istekler reddedilir ve hiçbir işlem uygulanmaz.

Bazı isteklerde, nasıl uygulandıkları hakkında bilgi veren replies bulunur. Diğer isteklerin bilgi döndürmesi gerekmez. Bu isteklerin her biri boş bir yanıt döndürür. Yanıtların sırası, isteklerin sırasıyla eşleşir.

Örneğin, batchUpdate işlevini dört güncellemeyle çağırdığı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.

Dokümanı başka kullanıcılar da düzenleyebileceğinden, doküman değişikliklerinizi tam olarak yansıtmayabilir. Değişiklikleriniz, ortak çalışan değişikliklerine göre değiştirilebilir. Ortak çalışan yoksa dokümanda değişiklikleriniz yansıtılır. Her durumda, isteğinizde belirtilen güncellemelerin birlikte atomik olarak 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 metni aşağıdaki yapıyla birlikte verileri 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

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, güncellemelerle 1:1 eşleşir ancak bazı isteklerin yanıtları boş olabilir.
writeControl

object (WriteControl)

İstek uygulandıktan sonra güncellenen yazma denetimi.

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.

WriteControl

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. Yazılacak dokümanın düzeltmesini ve bu düzeltme dokümanın mevcut düzeltmesi değilse isteğin nasıl davranması gerektiğini belirler. Hiçbir alan belirtilmezse güncellemeler en son düzeltmeye uygulanır. control şunlardan yalnızca biri olabilir:
requiredRevisionId

string

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

Bir yanıtta gerekli düzeltme kimliği döndürüldüğünde, bu kimlik, istek uygulandıktan sonra dokümanın düzeltme kimliğini gösterir.
targetRevisionId

string

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

Doküman API kullanılarak okunduktan sonra ortak çalışan değişiklikleri yapıldıysa bu yazma isteği tarafından oluşturulan değişiklikler, ortak çalışan değişikliklerine uygulanır. Bu işlem, dokümanda hem ortak çalışan değişikliklerini hem de istekteki değişiklikleri içeren yeni bir düzeltmeyle sonuçlanır. Dokümanlar sunucusu, çakışan değişiklikleri çözer. Hedef düzeltme kimliği kullanıldığında 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 yazmak için kullanılabilir. Hedef düzeltme, en son düzeltmeden çok gerideyse istek işlenmez ve 400 hatalı istek hatası döndürülür. İstek, dokümanın en son sürümü alındıktan sonra tekrar denenmelidir. Genellikle bir düzeltme kimliği, okunduktan sonra birkaç dakika boyunca hedef düzeltme olarak kullanılabilir. Ancak sık sık düzenlenen belgelerde bu süre daha kısa olabilir.