Mengelola komentar dan balasan

Komentar adalah masukan yang diberikan pengguna tentang file, seperti pembaca dokumen pengolah kata yang menyarankan cara menyusun ulang kalimat. Ada dua jenis komentar: komentar anchor dan komentar tanpa anchor. Komentar anchor dikaitkan dengan lokasi tertentu, seperti kalimat dalam dokumen pemrosesan kata, dalam versi dokumen tertentu. Sebaliknya, komentar tanpa anchor hanya dikaitkan dengan dokumen.

Balasan dilampirkan pada komentar dan mewakili respons pengguna terhadap komentar. Dengan Google Drive API, pengguna dapat menambahkan komentar dan balasan ke dokumen yang dibuat oleh aplikasi Anda. Secara kolektif, komentar dengan balasan disebut sebagai diskusi.

Menambahkan komentar tanpa anchor

Untuk menambahkan komentar tanpa anchor ke dokumen, panggil metode comments.create dengan parameter fileId dan resource comments yang berisi komentar.

Komentar disisipkan sebagai teks biasa, tetapi isi respons menyediakan kolom htmlContent yang berisi konten yang diformat untuk ditampilkan.

Menambahkan balasan ke komentar

Untuk menambahkan balasan atas komentar, panggil metode replies.create dengan komentar, parameter fileId, dan resource reply yang berisi balasan.

Balasan disisipkan sebagai teks biasa, tetapi isi respons menyediakan kolom htmlContent yang berisi konten yang diformat untuk ditampilkan.

Menambahkan komentar anchor ke revisi terbaru dokumen

Saat menambahkan komentar, Anda mungkin ingin menambatkannya ke region dalam file. Anchor menentukan revisi file dan region dalam file yang dirujuk oleh komentar. Resource comments menentukan kolom anchor sebagai string JSON.

Untuk menambahkan komentar anchor:

  1. (Opsional). Panggil metode revisions.list untuk mencantumkan setiap revisionID untuk dokumen. Hanya ikuti langkah ini jika Anda ingin menambatkan komentar ke revisi apa pun selain revisi terbaru. Jika Anda ingin menggunakan revisi terbaru, gunakan head untuk revisionID.

  2. Panggil metode comments.create dengan parameter fileID, resource comments yang berisi komentar, dan string anchor JSON yang berisi revisionID (r) dan region (a).

Cara Anda menentukan region bergantung pada jenis konten dokumen yang sedang Anda kerjakan. Untuk mengetahui informasi selengkapnya, lihat Menentukan wilayah di bawah.

Tentukan wilayah

Seperti yang disebutkan sebelumnya, string anchor JSON berisi revisionID (r) dan region (a). Region (a) adalah array JSON yang berisi pengklasifikasi wilayah yang menentukan format dan lokasi penambatan komentar. Pengklasifikasi mungkin berupa persegi panjang dua dimensi untuk gambar, baris teks dalam dokumen, durasi waktu dalam video, dan sebagainya. Untuk menentukan wilayah, pilih pengklasifikasi wilayah yang cocok dengan jenis konten yang Anda coba anchor. Misalnya, jika konten Anda adalah teks, Anda kemungkinan akan menggunakan pengklasifikasi wilayah txt atau line.

Untuk mengetahui daftar pengklasifikasi wilayah dalam Drive API, lihat Pengklasifikasi wilayah.

Contoh berikut menunjukkan string anchor JSON yang menambatkan komentar ke baris di 2 area dokumen yang terpisah:

  • Area pertama dimulai pada baris 12 ('n':12) dan diperluas selama tiga garis ('l':3).
  • Area kedua hanya mencakup baris 18 ('n':18, 'l':1`).
    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

Mengganti REVISION_ID dengan head atau ID revisi tertentu.

Menyelesaikan komentar

Gunakan metode comment.update untuk menyetel properti resolved di resource comments ke true saat komentar telah ditangani.

Saat aplikasi Anda menetapkan properti resolved ke true, UI Anda harus menunjukkan bahwa komentar telah ditangani. Misalnya, aplikasi Anda mungkin:

  • Jangan izinkan balasan lebih lanjut dan redupkan semua balasan sebelumnya serta komentar awal.
  • Sembunyikan komentar yang telah diselesaikan.

Menghapus komentar

Gunakan metode comments.delete untuk menghapus komentar. Saat komentar dihapus, Drive akan menandai resource komentar sebagai "deleted": "true".

Membuat daftar komentar

Gunakan metode comments.list untuk mencantumkan komentar. Jika ingin menyertakan komentar yang dihapus dalam hasil, tetapkan kolom includedDeleted ke true.