Yorumları ve yanıtları yönetme

Yorumlar, kullanıcıların bir dosyayla ilgili geri bildirimleridir. Örneğin, bir kelime işlemci dokümanının okuyucusu, bir cümlenin nasıl yeniden ifade edileceğini önerebilir. İki tür yorum vardır: sabitlenmiş yorumlar ve sabitlenmemiş yorumlar. Sabitlenmiş yorumlar, bir dokümanın belirli bir sürümünde, kelime işlemci dokümanındaki bir cümle gibi belirli bir konumla ilişkilendirilir. Buna karşılık, sabitlenmemiş bir yorum yalnızca dokümanla ilişkilendirilir.

Yanıtlar, yorumlara eklenir ve kullanıcının yoruma verdiği cevabı gösterir. Drive API, kullanıcılarınızın uygulamanız tarafından oluşturulan dokümanlara yorum ve yanıt eklemesine olanak tanır. Yanıt içeren bir yorum, toplu olarak tartışma olarak bilinir.

comments kaynağındaki tüm yöntemler (delete hariç) için yanıtta döndürülecek alanları belirtmek üzere fields system parametresini ayarlamanız gerekir. Çoğu Drive yönteminde bu işlem yalnızca varsayılan olmayan alanları döndürmek için gereklidir ancak comments kaynağı için zorunludur. Parametreyi atlarsanız yöntem hata döndürür. Daha fazla bilgi için Belirli alanları döndürme başlıklı makaleyi inceleyin.

Sabitlenmemiş yorum ekleme

Bir dokümana sabitlenmemiş yorum eklemek için fileId parametresi ve yorumu içeren bir comments kaynağıyla create yöntemini çağırın.

Yorum düz metin olarak eklenir ancak yanıt gövdesinde, görüntüleme için biçimlendirilmiş içerik içeren bir htmlContent alanı bulunur.

Yoruma yanıt ekleme

Yoruma yanıt eklemek için fileId ve commentId parametreleriyle replies kaynağında replies.create yöntemini kullanın. İstek metni, yanıtı eklemek için content alanını kullanır.

Yanıt düz metin olarak eklenir ancak yanıt gövdesinde, görüntüleme için biçimlendirilmiş içeriklerin bulunduğu bir htmlContent alanı sağlanır.

Yöntem, fields alanında listelenen alanları döndürür.

İstek

Bu örnekte, fileId ve commentId yol parametreleri ile birden fazla alan sağlanmaktadır.

POST https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID/replies?fields=id,comment

İstek metni

{
  "content": "This is a reply to a comment."
}

Yorumu çözüldü olarak işaretleme

Yorumlar yalnızca yanıtlanarak çözüme kavuşturulabilir.

Bir yorumu çözmek için fileId ve commentId parametreleriyle replies kaynağında replies.create yöntemini kullanın.

İstek gövdesi, yorumu çözmek için action alanını kullanır. Ayrıca, content alanını, yorumu kapatan bir yanıt ekleyecek şekilde ayarlayabilirsiniz.

Bir yorum sonlandırıldığında Drive, yorum kaynağını resolved: true olarak işaretler. Silinen yorumların aksine, çözüldü olarak işaretlenen yorumlar htmlContent veya content alanlarını içerebilir.

Uygulamanız bir yorumu çözdüğünde kullanıcı arayüzünüz, yorumun ele alındığını belirtmelidir. Örneğin, uygulamanız:

  • Başka yanıt verilmesine izin vermeyin ve önceki tüm yanıtların yanı sıra ilk yorumu da soluklaştırın.
  • Sonlandırılan yorumları gizle'yi tıklayın.

İstek

Bu örnekte, fileId ve commentId yol parametreleri ile birden fazla alan sağlanmaktadır.

POST https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID/replies?fields=id,comment

İstek metni

{
  "action": "resolve",
  "content": "This comment has been resolved."
}

Dokümanın en son düzeltmesine sabitlenmiş yorum ekleme

Yorum eklediğinizde, yorumu dosyadaki bir bölgeye sabitlemek isteyebilirsiniz. Sabit nokta, bir yorumun atıfta bulunduğu dosyadaki dosya düzeltmesini ve bölgeyi tanımlar. comments kaynağı, anchor alanını JSON dizesi olarak tanımlar.

Sabitlenmiş yorum eklemek için:

  1. (İsteğe bağlı). Bir dokümandaki tüm revisionID öğelerini listelemek için revisions.list yöntemini çağırın. Bu adımı yalnızca bir yorumu en son düzeltme dışındaki bir düzeltmeye sabitlemek istiyorsanız uygulayın. En son düzeltmeyi kullanmak istiyorsanız revisionID için head kullanın.

  2. fileID parametresi, yorumu içeren bir comments kaynağı ve revisionID (r) ile bölgeyi (a) içeren bir JSON bağlantı dizesiyle create yöntemini çağırın.

