CommentThreads: list

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

השפעה על המכסה: קריאה ל-method הזה מנצלת יחידה אחת מהמכסה.

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

בקשה

בקשת 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 – מחזירה את התגובות בפורמט של טקסט פשוט.

גוף הבקשה

אל תספקו גוף בקשה כשאתם קוראים ל-method הזו.

תשובה

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

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

מאפיינים

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

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
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 והתגובה.