En iyi sonuçlar için en iyi uygulamalar

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
  • Sekmeleri dikkate alın

Aşağıdaki bölümlerde bu ilkeler açıklanmaktadır.

Verimlilik için geriye doğru düzenleyin

Tek bir çağrıda: documents.batchUpdate yöntemini kullanıyorsanız, isteklerinizi azalan düzende dizin. Böylece, kolay bir şekilde dizine ekleme ve silme işlemlerinden kaynaklanan dizin değişiklikleridir.

Ortak çalışma için plan yapın

Belge durumu değişebilir. Bir yöntem çağrısı ile diğeri arasında ortak çalışanlar aşağıdaki şemada gösterildiği gibi dokümanı güncelleyebilir:

Bir dokümanın yöntem çağrıları arasında nasıl geçiş yapabileceği.

Dizinleriniz yanlışsa bu durum hatalara neden olabilir. Birden fazla kullanıcı bir web sitesini Google Dokümanlar bunu şeffaf bir şekilde halleder. Ancak, API istemcisi olarak uygulamanız bunu yönetmelidir. Projenin başında üzerinde iş birliği yaptığınız takdirde, savunmaya dayalı bir program yapmanız ve ve belge durumunun tutarlı kalmasını sağlar. Tutarlılığı sağlamanın bir yolu olarak, WriteControl bölümünü inceleyin.

WriteControl ile durum tutarlılığı oluşturma

Bir dokümanı okuyup güncellediğinizde, dokümanınızın rekabet eden değişiklikler WriteControl alanına documents.batchUpdate yöntemindeki değer girilmelidir. WriteControl yetki sağlıyor daha hızlı yürütülür.

Nasıl kullanacağınız aşağıda açıklanmıştır:

  1. Şunu kullanarak belgeyi alın: documents.get yöntemini kullanarak "the" revisionId döndürülen documents kaynaktan.
  2. Güncelleme isteklerinizi oluşturun.
  3. İsteğe bağlı bir WriteControl ekleyin nesnesini tanımlayın:
    1. requiredRevisionId alanı,revisionId hangi belgeye ihtiyacınız olduğuna bir bakalım. Doküman değiştirilmişse olduğundan, yazma isteği işlenmez ve hata döndürür.
    2. targetRevisionId alanı, dokümanın revisionId değerine ayarlandı kararlaştırılır. Doküman, yazma isteği değişiklikleri, ortak çalışan değişiklikleri. Yazma isteğinin sonucu, ortak çalışan yeni bir kontrol edebilirsiniz. Dokümanlar sunucusu, içerik birleştiriyor.

WriteControl kullanarak toplu istek oluşturma örneği için bu toplu istek örneğini inceleyin.

Sekmeleri dikkate alın

Tek bir dokümanda birden fazla sekme olabilir. API isteklerinizin özel olarak ele alınmasını gerektirir.

Unutmamanız gerekenler:

  1. includeTabsContent parametresinitrue documents.get yöntemini kullanarak bir dokümandaki tüm sekmelerden içerik alma. Varsayılan olarak tüm sekmeleri emin olabilirsiniz.
  2. Her bir Request öğesinin uygulanacağı sekmelerin kimliklerini belirtin documents.batchUpdate içinde yöntemidir. Her bir Request güncellemenin uygulanacağı sekmeleri belirtmenin bir yolunu içerir. Varsayılan olarak sekmesi belirtilmemişse Request çoğu durumda dokümandaki ilk sekmeye uygulanır. Daha fazla bilgi için Request sn. dokümanlarına göz atabilirsiniz.