نظرات بازخورد ارائه شده توسط کاربر در مورد یک فایل است، مانند خواننده یک سند پردازش کلمه که نحوه بازنویسی یک جمله را پیشنهاد می کند. دو نوع نظر وجود دارد: نظرات لنگر و نظرات بدون لنگر . یک نظر لنگر با یک مکان خاص، مانند یک جمله در یک سند پردازش کلمه، در یک نسخه خاص از یک سند مرتبط است. برعکس، یک نظر بدون لنگر فقط با سند مرتبط است.
پاسخ‌ها به نظرات پیوست می‌شوند و پاسخ کاربر به نظر را نشان می‌دهند. Drive API به کاربران شما امکان می دهد نظرات و پاسخ هایی را به اسناد ایجاد شده توسط برنامه شما اضافه کنند. در مجموع، یک نظر با پاسخ به عنوان یک بحث شناخته می شود.
یک نظر بدون پیوند اضافه کنید
برای افزودن یک نظر بدون لنگر به یک سند، روش comments.create را با پارامتر fileId و یک منبع comments حاوی نظر فراخوانی کنید.
نظر به عنوان متن ساده درج می شود، اما بدنه پاسخ یک فیلد htmlContent حاوی محتوای قالب بندی شده برای نمایش را ارائه می دهد.
یک پاسخ به یک نظر اضافه کنید
برای افزودن پاسخ به نظر، متد replies.create را با کامنت، پارامتر fileId و یک منبع replies حاوی پاسخ فراخوانی کنید.
پاسخ به صورت متن ساده درج می شود، اما بدنه پاسخ یک فیلد 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 تنظیم کنید.