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
התג של המשאב הזה.
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 ואת התשובה.