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

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

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

הוספת תגובה לא מעוגנת

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

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

הוספת תשובה לתגובה

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

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

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

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

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

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

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

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

הגדרת אזור

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

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

בדוגמה הבאה מוצגת מחרוזת עוגן של 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, ממשק המשתמש צריך לציין זאת שהתגובה טופלה. לדוגמה, האפליקציה עשויה:

  • חסימת התשובות הנוספות ומעמעום התשובות הקודמות וגם התשובה המקורית תגובה.
  • הסתרת התגובות שהסתיימו.

מחיקת תגובה

משתמשים בשיטה comments.delete כדי מחיקת תגובות. כשתגובה נמחקת, Drive מסמן את משאב התגובה בתור "deleted": "true".

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

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