Bu kılavuzda, Google Docs API'yi oluşturan birincil istek ve yanıt yöntemleri ve bir dokümanı toplu olarak nasıl güncelleyebileceğiniz açıklanmaktadır.
Google Docs API'yi bir HTTP isteği kullanarak veya dile özgü istemci kitaplığındaki bir yöntem çağrısını kullanarak çağırabilirsiniz. Bunlar genel olarak eşdeğerdir.
Google Docs API, genellikle istek çağrısının sonucunu içeren bir HTTP yanıtı döndürür. İstekte bulunmak için bir istemci kitaplığı kullanılırken yanıtlar dile özgü bir şekilde döndürülür.
İstek yöntemleri
Docs API aşağıdaki yöntemleri destekler:
documents.create: Boş bir Google Dokümanlar dokümanı oluşturun.documents.get: Belirtilen dokümanın eksiksiz bir örneğini döndürür. Döndürülen JSON dosyasını ayrıştırarak belge içeriğini, biçimlendirmeyi ve diğer özellikleri ayıklayabilirsiniz.documents.batchUpdate: Belgeye otomatik olarak uygulanacak düzenleme isteklerinin listesini gönderin ve sonuç listesini döndürün.
documents.get ve documents.batchUpdate yöntemleri, hedef belgeyi belirtmek için parametre olarak bir documentId gerektirir. documents.create yöntemi, oluşturulan dokümanın bir örneğini döndürür. Bu örnekten documentId dosyasını okuyabilirsiniz. documentId hakkında daha fazla bilgi için Belge Kimliği'ne bakın.
Toplu güncellemeler
documents.batchUpdate yöntemi, her biri gerçekleştirilecek tek bir isteği belirten request nesnelerinin bir listesini alır. Örneğin, bir paragrafı biçimlendirip
satır içi bir 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. Diğer bir deyişle, herhangi bir istek geçerli değilse güncellemenin tamamı başarısız olur ve (potansiyel olarak bağımlı) değişikliklerin hiçbiri uygulanmaz.
Bazı documents.batchUpdate yöntemleri, uygulanan istekler hakkında bilgi içeren yanıtlar sağlar. Bu yöntemler, response nesnelerinin listesini içeren bir yanıt gövdesi döndürür. Diğer isteklerin bilgi döndürmesi ve boş bir yanıt göstermesi gerekmez. Yanıt listesindeki nesneler, karşılık gelen istekle aynı dizin sırasını işler.
Toplu istek yapmaya ilişkin popüler bir kalıp şöyle görünür:
requests = []
requests.append(first request)
requests.append(second request)
...
body = ... & requests & ...
...batchUpdate(body)
Docs API çağrılarınızı gruplandırmayla ilgili tüm ayrıntıları öğrenmek için toplu istekle ilgili en iyi uygulamalara ve istek ile yanıt türleri için documents.batchUpdate referans belgelerine bakın.
Toplu güncelleme işlemleri
Çeşitli toplu güncelleme isteği türleri vardır. Farklı kategorilere göre gruplandırılmış istek türlerinin dökümünü burada bulabilirsiniz.