หน้านี้ได้รับการแปลโดย Cloud Translation API

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

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

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

สำหรับทุกเมธอด (ยกเว้น delete) ในทรัพยากร comments คุณต้องตั้งค่าfields พารามิเตอร์ ระบบเป็น เพื่อระบุช่องที่จะแสดงผลในการตอบกลับ ในเมธอดของไดรฟ์ส่วนใหญ่ การดำเนินการนี้จำเป็นต่อการแสดงฟิลด์ที่ไม่ใช่ค่าเริ่มต้นเท่านั้น แต่ก็เป็นข้อบังคับสำหรับทรัพยากร comments หากคุณละเว้นพารามิเตอร์นี้ เมธอดจะ แสดงข้อผิดพลาด ดูข้อมูลเพิ่มเติมได้ที่แสดงผลฟิลด์ที่เฉพาะเจาะจง

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

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

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

สำคัญ: เราขอแนะนำให้คุณตรวจสอบว่าผู้ใช้มีสิทธิ์ที่ถูกต้องในการเพิ่มความคิดเห็น นอกจากนี้ มีเพียงครีเอเตอร์ของความคิดเห็นหรือคำตอบเท่านั้นที่ลบหรือแก้ไขความคิดเห็นหรือคำตอบได้ ข้อผิดพลาดจะเกิดขึ้นเมื่อผู้ใช้ที่มีบทบาทที่ไม่ใช่ครีเอเตอร์พยายาม ลบหรือแก้ไขความคิดเห็น หากต้องการหลีกเลี่ยงข้อผิดพลาดเหล่านี้ ให้ตรวจสอบฟิลด์ author.me ของ ทรัพยากร comments เพื่อให้แน่ใจว่าผู้ใช้ ที่ส่งคำขอเป็นผู้เขียนความคิดเห็น แล้วยืนยัน สิทธิ์ของผู้ใช้ที่เกี่ยวข้องกับความคิดเห็น

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

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

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

เมธอดจะแสดงผลช่องที่ระบุไว้ในช่อง fields

คำขอ

ในตัวอย่างนี้ เราจะระบุพารามิเตอร์เส้นทาง fileId และ commentId รวมถึงฟิลด์หลายรายการ

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

เนื้อความของคำขอ

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

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

คุณจะแก้ไขความคิดเห็นได้โดยการโพสต์คำตอบของความคิดเห็นเท่านั้น

หากต้องการแก้ไขความคิดเห็น ให้ใช้วิธีการ replies.create ในแหล่งข้อมูล replies โดยใช้พารามิเตอร์ fileId และ commentId

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

เมื่อมีการแก้ไขความคิดเห็น ไดรฟ์จะทำเครื่องหมายทรัพยากรความคิดเห็นเป็น resolved: true ความคิดเห็นที่แก้ไขแล้วจะรวมฟิลด์ htmlContent หรือ content ได้ ซึ่งแตกต่างจากความคิดเห็นที่ถูกลบ

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

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

คำขอ

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

เนื้อความของคำขอ

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

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

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

วิธีเพิ่มความคิดเห็นที่ยึดตำแหน่ง

(ไม่บังคับ) เรียกใช้เมธอด revisions.list เพื่อแสดงรายการ revisionID ทั้งหมดสำหรับเอกสาร ทำตามขั้นตอนนี้เฉพาะในกรณีที่ คุณต้องการยึดความคิดเห็นไว้กับฉบับแก้ไขอื่นที่ไม่ใช่ฉบับแก้ไขล่าสุด หากต้องการใช้การแก้ไขล่าสุด ให้ใช้ head สำหรับ revisionID
เรียกใช้เมธอด create ด้วยพารามิเตอร์ fileID ซึ่งเป็นทรัพยากร comments ที่มีความคิดเห็น และสตริง Anchor JSON ที่มี revisionID (r) และภูมิภาค (a)

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

