จัดการความคิดเห็นและการตอบกลับ

ความคิดเห็นคือความคิดเห็นที่ผู้ใช้ให้ไว้ในไฟล์ เช่น ผู้อ่านเอกสารประมวลผลคำที่แนะนำวิธีเปลี่ยนรูปแบบประโยค ความคิดเห็นมี 2 ประเภท ได้แก่ ความคิดเห็นที่มีจุดยึดและความคิดเห็นที่ไม่มีจุดยึด ความคิดเห็นที่ยึดตำแหน่งจะเชื่อมโยงกับตำแหน่งที่เฉพาะเจาะจง เช่น ประโยคในเอกสารประมวลผลคำ ภายในเอกสารเวอร์ชันที่เฉพาะเจาะจง ในทางกลับกัน ความคิดเห็นที่ไม่ได้ยึดจะเชื่อมโยงกับเอกสารเท่านั้น

การตอบกลับจะแนบอยู่กับความคิดเห็นและแสดงการตอบกลับของผู้ใช้ต่อความคิดเห็น Drive API ช่วยให้ผู้ใช้เพิ่มความคิดเห็นและการตอบกลับในเอกสารที่แอปของคุณสร้างขึ้นได้ โดยความคิดเห็นที่มีการตอบกลับจะเรียกว่าการสนทนา

เพิ่มความคิดเห็นที่ไม่ได้ยึด

หากต้องการเพิ่มความคิดเห็นที่ไม่ได้ยึดกับส่วนใดส่วนหนึ่งของเอกสารลงในเอกสาร ให้เรียกใช้เมธอด comments.create ที่มีพารามิเตอร์ fileId และทรัพยากร comments ที่มีความคิดเห็น

ระบบจะแทรกความคิดเห็นเป็นข้อความธรรมดา แต่เนื้อหาของคำตอบจะมีช่องhtmlContentที่มีเนื้อหาที่จัดรูปแบบเพื่อแสดง

เพิ่มการตอบกลับความคิดเห็น

หากต้องการเพิ่มการตอบกลับความคิดเห็น ให้เรียกใช้เมธอด replies.create พร้อมพารามิเตอร์ความคิดเห็น fileId และทรัพยากร replies ที่มีคำตอบ

ระบบจะแทรกการตอบกลับเป็นข้อความธรรมดา แต่เนื้อหาของคำตอบจะมีฟิลด์ htmlContent ที่มีเนื้อหาที่จัดรูปแบบเพื่อแสดง

เพิ่มความคิดเห็นที่ปักหมุดไว้ในการแก้ไขล่าสุดของเอกสาร

เมื่อเพิ่มความคิดเห็น คุณอาจต้องการยึดความคิดเห็นนั้นไว้กับส่วนในไฟล์ หมุดจะกำหนดการแก้ไขและส่วนในไฟล์ที่ความคิดเห็นอ้างอิง ทรัพยากร comments จะกำหนดช่อง anchor เป็นสตริง JSON

วิธีเพิ่มความคิดเห็นที่ปักหมุดไว้

  1. (ไม่บังคับ) เรียกใช้เมธอด revisions.list เพื่อแสดงรายการ revisionID ทั้งหมดของเอกสาร ทำตามขั้นตอนนี้เฉพาะในกรณีที่ต้องการปักหมุดความคิดเห็นไว้กับเวอร์ชันที่ไม่ใช่เวอร์ชันล่าสุด หากต้องการใช้การแก้ไขล่าสุด ให้ใช้ head สำหรับ revisionID

  2. เรียกใช้เมธอด comments.create ด้วยพารามิเตอร์ fileID, แหล่งข้อมูล comments ที่มีความคิดเห็น และสตริงแอตทริบิวต์ JSON ที่มี revisionID (r) และภูมิภาค (a)

วิธีกำหนดภูมิภาคจะขึ้นอยู่กับประเภทเนื้อหาเอกสารที่คุณกำลังดำเนินการ ดูข้อมูลเพิ่มเติมได้ที่กำหนดภูมิภาค

กําหนดภูมิภาค

ดังที่ได้กล่าวไว้ก่อนหน้านี้ สตริงแอตทริบิวต์ของ JSON จะมี revisionID (r) และภูมิภาค (a) โดยภูมิภาค (a) คืออาร์เรย์ JSON ที่มีตัวจัดประเภทภูมิภาคซึ่งระบุรูปแบบและตำแหน่งที่จะปักหมุดความคิดเห็น ตัวจัดหมวดหมู่อาจเป็นสี่เหลี่ยมจัตุรัส 2 มิติสําหรับรูปภาพ บรรทัดข้อความในเอกสาร หรือระยะเวลาในวิดีโอ หากต้องการกําหนดภูมิภาค ให้เลือกตัวจัดหมวดหมู่ภูมิภาคที่ตรงกับประเภทเนื้อหาที่คุณต้องการยึด ตัวอย่างเช่น หากเนื้อหาเป็นข้อความ คุณอาจใช้ตัวแยกประเภทภูมิภาค txt หรือ line

ดูรายการตัวแยกประเภทภูมิภาคใน Drive API ได้ที่ตัวแยกประเภทภูมิภาค

ตัวอย่างต่อไปนี้แสดงสตริงแอตทริบิวต์ JSON ที่ยึดความคิดเห็นกับบรรทัดใน 2 ส่วนแยกกันของเอกสาร

  • พื้นที่แรกเริ่มต้นที่บรรทัด 12 ('n':12) และขยายไป 3 บรรทัด ('l':3)
  • ส่วนพื้นที่ที่ 2 จะครอบคลุมเฉพาะบรรทัดที่ 18 ('n':18, 'l':1`)
    {
      'r': 'REVISION_ID',
      'a': [
      {
        'line':
        {
          'n': 12,
          'l': 3,
        }
      },
      {
        'line':
        {
          'n': 18,
          'l': 1,
        }
      }]
    }

แทนที่ REVISION_ID ด้วย head หรือรหัสของเวอร์ชันที่เฉพาะเจาะจง

แก้ปัญหาความคิดเห็น

ใช้เมธอด comment.update เพื่อตั้งค่าพร็อพเพอร์ตี้ resolved ในทรัพยากร comments เป็น true เมื่อจัดการความคิดเห็นแล้ว

เมื่อแอปตั้งค่าพร็อพเพอร์ตี้ resolved เป็น true แล้ว UI ควรระบุว่าความคิดเห็นได้รับการแก้ไขแล้ว ตัวอย่างเช่น แอปอาจมีลักษณะดังนี้

  • ไม่อนุญาตให้ตอบกลับเพิ่มเติมและทำให้การตอบกลับก่อนหน้าทั้งหมดรวมถึงความคิดเห็นต้นฉบับจางลง
  • ซ่อนความคิดเห็นที่แก้ไขแล้ว

ลบความคิดเห็น

ใช้เมธอด comments.delete เพื่อลบความคิดเห็น เมื่อลบความคิดเห็น ไดรฟ์จะทำเครื่องหมายแหล่งข้อมูลความคิดเห็นเป็น "deleted": "true"

แสดงรายการความคิดเห็น

ใช้เมธอด comments.list เพื่อแสดงความคิดเห็น หากต้องการรวมความคิดเห็นที่ลบไปแล้วไว้ในผลการค้นหา ให้ตั้งค่าช่อง includedDeleted เป็น true