CommentThreads: list

הפונקציה מחזירה רשימה של שרשורי תגובות שתואמים לפרמטרים של בקשת ה-API.

ההשפעה של המכסה: לקריאה לשיטה הזו יש עלות מכסה של יחידה אחת.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

GET https://www.googleapis.com/youtube/v3/commentThreads

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.

פרמטרים
הפרמטרים הנדרשים
part string
הפרמטר part מציין רשימה מופרדת בפסיקים של מאפיין משאב commentThread אחד או יותר שייכללו בתגובת ה-API.

הרשימה הבאה מכילה את שמות part שאפשר לכלול בערך הפרמטר:
  • id
  • replies
  • snippet
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים)
allThreadsRelatedToChannelId string
הפרמטר allThreadsRelatedToChannelId מורה ל-API להחזיר את כל שרשורי התגובות שמשויכים לערוץ שצוין.
id string
הפרמטר id מציין רשימה מופרדת בפסיקים של מזהי שרשורי תגובות עבור המשאבים שצריך לאחזר.
videoId string
הפרמטר videoId מורה ל-API להחזיר שרשורי תגובות שמשויכים למזהה הווידאו שצוין.
פרמטרים אופציונליים
maxResults unsigned integer
הפרמטר maxResults מציין את מספר הפריטים המקסימלי שצריך להחזיר בקבוצת התוצאות.

הערה: הפרמטר הזה לא נתמך לשימוש בשילוב עם הפרמטר id. הערכים הקבילים הם 1 עד 100, כולל. ערך ברירת המחדל הוא 20.
moderationStatus string
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. צריך להגדיר את הפרמטר הזה כדי להגביל את שרשורי התגובות שהוחזרו למצב ניהול מסוים.

הערה: הפרמטר הזה לא נתמך לשימוש בשילוב עם הפרמטר id. ערך ברירת המחדל הוא published.

הערכים הקבילים הם:
  • heldForReview – אחזור שרשורי תגובות שממתינים לבדיקה על ידי מנהל. אפשר לכלול בתגובה שרשור תגובות אם התגובה ברמה העליונה או לפחות אחת מהתשובות לתגובה הזו ממתינות לבדיקה.
  • likelySpam – אחזור שרשורי תגובות שסווגו כבעלי סיכוי גבוה לספאם. יכול להיות ששרשור תגובות ייכלל בתגובה אם התגובה ברמה העליונה או לפחות אחת מהתשובות לתגובה הזו נחשבת כספאם.
  • published – אחזור שרשורים של תגובות שפורסמו. זהו ערך ברירת המחדל. אפשר לכלול בתגובה שרשור תגובות אם התגובה שלו ברמה העליונה פורסמה.
order string
הפרמטר order מציין את הסדר שבו שרשורי התגובות צריכים להופיע בתגובת ה-API. הערכים החוקיים הם:
  • time – שרשורי התגובות מסודרים לפי זמן. זאת התנהגות ברירת המחדל.
  • relevance - שרשורי התגובות מסודרים לפי הרלוונטיות.
הערה: לא ניתן להשתמש בפרמטר הזה בשילוב עם הפרמטר id.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובת API, המאפיין nextPageToken מזהה את הדף הבא בתוצאה שניתן לאחזר.

הערה: לא ניתן להשתמש בפרמטר הזה בשילוב עם הפרמטר id.
searchTerms string
הפרמטר searchTerms מורה ל-API להגביל את תגובת ה-API כך שתכיל רק תגובות שמכילות את מונחי החיפוש שצוינו.

הערה: אין תמיכה בפרמטר הזה בשילוב עם הפרמטר id.
textFormat string
יש להגדיר את ערך הפרמטר הזה ל-html או ל-plainText כדי להנחות את ה-API להחזיר את התגובות שמשתמשים פרסמו ב-HTML או בטקסט פשוט. ערך ברירת המחדל הוא html.

הערכים הקבילים הם:
  • html – הצגת התגובות בפורמט HTML. זהו ערך ברירת המחדל.
  • plainText – החזרת התגובות בפורמט טקסט פשוט.

גוף הבקשה

אין לציין את גוף הבקשה בקריאה לשיטה הזו.

תשובה

אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:

{
  "kind": "youtube#commentThreadListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    commentThread Resource
  ]
}

תכונות

הטבלה הבאה מגדירה את המאפיינים שיופיעו במשאב הזה:

תכונות
kind string
מזהה את הסוג של משאב ה-API. הערך יהיה youtube#commentThreadListResponse.
etag etag
ה-e של המשאב הזה.
nextPageToken string
האסימון שיכול לשמש כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות.
pageInfo object
האובייקט pageInfo כולל את פרטי החלוקה לדפים של קבוצת התוצאות.
pageInfo.totalResults integer
המספר הכולל של התוצאות בקבוצת התוצאות.
pageInfo.resultsPerPage integer
מספר התוצאות שכלולות בתגובת ה-API.
items[] list
רשימת שרשורי תגובות שעומדים בקריטריונים של הבקשה.

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) operationNotSupported המסנן id תואם רק לתגובות שמבוססות על Google+.
badRequest (400) processingFailure שרת ה-API לא הצליח לעבד את הבקשה. זו יכולה להיות שגיאה זמנית, אבל בדרך כלל היא מעידה על כך שהקלט של הבקשה לא חוקי. כדי לוודא שהוא תקין, צריך לבדוק את המבנה של המשאב commentThread בגוף הבקשה.
forbidden (403) commentsDisabled בסרטון שזוהה באמצעות הפרמטר videoId הושבתו תגובות.
forbidden (403) forbidden לא ניתן לאחזר אחד או יותר משרשורי התגובות המבוקשים עקב הרשאות לא מספיקות. יכול להיות שהבקשה לא מורשית כמו שצריך.
notFound (404) channelNotFound הערוץ שזוהה על ידי הפרמטר allThreadsRelatedToChannelId לא נמצא.
notFound (404) commentThreadNotFound לא ניתן למצוא אחד או יותר משרשורי התגובות שצוינו. צריך לבדוק את ערכי הפרמטר id של הבקשה כדי לוודא שהם נכונים.
notFound (404) videoNotFound הסרטון שזוהה על ידי הפרמטר videoId לא נמצא.

רוצה לנסות?

משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.