หมายเหตุ: เราขอแนะนำให้ตรวจสอบว่าผู้ใช้มีสิทธิ์ที่ถูกต้องในการเพิ่มความคิดเห็น นอกจากนี้ มีเพียงครีเอเตอร์ของความคิดเห็นหรือคำตอบเท่านั้นที่ลบหรือแก้ไขความคิดเห็นหรือคำตอบได้ ข้อผิดพลาดจะเกิดขึ้นเมื่อบุคคลที่มีบทบาทที่ไม่ใช่ครีเอเตอร์พยายาม ลบหรือแก้ไขความคิดเห็น หากต้องการหลีกเลี่ยงข้อผิดพลาดเหล่านี้ ให้ตรวจสอบฟิลด์ author.me ของ แหล่งข้อมูลความคิดเห็น

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

ดังที่กล่าวไว้ก่อนหน้านี้ สตริง Anchor 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 หรือรหัสของการแก้ไข ที่เฉพาะเจาะจง

รับความคิดเห็น

หากต้องการแสดงความคิดเห็นในไฟล์ ให้ใช้เมธอด get ในแหล่งข้อมูล comments โดยมีพารามิเตอร์ fileId และ commentId หากไม่ทราบรหัสความคิดเห็น คุณสามารถแสดงรายการความคิดเห็นทั้งหมดโดยใช้วิธี list

เมธอดจะแสดงอินสแตนซ์ของทรัพยากร comments

หากต้องการรวมความคิดเห็นที่ถูกลบไปแล้วไว้ในผลลัพธ์ ให้ตั้งค่าพารามิเตอร์includedDeletedการค้นหา เป็น true

คำขอ

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

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

หากต้องการแสดงความคิดเห็นในไฟล์ ให้ใช้เมธอด list ในแหล่งข้อมูล comments โดยมีพารามิเตอร์ fileId เมธอดจะแสดงผลรายการความคิดเห็น

ส่งพารามิเตอร์การค้นหาต่อไปนี้เพื่อปรับแต่งการแบ่งหน้าหรือกรอง ความคิดเห็น

includeDeleted: ตั้งค่าเป็น true เพื่อรวมความคิดเห็นที่ถูกลบ ความคิดเห็นที่ถูกลบจะไม่มีช่อง htmlContent หรือ content
pageSize: จำนวนความคิดเห็นสูงสุดที่จะแสดงต่อหน้า
pageToken: โทเค็นหน้าเว็บที่ได้รับจากการเรียก list ก่อนหน้า ระบุโทเค็นนี้ เพื่อดึงข้อมูลหน้าถัดไป
startModifiedTime: ค่าต่ำสุดของฟิลด์ modifiedTime สำหรับ ความคิดเห็นในผลการค้นหา

คำขอ

ในตัวอย่างนี้ เราจะระบุพารามิเตอร์เส้นทาง fileId พารามิเตอร์การค้นหา includeDeleted และฟิลด์หลายรายการ

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

อัปเดตความคิดเห็น

หากต้องการอัปเดตความคิดเห็นในไฟล์ ให้ใช้เมธอด update ในแหล่งข้อมูล comments โดยใช้พารามิเตอร์ fileId และ commentId เนื้อหาของคำขอใช้ฟิลด์ content เพื่ออัปเดตความคิดเห็น

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

เมธอดจะแสดงผลช่องที่ระบุไว้ในพารามิเตอร์การค้นหา fields

คำขอ

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

เนื้อความของคำขอ

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

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

หากต้องการลบความคิดเห็นในไฟล์ ให้ใช้วิธีการ delete ในแหล่งข้อมูล comments โดยใช้พารามิเตอร์ fileId และ commentId

เมื่อลบความคิดเห็น ไดรฟ์จะทำเครื่องหมายทรัพยากรความคิดเห็นเป็น deleted: true ความคิดเห็นที่ถูกลบจะไม่มีฟิลด์ htmlContent หรือ content

คำขอ

ในตัวอย่างนี้ เราจะระบุพารามิเตอร์เส้นทาง fileId และ commentId

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