משאב comment מכיל מידע על תגובה אחת ב-YouTube. comment משאב יכול לייצג תגובה על סרטון או על ערוץ. בנוסף, התגובה יכולה להיות תגובה ברמה העליונה או תשובה לתגובה ברמה העליונה.
Methods
ה-API תומך בשיטות הבאות למשאבי comments:
- list
- הפונקציה מחזירה רשימה של תגובות שתואמות לפרמטרים של בקשת ה-API. כדאי לנסות עכשיו.
- הוספה
- יצירת תשובה לתגובה קיימת. הערה: כדי ליצור תגובה ברמה העליונה, משתמשים בשיטה
commentThreads.insert. אני רוצה לנסות - update
- Modifies a comment. כדאי לנסות עכשיו.
- מחיקה
- מחיקת תגובה. כדאי לנסות עכשיו.
- setModerationStatus
- Sets the moderation status of one or more comments. הבקשה ל-API צריכה להיות מאושרת על ידי הבעלים של הערוץ או הסרטון שאליהם משויכות התגובות. כדאי לנסות עכשיו.
ייצוג משאבים
מבנה ה-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,
"imageUrl": string
}
}מאפיינים
בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:
| מאפיינים | |
|---|---|
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. (השיטות 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. |
snippet.imageUrl |
stringכתובת ה-URL של התמונה או של קובץ ה-GIF המונפש שמצורפים לתגובה, אם יש כאלה. המאפיין הזה מופיע רק אם התגובה מכילה תמונה או קובץ GIF. כתובת ה-URL מוגשת כקישור חתום עם אורך חיים (TTL) של שש שעות, והתוקף שלה פג שש שעות אחרי השליפה. |