הטמעה: תגובות

כדי לאחזר רשימה של שרשורי תגובות לסרטון, יש לבצע קריאה ל-method commentThreads.list. מגדירים בבקשה את ערכי הפרמטרים הבאים:

• part: אם רוצים לאחזר רק תגובות ברמה העליונה, יש להגדיר את ערך הפרמטר כ-snippet, או לערך snippet,replies אם רוצים לאחזר תשובות גם לתגובות ברמה העליונה. (לתשומת ליבך, משאב commentThread לא בהכרח מכיל את כל התשובות לתגובה, ועליך להשתמש בשיטה comments.list כדי לאחזר את כל התשובות לתגובה מסוימת.)

• videoId: מציינים את מזהה הווידאו של הסרטון ב-YouTube שרוצים לאחזר את התגובות שלו.

הבקשה למטה מאחזרת תגובות ותגובות שקשורות לסרטון של נאום הפתיחה בכנס של Google I/O בשנת 2014, עם מזהה הווידאו wtLJPvx7-ys.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.commentThreads.list?
part=snippet,replies
&videoId=wtLJPvx7-ys

ממשק ה-API תומך באפשרות לאחזר שרשורי תגובות על ערוץ או לאחזר את כל שרשורי התגובות המשויכים לערוץ. במקרה השני, ה-API יכול להכיל תגובות על הערוץ או על כל אחד מהסרטונים בערוץ.

• כדי לאחזר תגובות על ערוץ, עליכם לפעול לפי ההוראות לאחזור תגובות לסרטון. עם זאת, במקום להגדיר את הפרמטר videoId, יש להגדיר את הפרמטר channelId כדי לזהות את הערוץ.

• כדי לאחזר תגובות המשויכות לערוץ, עליכם לפעול לפי ההוראות לאחזור תגובות לסרטון. עם זאת, במקום להגדיר את הפרמטר videoId, יש להגדיר את הפרמטר allThreadsRelatedToChannelId כדי לזהות את הערוץ.

הבקשה שבהמשך מאחזרת את כל שרשורי התגובות המשויכים לערוץ YouTube של Google Developerss:

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.commentThreads.list?
part=snippet,replies
&allThreadsRelatedToChannelId=UC_x5XG1OV2P6uZZ5FSM9Ttw

כדי להוסיף תגובה חדשה ברמה העליונה לערוץ או לסרטון, צריך להפעיל את השיטה commentThreads.insert. מגדירים את ערך הפרמטר part של הבקשה כ-snippet. גוף הבקשה הוא commentThread resource, שבו המאפיין snippet.topLevelComment[].snippet[].textOriginal מכיל את טקסט התגובה. הבקשה הזו צריכה לקבל הרשאה באמצעות OAuth 2.0.

• כדי להוסיף תגובה לערוץ, עליך להשתמש בנכס snippet.channelId כדי לזהות את הערוץ.
• כדי להוסיף תגובה לסרטון, יש להשתמש בנכס snippet.channelId לזיהוי הערוץ שהעלה את הסרטון. יש להשתמש גם במאפיין snippet.videoId לזיהוי הסרטון.

הבקשה לדוגמה הבאה מוסיפה הערה לסרטון.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.commentThreads.insert?
part=snippet

הבקשה מוסיפה את המשאב שמוצג למטה.

{
 "snippet": {
  "channelId": "UC_x5XG1OV2P6uZZ5FSM9Ttw",
  "topLevelComment": {
   "snippet": {
    "textOriginal": "This video is awesome!"
   }
  },
  "videoId": "MILSirUni5E"
 }
}

צריך להפעיל את השיטה comments.insert כדי להשיב לתגובה. מגדירים את ערך הפרמטר part של הבקשה כ-snippet. גוף הבקשה הוא comment resource, שבו המאפיין snippet.textOriginal מכיל את טקסט התגובה. המאפיין snippet.parentId מזהה את התגובה שמשויכת לתשובה, והערך שלו הוא commentThread resource's ID. הבקשה הזו צריכה לקבל הרשאה באמצעות OAuth 2.0.

הבקשה לדוגמה הבאה מוסיפה תשובה לתגובה קיימת.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.comments.insert?
part=snippet

הבקשה מוסיפה את המשאב שמוצג למטה. כדי לבצע את הבקשה ב-APIs Explorer, יש להשתמש בערך של הנכס snippet.parentId כדי לזהות את התגובה ברמה העליונה המשויכת לתשובה. במשאב commentThread, המאפיין snippet.topLevelComment[].id מציין את המזהה הייחודי של המשאב.

