ניהול התגובות והתשובות

תגובות הן משוב שמשתמשים מספקים לגבי קובץ, למשל, קורא של מסמך עיבוד טקסט שמציע איך לנסח מחדש משפט. יש שני סוגים של תגובות: תגובות מוצמדות ותגובות לא מוצמדות. תגובה מוצמדת משויכת למיקום ספציפי, כמו משפט במסמך עיבוד טקסט, בגרסה ספציפית של המסמך. לעומת זאת, תגובה ללא עיגון משויכת רק למסמך.

תשובות מצורפות לתגובות ומייצגות את התגובה של המשתמש לתגובה. באמצעות Drive API, המשתמשים יכולים להוסיף תגובות ותשובות למסמכים שנוצרו על ידי האפליקציה שלכם. תגובה עם תשובות נקראת דיון.

הוספת תגובה ללא עיגון

כדי להוסיף תגובה לא מעוגנת למסמך, צריך להפעיל את השיטה comments.create עם הפרמטר fileId ומשאבי comments שמכילים את התגובה.

התגובה מוכנסת כטקסט פשוט, אבל גוף התשובה כולל את השדה htmlContent שמכיל תוכן בפורמט להצגה.

איך עונים לתגובות?

כדי להוסיף תשובה לתגובה, צריך להפעיל את השיטה replies.create עם התגובה, הפרמטר fileId ומשאבי replies שמכילים את התשובה.

התשובה מוכנסת כטקסט פשוט, אבל תוכן התשובה כולל שדה htmlContent עם תוכן בפורמט להצגה.

הוספת תגובה מוצמדת לגרסה האחרונה של מסמך

כשאתם מוסיפים תגובה, כדאי לקשר אותה לאזור בקובץ. עוגן מגדיר את הגרסה של הקובץ ואת האזור בקובץ שאליו מתייחסת התגובה. המשאב comments מגדיר את השדה anchor כמחרוזת JSON.

כדי להוסיף תגובה מוצמדת:

  1. (אופציונלי). כדי לקבל רשימה של כל revisionID של מסמך, צריך להפעיל את השיטה revisions.list. צריך לבצע את השלב הזה רק אם רוצים לצרף תגובה לגרסה כלשהי מלבד הגרסה האחרונה. אם רוצים להשתמש בגרסה האחרונה, צריך להשתמש ב-head עבור revisionID.

  2. קוראים ל-method‏ comments.create עם הפרמטר fileID, משאב comments שמכיל את התגובה ומחרוזת עוגן JSON שמכילה את revisionID (r) ואת האזור (a).

אופן ההגדרה של אזור משתנה בהתאם לסוג התוכן של המסמך שבו אתם עובדים. מידע נוסף זמין במאמר הגדרת אזור.

הגדרת אזור

כפי שצוין קודם, מחרוזת הצירוף של ה-JSON מכילה את השדה revisionID (r) ואת האזור (a). האזור (a) הוא מערך JSON שמכיל סיווגים של אזורים שמציינים את הפורמט והמיקום שאליהם מצורף התגובה. סיווג יכול להיות מלבן דו-מימדי של תמונה, שורת טקסט במסמך או פרק זמן בסרטון. כדי להגדיר אזור, בוחרים את מסווג האזורים שתואם לסוג התוכן שאתם מנסים לקשר. לדוגמה, אם התוכן הוא טקסט, סביר להניח שתשתמשו במסווג האזורים txt או line.

רשימה של סיווגים של אזורים ב-Drive API מופיעה במאמר סיווגים של אזורים.

בדוגמה הבאה מוצגת מחרוזת עוגן של JSON שמקשרת הערות לשורות בשני אזורים נפרדים במסמך:

  • האזור הראשון מתחיל בשורה 12 ('n':12) ונמשך שלוש שורות ('l':3).
  • האזור השני מכסה רק את השורה 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, בממשק המשתמש אמור להופיע סימן לכך שהתגובה טופלה. לדוגמה, האפליקציה עשויה:

  • לא לאפשר שליחת תשובות נוספות ולהכהות את כל התשובות הקודמות ואת התגובה המקורית.
  • להסתיר תגובות שהטיפול בהן הסתיים.

מחיקת תגובה

משתמשים ב-method‏ comments.delete כדי למחוק תגובות. כשתגובה נמחקת, מערכת Drive מסמנת את משאב התגובה בתור "deleted": "true".

הצגת רשימה של תגובות

משתמשים בשיטה comments.list כדי להציג רשימה של התגובות. אם רוצים לכלול בתוצאות תגובות שנמחקו, מגדירים את השדה includedDeleted לערך true.