İstekler ve yanıtlar

Bu kılavuzda, Google Docs API ve bir dokümanı toplu olarak nasıl güncelleyebileceğiniz.

Google Docs API'yi bir HTTP isteği veya yöntem kullanarak çağırabilirsiniz çağrının dile özgü bir istemci kitaplığında olması gerekir. Bunlar genel olarak eşdeğerdir.

Google Docs API, HTTP yanıtı döndürüyor ve bu yanıt genellikle ilgili sonucu isteği gönderir. İstekte bulunmak için bir istemci kitaplığı kullanırken, farklı bir şekilde döndürülür.

İstek yöntemleri

Docs API aşağıdaki yöntemleri destekler:

  • documents.create: Bir boş Google Dokümanlar dokümanı.
  • documents.get: Döndürme a tam örneğini oluşturur. Döndürülen JSON dosyasını ayrıştırabilirsiniz. tıklayarak doküman içeriğini, biçimlendirmeyi ve diğer özellikleri ayıklayın.
  • documents.batchUpdate: Belgeye atomik olarak uygulanacak düzenleme isteklerinin listesini gönderin ve sonuçların listesini döndürün.

documents.get ve documents.batchUpdate yöntemleri için documentId gerekir parametre olarak kullanabilirsiniz. documents.create yöntemi oluşturulan dokümanın bir örneğini döndürür. Bu örnekte documentId. documentId hakkında daha fazla bilgi için bkz. Doküman Kimlik.

Toplu güncellemeler

documents.batchUpdate yöntemin Her biri request nesne tek bir istek belirtin. Örneğin, bir paragrafı biçimlendirin ve ardından satır içi resim ekleyin. Her istek uygulanmadan önce doğrulanır ve istekler, toplu istekte göründükleri sıraya göre işlenir.

Toplu güncellemedeki tüm istekler atomik olarak uygulanır. Yani, müşteriye geçersiz hale gelirse güncellemenin tamamı başarısız olur ve (potansiyel olarak (bağlı olarak) nasıl uygulanır?

Bazı documents.batchUpdate yöntemleri, uygulanan istekler hakkında bilgi içeren yanıtlar sağlar. Bu yöntemler yanıt gövde response listesini içerir nesneler'i tıklayın. Diğer isteklerin bilgi döndürmesi ve boş bir yanıt ver. Yanıt listesindeki nesneler, ilgili istekle aynı dizin sırasını kullanır.

Toplu istek göndermek için kullanılan popüler bir kalıp aşağıdaki gibidir:

requests = []
requests.append(first request)
requests.append(second request)
...

body = ... & requests & ...

...batchUpdate(body)

Tüm ayrıntılar için toplu istekle ilgili en iyi uygulamalara bakın Docs API çağrılarınızı toplu hale getirme ve documents.batchUpdate referans belgelerden bahsedeceğiz.

Toplu güncelleme işlemleri

Çeşitli toplu güncelleme isteği türleri vardır. Aşağıda istek türleri şu şekilde gruplandırılır: kullanabilirsiniz.

Nesne EKLE / EKLE GÜNCELLE / DEĞİŞTİR SİL
Metin InsertTextRequest ReplaceAllTextRequest
Stiller CreateParagraphBulletsRequest UpdateTextStyleRequest
UpdateParagraphStyleRequest
UpdateTableCellStyleRequest
UpdateTableRowStyleRequest
UpdateDocumentStyleRequest
UpdateSectionStyleRequest
DeleteParagraphBulletsRequest
Adlandırılmış Aralıklar CreateNamedRangeRequest ReplaceNamedRangeContentRequest DeleteNamedRangeRequest
DeleteContentRangeRequest
Resimler InsertInlineImageRequest ReplaceImageRequest
Tablolar InsertTableRequest
InsertTableRowRequest
InsertTableColumnRequest
UpdateTableColumnPropertiesRequest
MergeTableCellsRequest
UnmergeTableCellsRequest
PinTableHeaderRowsRequest
DeleteTableRowRequest
DeleteTableColumnRequest
Sayfa nesneleri (üstbilgiler ve altbilgiler dahil) InsertPageBreakRequest
CreateHeaderRequest
CreateFooterRequest
CreateFootnoteRequest
InsertSectionBreakRequest
DeletePositionedObjectRequest
DeleteHeaderRequest
DeleteFooterRequest