{
  "snippet": {
    "parentId": "COMMENT_THREAD_ID",
    "textOriginal": "That is true."
  }
}

כדי לעדכן את הטקסט של תגובה ברמה העליונה או תשובה ברמה העליונה, יש לקרוא ל-method comments.update. מגדירים את ערך הפרמטר part כ-snippet. בגוף הבקשה, המאפיין id מזהה את התגובה שאתם משנים ואת הטקסט החדש של התגובה.

• במשאב commentThread שמזהה תגובה ברמה העליונה, המאפיין snippet.topLevelComment[].id מציין את המזהה הייחודי של התגובה.
• במשאב comment, שיכול לזהות תגובה ברמה העליונה או תשובה לתגובה, המאפיין id מציין את המזהה הייחודי של התגובה.

הבקשה לדוגמה שלמטה מעדכנת את הטקסט של תגובה קיימת.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.comments.update?
part=snippet

גוף הבקשה מכיל את קטע הקוד של JSON שמוצג למטה. כדי לבצע את הבקשה ב-APIs Explorer, יש להגדיר את הערך של הנכס id כך שיזהו את התגובה שמעדכנים. מי שכתב את התגובה צריך לאשר את הבקשה.

{
  "id": "COMMENT_ID",
  "snippet": {
    "textOriginal": "That is true."
  }
}

כדי לקבוע סטטוס ניהול של תגובה, יש לבצע קריאה ל-method comments.setModerationStatus. הפעולה הזו משמשת כשבעלים של ערוץ מנהלים את התגובות בערוץ או בסרטונים בערוץ.

כשמבצעים קריאה לשיטה הזו, צריך להגדיר את ערך הפרמטר id לזיהוי התגובה. צריך גם להגדיר את הפרמטר moderationStatus לסטטוס הרצוי. רק הבעלים של הערוץ שבו מופיעה התגובה יכול לשנות את הסטטוס שלה.

• שלב 1: אחזור תגובות שממתינות לבדיקה

  כדי לאחזר תגובות לערוץ או לסרטון, צריך להפעיל את השיטה commentThreads.list. מגדירים את ערך הפרמטר moderationStatus כ-heldForReview. ניתן להשתמש בתגובת ה-API כדי להציג רשימה של תגובות עם אפשרות לבעלים של הערוץ לפרסם או לדחות כל אחת מהן.

• שלב 2: עדכון סטטוס הניהול של תגובה

  צריך להפעיל את השיטה comments.setModerationStatus כדי לעדכן את סטטוס התגובה. משתמשים בערך הפרמטר id כדי לציין את המזהה הייחודי של התגובה. מגדירים את הפרמטר moderationStatus לערך published או לערך rejected. אם דוחים תגובה, אפשר גם להגדיר את הפרמטר banAuthor לערך true כדי למנוע מהמחבר להוסיף הערות נוספות בערוץ או בסרטון.

הערה: ה-API לא מאפשר לרשום או לגלות בדרך אחרת תגובות שנדחו. עם זאת, עדיין ניתן יהיה לשנות את סטטוס הניהול של תגובה שנדחתה לpublished אם המזהה הייחודי של התגובה ידוע. בנוסף, ברגע שסטטוס הניהול של תגובה מתעדכן ל-published או ל-rejected, לא ניתן להחזיר את סטטוס הניהול ל-heldForReview.

בדוגמה הזו מוסבר איך מוחקים תגובה. הדוגמה כוללת את השלבים הבאים:

• שלב 1: אחזור מזהה התגובה

  מבצעים את השלבים שלמעלה כדי לאחזר רשימת תגובות לסרטון או לערוץ. חשוב לזכור שרק מי שפרסם תגובה יכול למחוק אותה, כך שצריך להשוות את הערך במאפיין snippet.authorChannelId.value של משאב comment לבין מזהה הערוץ של המשתמש המאומת כדי לקבוע אם המשתמש יכול למחוק את התגובה הספציפית הזו.

• שלב 2: מחיקת התגובה או שרשור התגובות

  לאחר זיהוי המזהה של שרשור התגובה או התגובה שברצונך למחוק, יש לבצע קריאה ל-method comments.delete כדי למחוק את התגובה. יש להשתמש בערך הפרמטר id כדי לזהות את מזהה התגובה או את מזהה השרשור של התגובה שבחרת למחוק. הבקשה צריכה לקבל הרשאה באמצעות OAuth 2.0. אם בודקים את השאילתה הזו ב-APIs Explorer, צריך להחליף מזהה תגובה או מזהה שרשור של תגובה בערך הפרמטר id שמופיע בבקשה שלמטה.

  https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.comments.delete?
  id=COMMENT_ID