- HTTP isteği
- Yol parametreleri
- İstek gövdesi
- Yanıt metni
- Yetkilendirme kapsamları
- İstek gönder
- ReplaceAllTextRequest
- SubstringMatchCriteria
- TabsCriteria
- InsertTextRequest
- Yer
- 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
- WriteControl
- Yanıt
- ReplaceAllTextResponse
- CreateNamedRangeResponse
- InsertInlineImageResponse
- InsertInlineSheetsChartResponse
- CreateHeaderResponse
- CreateFooterResponse
- CreateFootnoteResponse
- Deneyin.
Dokümana bir veya daha fazla güncelleme uygular.
Her request
uygulanmadan önce doğrulanır. Herhangi bir istek 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 size bilgi vermesi için replies
izni bulunuyor. Diğer taleplerin bilgi döndürmesi gerekmez; bunların her biri boş bir yanıt döndürür. Yanıtların sırası isteklerin sıralamasıyla eşleşiyor.
Örneğin, dört güncellemeyle Toplu Güncelleme işlevini çağırdığınızı ve yalnızca üçüncüsünün bilgi döndürdüğünü varsayalım. Yanıtta iki boş yanıt olur: bu sırayla üçüncü isteğe yanıt ve başka bir boş yanıt.
Dokümanı başka kullanıcılar düzenliyor olabileceğinden, doküman sizin değişikliklerinizi tam olarak yansıtmayabilir. Ortak çalışan değişikliklerine bağlı olarak sizin değişikliklerinizde değişiklik yapılabilir. Hiç ortak çalışan yoksa doküman, değişikliklerinizi yansıtmalıdır. Her durumda, isteğinizdeki güncellemelerin atomik bir şekilde birlikte uygulanması 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 gövdesi, aşağıdaki yapıya sahip verileri içerir:
JSON gösterimi |
---|
{ "requests": [ { object ( |
Alanlar | |
---|---|
requests[] |
Dokümana uygulanacak güncellemelerin listesi. |
writeControl |
Yazma isteklerinin nasıl yürütüleceğini kontrol eder. |
Yanıt gövdesi
documents.batchUpdate
isteğindeki 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ığı dokümanın kimliği. |
replies[] |
Güncellemelerin yanıtı. Bu özet, güncellemelerle bire bir eşleşir ancak bazı isteklere verilen yanıtlar boş olabilir. |
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ılavuzunu inceleyin.
WriteControl
Yazma isteklerinin nasıl yürütüleceğini kontrol eder.
JSON gösterimi |
---|
{ // Union field |
Alanlar | |
---|---|
Birleştirme alanı control . Yazılacak belgenin düzeltmesini ve bu düzeltme dokümanın geçerli 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 şunlardan yalnızca biri olabilir: |
|
requiredRevisionId |
Yazma isteğinin uygulandığı belgenin isteğe bağlı Gerekli düzeltme kimliği yanıtta döndürüldüğünde, istek uygulandıktan sonraki belgenin düzeltme kimliğini belirtir. |
targetRevisionId |
Yazma isteğinin uygulandığı belgenin isteğe bağlı hedefi Doküman API kullanılarak okunduktan sonra ortak çalışan değişiklikleri olmuşsa bu yazma isteği ile üretilen değişiklikler ortak çalışan değişikliklerine uygulanır. Bu işlem, dokümanın hem ortak çalışan değişikliklerini hem de istekteki değişiklikleri içeren yeni bir düzeltmesiyle sonuçlanır ve 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 en son sürümlerine 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ın en son sürümü alındıktan sonra istek tekrar denenmelidir. Genellikle, bir düzeltme kimliği okunduktan sonra birkaç dakika boyunca hedef düzeltme olarak kullanılmak üzere geçerli kalır, ancak sık düzenlenen dokümanlar için bu süre daha kısa olabilir. |