Google Dokümanlar API'sı, dokümanlar oluşturmanıza ve mevcut dokümanlarda değişiklik yapmanıza olanak tanır.
Uygulamalar, Docs API ile entegre olarak hem kullanıcı hem de sistem tarafından sağlanan verilerden gösterişli dokümanlar oluşturabilir. API şunları yapmanıza olanak tanır:
- Süreçleri otomatikleştirin
- Dokümanları toplu olarak oluşturma
- Fatura veya sözleşme oluşturma
API'ye Genel Bakış
documents kaynağı, Docs API'yi çağırmak için kullandığınız yöntemleri sağlar.
API yöntemleri
Aşağıdaki yöntemler Google Dokümanlar dokümanları oluşturmanıza, okumanıza ve güncellemenize olanak tanır:
- Doküman oluşturmak için documents.create dosyasını kullanın.
- Belirtilen dokümanın içeriğini almak için documents.get dosyasını kullanın.
- Belirtilen bir dokümanda otomatik olarak bir dizi güncelleme gerçekleştirmek için documents.batchUpdate kullanın.
get ve batchUpdate yöntemleri, hedef dokümanı belirtmek için parametre olarak bir documentId (aşağıya bakın) kullanılmasını gerektirir. create yöntemi, oluşturulan dokümanın kimliği okuyabileceğiniz bir örneğini döndürür.
Toplu güncellemeler
batchUpdate yöntemi, istek nesnelerinin bir listesini alır ve güncellemeleri toplu istekte göründükleri sıraya göre yapar. Toplu güncellemedeki güncellemeler ana makineye göre uygulanır. Yani herhangi bir istek geçerli değilse tüm güncelleme başarısız olur ve (muhtemelen bağımlı olan) değişikliklerin hiçbiri uygulanmaz.
batchUpdate yöntemi, yanıt nesnelerinin bir listesini döndürür. Bu listedeki nesneler, karşılık gelen istekle aynı dizin sıralamasını kullanır.
API çağrılarını toplu hale getirme hakkında bilgi edinmek için toplu istek en iyi uygulamalarına ve istek ile yanıt türleriyle ilgili batchUpdate referans belgelerine bakın.
Belge Kimliği
Doküman kimlikleri bir dokümana referans verir ve URL'den türetilebilir:
https://docs.google.com/document/d/documentId/edit
documentId; harfler, sayılar ve bazı özel karakterleri içeren benzersiz bir dizedir. Aşağıdaki normal ifade, doküman kimliğini Google Dokümanlar URL'sinden çıkarmak için kullanılabilir:
/document/d/([a-zA-Z0-9-_]+)
Google Drive API'ye aşinaysanız documentId, Dosya kaynağının kimliğine karşılık gelir.
Doküman içindeki konumlar: dizinler
Bir dokümanın içeriğinde güncelleme yaptığınızda, her güncelleme belge içindeki bir konumda veya bir aralık genelinde gerçekleşir. Bu konumlar ve aralıklar, içeren doküman segmenti içindeki ofseti temsil eden dizinler kullanılarak belirtilir. Dizinler ve nasıl kullanılacağı hakkında daha fazla bilgi edinmek için Google Dokümanlar dokümanının yapısı kavram kılavuzuna bakın.
Doküman güncelleme iş akışı
Endişelenecek mevcut içerik ve belge durumunu değiştirebilecek ortak çalışan olmadığından yeni bir doküman oluşturmak ve doldurmak kolaydır. Kavramsal olarak bu, aşağıdaki dizi diyagramında gösterildiği gibi çalışır:
Mevcut dokümanları güncellemek daha karmaşık bir işlemdir. Bir dokümanı güncellemek için anlamlı çağrılar yapmadan önce belgenin mevcut durumunu bilmeniz gerekir. Bunlar arasında, hangi öğelerin yer aldığı, bu öğelerde hangi içeriklerin yer aldığı ve tüm bu öğelerin dokümanın içinde nerede bulunduğunu bilmeniz gerekir. Aşağıdaki sıra diyagramında bunun nasıl işlediği gösterilmektedir:
Bu şema, aynı dokümanda diğer ortak çalışanların eşzamanlı güncellemelerinin yapıldığı iş akışlarını dikkate almaz. Bu konuyu ele almak için Ortak çalışma planlama bölümüne bakın.