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

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

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

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

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

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

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

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

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

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

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

ในการเพิ่มความคิดเห็นที่ตรึงไว้ ให้ทำดังนี้

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

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

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

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

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

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

ตัวอย่างต่อไปนี้แสดงสตริง Anchor ของ 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