Doküman

Bu kılavuzda, doküman oluşturma ve doküman oluşturma iş akışı, Google Docs API uygulayacaksınız.

API yöntemleri

documents kaynağı, yöntemleri hakkında daha fazla bilgi edinin. Aşağıdaki yöntemler size Dokümanlar dokümanları oluşturma, okuma ve güncelleme:

  • documents.create'ı kullanma yöntemini kullanabilirsiniz.
  • documents.get yöntemini kullanma belirtilen bir dokümanın içeriğini almak için kullanılır.
  • documents.batchUpdate'ı kullanma belirli bir belgede bir dizi güncellemeyi atomik olarak gerçekleştirmek için kullanılan bir yöntemdir.

documents.get ve documents.batchUpdate yöntemleri için documentId gerekir parametre olarak kullanabilirsiniz. documents.create yöntemi oluşturulan dokümanın bir örneğini döndürür. Bu örnekte documentId. Docs API istekleri ve daha fazla bilgi için İstekler ve yanıt olarak gönderin.

Belge Kimliği

documentId, belgenin benzersiz tanımlayıcısıdır ve türetilebilir. bir doküman URL'sinden. Bu, harflerin, sayıların ve özel karakterlere yer verir. Doküman adı olsa bile doküman kimlikleri sabittir anlamına gelir.

https://docs.google.com/document/d/DOCUMENT_ID/edit

Aşağıdaki normal ifade, bir sunucudan documentId Google Dokümanlar URL'si:

/document/d/([a-zA-Z0-9-_]+)

Google Drive API'si hakkında bilgi sahibiyseniz documentId, id değerine karşılık gelir. files kaynağında bulabilirsiniz.

Dokümanları Google Drive'da yönetin

Dokümanlar dosyaları, bulut tabanlı depolama alanımız olan Google Drive'da depolanır geliştirmenizi sağlar. Docs API kendi bağımsız yöntemlerine sahip olsa da, Ayrıca, Google Drive API yöntemlerini kullanmak için Dokümanlar dosyaları. Örneğin, Dokümanlar dosyalarını kopyalamak için Drive API'nin files.copy yöntemidir. Daha fazla bilgi için bkz. Mevcut bir dokümanı'nı seçin.

Dokümanlar API'si kullanılırken varsayılan olarak kullanıcının Drive'daki kök klasörü. Dosya kaydetme seçenekleri mevcuttur bir Google Drive klasörüne kopyalayın. Daha fazla bilgi için bkz. Google Drive klasörleri'ne dokunun.

Dokümanlar dosyalarıyla çalışma

Bir kullanıcının Drive'ım bölümündeki bir dokümanı almak için genellikle önce Drive'ın files.list yöntemini kullanma dosyanın kimliği. Yöntemin herhangi bir parametre olmadan çağrılması durumunda, kimlikler de dahil olmak üzere dosya ve klasörlere erişim sağlar.

Bir dokümanın MIME türü, veri türünü ve biçimini belirtir. MIME türü biçimi Dokümanlar için application/vnd.google-apps.document. Şunlar için: MIME türleri, Google Workspace ve Google Drive destekli MIME" başlıklı makaleyi inceleyin türler olarak tanımlar.

MIME türüne göre arama yapmak için aşağıdaki sorgu dizesi filtresini ekleyin:

q: mimeType = 'application/vnd.google-apps.document'

Sorgu dizesi filtreleri hakkında daha fazla bilgi için bkz. Dosya arama ve klasörleri tıklayın.

documentId hakkında bilgi edindikten sonra documents.get alma yöntemi belirtilen dokümanın tam bir örneği. Daha fazla bilgi için bkz. İstekler ve yanıtlar.

Google Workspace doküman bayt içeriğini dışa aktarmak için Drive'ın files.export yöntemini kullanarak Dışa aktarılacak dosyanın documentId ve doğru dışa aktarma MIME girin. Daha fazla bilgi için Dışa aktarma Google Workspace dokümanı içerik.

