Google Docs API'yi kullanırken uymanız gereken birkaç ilke vardır. Bunlardan bazıları:
- Verimlilik için geriye doğru düzenleyin
- Ortak çalışma için plan yapın
WriteControl
alanını kullanarak durum tutarlılığını sağlama
Aşağıdaki bölümlerde bu ilkeler açıklanmaktadır.
Verimlilik için geriye doğru düzenleyin
documents.batchUpdate
yöntemine yapılan tek bir çağrıda, isteklerinizi dizin konumuna göre azalan düzende sıralayın. Bu sayede, ekleme ve silme işlemleri nedeniyle dizin değişikliklerini hesaplama ihtiyacını ortadan kaldırır.
Ortak çalışma için plan yapın
Belge durumu değişebilir. Diğer ortak çalışanlar, bir yöntem çağrısı ile diğer bir yöntem arasında aşağıdaki şemada gösterildiği gibi belgeyi güncelleyebilir:
Dizinleriniz yanlışsa bu durum hatalara neden olabilir. Birden fazla kullanıcı, kullanıcı arayüzünü kullanarak bir dokümanı düzenlerken Google Dokümanlar bunu şeffaf bir şekilde halleder. Ancak API istemcisi olarak uygulamanızın bunu yönetmesi gerekir. Belgede ortak çalışma öngörmüyorsanız bile, savunmaya göre programlama yapmak ve belge durumunun tutarlı kalmasını sağlamak önemlidir. Tutarlılığı sağlamanın bir yolu için
WriteControl
bölümünü inceleyin.
WriteControl ile durum tutarlılığı oluşturma
Bir dokümanı okuyup daha sonra güncellediğinizde documents.batchUpdate
yöntemindeki WriteControl
alanını kullanarak rakip değişikliklerin nasıl işleneceğini kontrol edebilirsiniz. WriteControl
, yazma isteklerinin yürütülme şekli konusunda yetki sağlar.
Nasıl kullanacağınız aşağıda açıklanmıştır:
documents.get
yöntemini kullanarak belgeyi alın ve döndürülendocuments
kaynağındanrevisionId
değerini kaydedin.- Güncelleme isteklerinizi oluşturun.
- İki seçenekten birini kullanarak isteğe bağlı bir
WriteControl
nesnesi ekleyin:requiredRevisionId
alanı, yazma isteğinin uygulandığı dokümanınrevisionId
değerine ayarlanır. API okuma isteğinden sonra belge değiştirilirse yazma isteği işlenmez ve hata döndürür.targetRevisionId
alanı, yazma isteğinin uygulandığı belgeninrevisionId
değerine ayarlanır. API okuma isteğinden sonra belge değiştirildiyse yazma isteği değişiklikleri, ortak çalışan değişikliklerine uygulanır. Yazma isteğinin sonucu, hem yazma isteği değişikliklerini hem de ortak çalışan değişikliklerini dokümanın yeni bir düzeltmesini içerir. İçeriğin birleştirilmesinden Dokümanlar sunucusu sorumludur.
WriteControl
kullanarak toplu istek oluşturma örneği için bu toplu istek örneğine bakın.