Bir bölgeyi nasıl tanımladığınız, üzerinde çalıştığınız belge içeriğinin türüne bağlıdır. Daha fazla bilgi için Bölge tanımlama başlıklı makaleyi inceleyin.

Bölge tanımlama

Daha önce belirtildiği gibi, JSON bağlantı dizesi bir revisionID (r) ve bölge (a) içerir. Bölge (a), bir yorumun sabitlendiği biçimi ve konumu belirten bölge sınıflandırıcıları içeren bir JSON dizisidir. Sınıflandırıcı; resim için iki boyutlu bir dikdörtgen, belgedeki bir metin satırı veya videodaki bir süre olabilir. Bir bölgeyi tanımlamak için, sabitlemeye çalıştığınız içerik türüyle eşleşen bölge sınıflandırıcıyı seçin. Örneğin, içeriğiniz metin ise büyük olasılıkla txt veya line bölge sınıflandırıcısını kullanacaksınız.

Drive API'deki bölge sınıflandırıcılarının listesi için Bölge sınıflandırıcıları başlıklı makaleyi inceleyin.

Aşağıdaki örnekte, yorumları bir belgenin iki ayrı alanındaki satırlara sabitleyen bir JSON bağlantı dizesi gösterilmektedir:

  • İlk alan 12. satırda ('n':12) başlar ve üç satır boyunca ('l':3) devam eder.
  • İkinci alan yalnızca 18. satırı ('n':18, 'l':1`) kapsar.
    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

REVISION_ID yerine head veya belirli bir düzeltmenin kimliğini girin.

Yorum alma

Bir dosyayla ilgili yorum almak için get yöntemini fileId ve commentId parametreleriyle birlikte comments kaynağında kullanın. Yorum kimliğini bilmiyorsanız list yöntemini kullanarak tüm yorumları listeleyebilirsiniz.

Yöntem, comments kaynağının bir örneğini döndürür.

Silinen yorumları sonuçlara dahil etmek için includedDeleted sorgu parametresini true olarak ayarlayın.

İstek

Bu örnekte, fileId ve commentId yol parametreleri ile birden fazla alan sağlanmaktadır.

GET https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID?fields=id,comment,modifiedTime,resolved

Yorumları listeleme

Bir dosyadaki yorumları listelemek için list yöntemini comments kaynağında fileId parametresiyle kullanın. Yöntem, yorum listesi döndürür.

Yorumların sayfalandırmasını özelleştirmek veya yorumları filtrelemek için aşağıdaki sorgu parametrelerini iletin:

  • includeDeleted: Silinen yorumları dahil etmek için true olarak ayarlayın. Silinen yorumlar htmlContent veya content alanlarını içermez.

  • pageSize: Sayfa başına döndürülecek maksimum yorum sayısı.

  • pageToken: Önceki bir liste çağrısından alınan sayfa jetonu. Sonraki sayfayı almak için bu jetonu sağlayın.

  • startModifiedTime: Sonuç yorumları için modifiedTime alanının minimum değeri.

İstek

Bu örnekte, fileId yol parametresini, includeDeleted sorgu parametresini ve birden fazla alanı sağlıyoruz.

GET https://www.googleapis.com/drive/v3/files/FILE_ID/comments?includeDeleted=true&fields=(id,comment,kind,modifiedTime,resolved)

Yorumu güncelleme

Bir dosyayla ilgili yorumu güncellemek için fileId ve commentId parametreleriyle comments kaynağında update yöntemini kullanın. İstek gövdesinde, yorumu güncellemek için content alanı kullanılır.

comments kaynağındaki boolean resolved alanı salt okunurdur. Yorumlar yalnızca yoruma yanıt gönderilerek çözülebilir. Daha fazla bilgi için Yorumları yanıtlama başlıklı makaleyi inceleyin.

Yöntem, fields sorgu parametresinde listelenen alanları döndürür.

İstek

Bu örnekte, fileId ve commentId yol parametreleri ile birden fazla alan sağlanmaktadır.

PATCH https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID?fields=id,comment

İstek metni

{
  "content": "This comment is now updated."
}

Yorum silme

Bir dosyayla ilgili yorumu silmek için fileId ve commentId parametreleriyle comments kaynağında delete yöntemini kullanın.

Bir yorum silindiğinde Drive, yorum kaynağını deleted: true olarak işaretler. Silinen yorumlar htmlContent veya content alanlarını içermez.

İstek

Bu örnekte, fileId ve commentId yol parametreleri sağlanmaktadır.

DELETE https://www.googleapis.com/drive/v3/files/FILE_ID/comments/COMMENT_ID