משאב comment
מכיל מידע על תגובה אחת ב-YouTube. משאב comment
יכול לייצג תגובה על סרטון או על ערוץ. בנוסף, התגובה יכולה להיות תגובה ברמה עליונה או תשובה לתגובה ברמה עליונה.
שיטות
ה-API תומך בשיטות הבאות למשאבים של comments
:
- list
- מחזיר רשימה של תגובות שתואמות לפרמטרים של בקשת ה-API. כדאי לנסות עכשיו.
- הוספה
- יצירת תשובה לתגובה קיימת. הערה: כדי ליצור תגובה ברמה העליונה, יש להשתמש בשיטה
commentThreads.insert
. רוצים לנסות עכשיו? - עדכון
- משנה תגובה. כדאי לנסות עכשיו.
- מחיקה
- מוחק תגובה. כדאי לנסות עכשיו.
- setModerationStatus
- מגדיר את סטטוס הניהול של תגובה אחת או יותר. בקשת ה-API צריכה לקבל אישור מהבעלים של הערוץ או של הסרטון שמשויכים לתגובות. כדאי לנסות עכשיו.
- markAsSpam
- הערה: השיטה הזו הוצאה משימוש ולא נתמכת יותר.
- מבטא את דעתו של המתקשר שיש לסמן תגובה אחת או יותר כספאם.
ייצוג משאבים
מבנה ה-JSON הבא מציג את הפורמט של משאב comments
:
{ "kind": "youtube#comment", "etag": etag, "id": string, "snippet": { "authorDisplayName": string, "authorProfileImageUrl": string, "authorChannelUrl": string, "authorChannelId": { "value": string }, "channelId": string, "textDisplay": string, "textOriginal": string, "parentId": string, "canRate": boolean, "viewerRating": string, "likeCount": unsigned integer, "moderationStatus": string, "publishedAt": datetime, "updatedAt": datetime } }
תכונות
הטבלה הבאה מגדירה את המאפיינים שיופיעו במשאב הזה:
תכונות | |
---|---|
kind |
string מזהה את הסוג של משאב ה-API. הערך יהיה youtube#comment . |
etag |
etag ה-e של המשאב הזה. |
id |
string המזהה שמשמש את YouTube לזיהוי ייחודי של התגובה. |
snippet |
object האובייקט snippet מכיל פרטים בסיסיים על התגובה. |
snippet.authorDisplayName |
string השם המוצג של המשתמש שפרסם את התגובה. |
snippet.authorProfileImageUrl |
string כתובת ה-URL של הדמות של המשתמש שפרסם את התגובה. |
snippet.authorChannelUrl |
string כתובת ה-URL של ערוץ YouTube של כותב התגובה, אם יש כזה. |
snippet.authorChannelId |
object האובייקט הזה כולל מידע על ערוץ YouTube של כותב התגובה, אם זמין. |
snippet.authorChannelId.value |
string מזהה ערוץ YouTube של כותב התגובה, אם קיים. |
snippet.channelId |
string המזהה של ערוץ YouTube המשויך לתגובה. |
snippet.textDisplay |
string הטקסט של התגובה. ניתן לאחזר את הטקסט בטקסט רגיל או ב-HTML. (השיטות comments.list ו-commentThreads.list תומכות בפרמטר textFormat , שמציין את פורמט הטקסט שנבחר.)אפילו הטקסט הרגיל עשוי להיות שונה מהטקסט של התגובה המקורית. לדוגמה, קישורים כאלה עשויים להחליף קישורים לסרטונים בשמות של סרטונים. |
snippet.textOriginal |
string הטקסט המקורי והגולמי של התגובה כפי שהיא פורסמה או עודכנה לאחרונה. הטקסט המקורי מוחזר למשתמש המאומת רק אם הוא מחבר התגובה. |
snippet.parentId |
string המזהה הייחודי של התגובה ההורה. המאפיין הזה מוגדר רק אם התגובה נשלחה כתשובה לתגובה אחרת. |
snippet.canRate |
boolean ההגדרה הזו קובעת אם הצופה הנוכחי יכול לדרג את התגובה. |
snippet.viewerRating |
string הדירוג שהצופה העניק לתגובה הזו. הנכס הזה לא מזהה dislike דירוגים, אבל ההתנהגות הזו עשויה להשתנות. בינתיים, ערך הנכס הוא like אם הצופה דירג את התגובה באופן חיובי. הערך הוא none בכל שאר המקרים, כולל אם המשתמש נתן לתגובה דירוג שלילי או לא דירג את התגובה.הערכים החוקיים לנכס הזה הם:
|
snippet.likeCount |
unsigned integer המספר הכולל של לייקים (דירוגים חיוביים) לתגובה. |
snippet.moderationStatus |
string סטטוס הניהול של התגובה. המאפיין הזה מוחזר רק אם בקשת ה-API אושרה על ידי הבעלים של הערוץ או של הסרטון שבו נשלחו התגובות המבוקשות. בנוסף, המאפיין הזה לא מוגדר אם בבקשת ה-API נעשה שימוש בפרמטר id של המסנן.הערכים החוקיים לנכס הזה הם:
|
snippet.publishedAt |
datetime התאריך והשעה שבהם התגובה פורסמה במקור. הערך מצוין בפורמט ISO 8601. |
snippet.updatedAt |
datetime התאריך והשעה שבהם התגובה עודכנה לאחרונה. הערך מצוין בפורמט ISO 8601. |