Comments: list

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

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

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

בקשה

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

גוף הבקשה

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

תשובה

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

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

מאפיינים

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

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

שגיאות

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

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

רוצה לנסות?

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