- HTTP isteği
- Yol parametreleri
- İstek metni
- Yanıt metni
- Yetkilendirme kapsamları
- İstek
- ReplaceAllTextRequest
- SubstringMatchCriteria
- TabsCriteria
- InsertTextRequest
- Konum
- EndOfSegmentLocation
- UpdateTextStyleRequest
- CreateParagraphBulletsRequest
- BulletGlyphPreset
- DeleteParagraphBulletsRequest
- CreateNamedRangeRequest
- DeleteNamedRangeRequest
- UpdateParagraphStyleRequest
- DeleteContentRangeRequest
- InsertInlineImageRequest
- InsertTableRequest
- InsertTableRowRequest
- TableCellLocation
- InsertTableColumnRequest
- DeleteTableRowRequest
- DeleteTableColumnRequest
- InsertPageBreakRequest
- DeletePositionedObjectRequest
- UpdateTableColumnPropertiesRequest
- UpdateTableCellStyleRequest
- TableRange
- UpdateTableRowStyleRequest
- ReplaceImageRequest
- ImageReplaceMethod
- UpdateDocumentStyleRequest
- MergeTableCellsRequest
- UnmergeTableCellsRequest
- CreateHeaderRequest
- HeaderFooterType
- CreateFooterRequest
- CreateFootnoteRequest
- ReplaceNamedRangeContentRequest
- UpdateSectionStyleRequest
- InsertSectionBreakRequest
- DeleteHeaderRequest
- DeleteFooterRequest
- PinTableHeaderRowsRequest
- InsertPersonRequest
- WriteControl
- Yanıt
- ReplaceAllTextResponse
- CreateNamedRangeResponse
- InsertInlineImageResponse
- InsertInlineSheetsChartResponse
- CreateHeaderResponse
- CreateFooterResponse
- CreateFootnoteResponse
- Deneyin.
Belgeye bir veya daha fazla güncelleme uygular.
Her request
uygulanmadan önce doğrulanır. İsteklerden herhangi biri geçerli değilse isteğin tamamı başarısız olur ve hiçbir şey uygulanmaz.
Bazı isteklerde, nasıl uygulandıkları hakkında bilgi veren replies
simgesi bulunur. Diğer isteklerin bilgi döndürmesi gerekmez. Bu istekler boş bir yanıt döndürür. Yanıtların sırası, isteklerin sırasıyla eşleşir.
Örneğin, batchUpdate'i dört güncelleme ile çağırdığınızı ve yalnızca üçüncü güncellemenin bilgi döndürdüğünü varsayalım. Yanıt sırasıyla iki boş yanıt, üçüncü isteğe verilen yanıt ve başka bir boş yanıt içerir.
Diğer kullanıcılar dokümanı düzenliyor olabileceğinden doküman, değişikliklerinizi tam olarak yansıtmayabilir. Değişiklikleriniz, ortak çalışanların yaptığı değişikliklere göre değiştirilebilir. Ortak çalışan yoksa dokümanda değişiklikleriniz yansıtılır. Her durumda, isteğinizdeki güncellemelerin atomik 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 |
Güncellenecek dokümanın kimliği. |
İstek içeriği
İstek içeriği aşağıdaki yapıyla birlikte verileri içerir:
JSON gösterimi |
---|
{ "requests": [ { object ( |
Alanlar | |
---|---|
requests[] |
Belgeye uygulanacak güncellemelerin listesi. |
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 ( |
Alanlar | |
---|---|
documentId |
Güncellemelerin uygulandığı belgenin kimliği. |
replies[] |
Güncellemelerin yanıtı. Bu, güncellemelerle 1:1 eşleşir ancak bazı isteklere verilen yanıtlar boş olabilir. |
writeControl |
İstek uygulandıktan sonra güncellenen 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ılavuzu'na bakın.
WriteControl
Yazma isteklerinin nasıl yürütüleceği üzerinde kontrol sağlar.
JSON gösterimi |
---|
{ // Union field |
Alanlar | |
---|---|
control birleşik alanı. 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. İki alan da belirtilmezse güncellemeler en son düzeltmeye uygulanır. control aşağıdakilerden yalnızca biri olabilir: |
|
requiredRevisionId |
Yazma isteğinin uygulandığı dokümanın isteğe bağlı Bir yanıtta gerekli düzeltme kimliği döndürüldüğünde, bu kimlik isteğin uygulanmasından sonraki dokümanın düzeltme kimliğini gösterir. |
targetRevisionId |
Yazma isteğinin uygulandığı dokümanın isteğe bağlı hedefi Doküman API kullanılarak okunduktan sonra ortak çalışan değişiklikleri yapıldıysa bu yazma isteğiyle yapılan değişiklikler, ortak çalışan değişikliklerine göre uygulanır. Bu durumda, dokümanın hem ortak çalışan değişikliklerini hem de istekteki değişiklikleri içeren yeni bir sürümü oluşturulur. Çakışan değişiklikler ise Dokümanlar sunucusu tarafından çözülür. Hedef düzeltme kimliği kullanılırken API istemcisi, belgenin başka bir ortak çalışanı olarak düşünülebilir. Hedef düzeltme kimliği yalnızca bir belgenin son sürümlerine yazmak için kullanılabilir. Hedef düzeltme, en son düzeltmenin çok gerisindeyse 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ça düzenlenen dokümanlarda bu süre daha kısa olabilir. |