Get ve List yöntemlerini karşılaştırın

Aşağıdaki tabloda, Drive ile ve her biriyle döndürülen veriler:

Operatör Açıklama Kullanım
drive.files.get Bir dosyanın meta verilerini kimliğe göre alır. files kaynağının bir örneğini döndürür. Belirli bir dosya için meta verileri alma.
drive.files.list Kullanıcının dosyalarını alır. Bir dosya listesi döndürür. Hangi dosyayı değiştirmeniz gerektiğinden emin değilseniz kullanıcı dosyalarının listesini alabilirsiniz.
docs.documents.get Tüm biçimlendirme ve metin de dahil olmak üzere, belirtilen dokümanın en son sürümünü alır. documents kaynağının bir örneğini döndürür. Belirli bir doküman kimliğine ait dokümanı alın.

Doküman oluşturma iş akışı

Herhangi bir doküman olmadığından, yeni bir doküman oluşturmak ve ve içeriği değiştirebilecek ortak çalışanların olmaması, dokümanın durumunu kontrol edin. Kavramsal olarak bu, aşağıdaki sırayla gösterildiği gibi çalışır diyagram:

İş akışı oluşturma yeni bir doküman oluşturabilirsiniz.
Şekil 1. Yeni bir doküman oluşturup doldurmak için iş akışı.

Şekil 1.'de, ilk birkaç adımı olan documents kaynağında şunlar bulunur: bilgi akışı:

  1. Bir uygulama documents.create yöntemi açık daha iyi olur.
  2. Web sunucusu, doküman, documents kaynağı olarak oluşturuldu.
  3. İsteğe bağlı olarak, uygulama documents.batchUpdate öğesini çağırır. dokümanı doldurmak için bir dizi düzenleme isteğini atomik olarak gerçekleştirme yöntemi verileri temel alabilir.
  4. Web sunucusu, HTTP yanıtı gönderir. Bazı documents.batchUpdate yöntemleri uygulanan talepler hakkında bilgi içeren bir yanıt gövdesinde, diğerleri boş bir yanıt gösterir.

Doküman güncelleme iş akışı

Mevcut bir dokümanı güncellemek daha karmaşık bir iştir. Bir anlamlı sunum yapmadan önce çağrısı yapıldığında, dokümanın mevcut durumunu ve hangi öğelerin bu öğelerde hangi içeriğin olduğunu ve bunların içindeki öğelerin sıralamasını kontrol edebilirsiniz. Aşağıdaki dizi şemasında bunun nasıl çalıştığı gösterilmektedir:

iş akışı uygulayacaksınız.
Şekil 2. Doküman güncelleme iş akışı.

Şekil 2.'de, documents kaynağıyla etkileşime giren bir kullanıcı aşağıdaki bilgi akışı hakkında:

  1. Bir uygulama Web'de documents.get yöntemi documentId dosyayı içerir.
  2. Web sunucusu, belirtilen doküman, documents kaynağı olarak belirtilmiştir. Döndürülen JSON, doküman içeriği, biçimlendirme ve diğer özellikler.
  3. Uygulama, kullanıcının hangi içeriği veya biçimi kullanacağını belirleyebilmesi için JSON dosyasını ayrıştırır. güncelleyin.
  4. Uygulama, bir grup işlemi atomik olarak gerçekleştirmek için documents.batchUpdate yöntemini çağırır sayısı.
  5. Web sunucusu, HTTP yanıtı gönderir. Bazı documents.batchUpdate yöntemleri uygulanan talepler hakkında bilgi içeren bir yanıt gövdesinde, diğerleri boş bir yanıt gösterir.

Bu diyagramda, diğer yayıncılar tarafından eşzamanlı olarak güncellenen aynı doküman üzerinde ortak çalışan oluşturulduğu için emin olun. Daha fazla bilgi için Planlama: ortak çalışma.