Comments: list

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

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

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

בקשה

בקשת HTTP

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

פרמטרים

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

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

הרשימה הבאה מכילה את שמות part שאפשר לכלול בערך הפרמטר:
  • id
  • snippet
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים)
id string
הפרמטר id מציין רשימה של מזהי תגובות שמופרדים בפסיקים עבור המשאבים שמאוחזרים. במשאב comment, המאפיין id מציין את מזהה התגובה.
parentId string
הפרמטר parentId מציין את המזהה של התגובה שאת התשובות שלה צריך לאחזר.

הערה: בשלב זה, מערכת YouTube תומכת בתשובות רק לתגובות ברמה העליונה. עם זאת, יכול להיות שבהמשך תהיה תמיכה בתשובות לתשובות.
פרמטרים אופציונליים
maxResults unsigned integer
הפרמטר maxResults מציין את מספר הפריטים המקסימלי שצריך להחזיר בקבוצת התוצאות.

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

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

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

גוף הבקשה

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

תשובה

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

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

תכונות

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

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) operationNotSupported מסנן המזהה תואם רק לתגובות המבוססות על Google+.
forbidden (403) forbidden לא ניתן לאחזר אחת או יותר מהתגובות המבוקשות עקב הרשאות לא מספיקות. יכול להיות שהבקשה לא מורשית כמו שצריך.
notFound (404) commentNotFound לא ניתן למצוא אחת או יותר מהתגובות שצוינו. צריך לבדוק את ערכי הפרמטרים id ו-parentId של הבקשה כדי לוודא שהם נכונים.

רוצה לנסות?

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