Bu kılavuzda, Google Docs API'yi oluşturan birincil istek ve yanıt yöntemleri ile bir dokümanı toplu olarak nasıl güncelleyebileceğiniz açıklanmaktadır.
Google Dokümanlar API'sini bir HTTP isteği veya dile özgü istemci kitaplığında bir yöntem çağrısı 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. İstek göndermek için bir istemci kitaplığı kullanıldığında, 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 belgenin eksiksiz bir örneğini döndürür. Belge içeriğini, biçimlendirmeyi ve diğer özellikleri çıkarmak için döndürülen JSON dosyasını ayrıştırabilirsiniz.documents.batchUpdate: Dokümana atomik olarak uygulanacak düzenleme isteklerinin listesini gönderin ve sonuç listesi döndürün.
documents.get ve documents.batchUpdate yöntemleri, hedef belgeyi belirtmek için parametre olarak documentId gerektirir. documents.create yöntemi, oluşturulan belgenin bir örneğini döndürür. Bu örnekten documentId öğesini okuyabilirsiniz. documentId hakkında daha fazla bilgi için Belge Kimliği'ne göz atın.
Toplu güncellemeler
documents.batchUpdate yöntemi, her biri tek bir gerçekleştirilecek isteği belirten request nesnelerinin bir listesini alır. Örneğin, bir paragrafı biçimlendirin ve ardından
satır içi resim ekleyin. Her istek uygulanmadan önce doğrulanır ve 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, geçerli olmayan bir istek varsa 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ına sahip olur.
Toplu isteklerde kullanılan 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 için toplu istek en iyi uygulamalarına, istek ve yanıt türleri için de documents.batchUpdate referans belgelerine göz atın.
Toplu güncelleme işlemleri
Çeşitli türlerde toplu güncelleme istekleri vardır. Aşağıda, farklı kategorilerde gruplandırılmış istek türlerinin bir dökümü verilmiştir.