תגובות הן משוב שהמשתמשים סיפקו על קובץ, למשל קורא של מסמך לעיבוד תמלילים שבו הוצע לכם איך לנסח מחדש משפט. יש שני סוגים של תגובות: תגובות מעוגנות ותגובות לא מעוגנות. תגובה מעוגנת משויכת למיקום ספציפי, כמו משפט במסמך עיבוד תמלילים, בגרסה ספציפית של מסמך. לעומת זאת, תגובה לא מעוגנת משויכת רק למסמך.
תשובות מצורפות לתגובות ומייצגות את תגובת המשתמש לתגובה. Google Drive API מאפשר למשתמשים להוסיף תגובות ותשובות למסמכים שהאפליקציה שלכם יצרה. כל התגובות והתשובות נקראו דיון יחד.
הוספת תגובה לא מעוגנת
כדי להוסיף תגובה לא מעוגנת למסמך, צריך לקרוא ל-method comments.create עם הפרמטר fileId ולמשאב
comments שמכיל את התגובה.
התגובה תתווסף כטקסט פשוט, אבל גוף התגובה מספק
שדה htmlContent שמכיל תוכן המעוצב לתצוגה.
איך עונים לתגובות?
כדי להוסיף תשובה לתגובה, צריך לקרוא ל-method replies.create עם ההערה, הפרמטר fileId ומשאב reply שמכיל את התשובה.
התשובה תתווסף כטקסט פשוט, אבל גוף התגובה מכיל שדה htmlContent שמכיל תוכן המעוצב לתצוגה.
הוספת תגובה מעוגנת לגרסה האחרונה של המסמך
כשמוסיפים תגובה, כדאי לעגן אותה לאזור בקובץ. השדה עוגן מגדיר את הגרסה הקודמת של הקובץ ואת האזור שאליו התגובה מפנה. המשאב comments מגדיר את השדה anchor כמחרוזת JSON.
כדי להוסיף תגובה מעוגנת:
(אופציונלי). צריך להפעיל את השיטה
revisions.listכדי לרשום את כלrevisionIDשל המסמך. כדאי לבצע את השלב הזה רק אם אתם רוצים לעגן תגובה לגרסה כלשהי שאינה הגרסה האחרונה. אם ברצונך להשתמש בגרסה העדכנית ביותר, יש להשתמש ב-headעבורrevisionID.מפעילים את השיטה
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, אמורה להופיע בממשק המשתמש הודעה שהתגובה טופלה. לדוגמה, האפליקציה שלכם יכולה:
- חסימת תשובות נוספות ועמעום כל התשובות הקודמות והתגובה המקורית.
- הסתרת התגובות שהסתיימו.
מחיקת תגובה
משתמשים בשיטה comments.delete כדי למחוק תגובות. כשמוחקים תגובה, המערכת של Drive מסמנת את המשאב של התגובה בתור "deleted": "true".
תגובות ברשימה
משתמשים בשיטה comments.list כדי לרשום תגובות. אם רוצים לכלול תגובות שנמחקו בתוצאות, צריך להגדיר את השדה includedDeleted לערך true.