משאב comment
מכיל מידע על תגובה אחת ב-YouTube. משאב comment
יכול לייצג תגובה לגבי סרטון או לגבי ערוץ. בנוסף, התגובה יכולה להיות תגובה ברמה העליונה או תגובה לתגובה ברמה העליונה.
שיטות
ה-API תומך ב-methods הבאות למשאבים של comments
:
- list
- מחזירה רשימה של תגובות שתואמות לפרמטרים של בקשת ה-API. כדאי לנסות עכשיו.
- insert
- יצירת תשובה לתגובה קיימת. הערה: כדי ליצור תגובה ברמה העליונה, יש להשתמש בשיטה
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 ה-Etag של משאב זה. |
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. (ה-method comments.list וה-method 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. |