ChannelSections: list

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

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

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

בקשה

בקשת HTTP

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

פרמטרים

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

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

אם הפרמטר מזהה נכס שמכיל נכסי צאצא, מאפייני הצאצאים ייכללו בתגובה. לדוגמה, במשאב channelSection, המאפיין snippet מכיל מאפיינים אחרים כמו כותרת לתצוגה של הקטע. אם מגדירים את part=snippet, תגובת ה-API תכלול גם את כל המאפיינים המקוננים.

הרשימה הבאה מכילה את השמות מסוג part שניתן לכלול בערך הפרמטר:
  • contentDetails
  • id
  • snippet
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים)
channelId string
הפרמטר channelId מציין מזהה של ערוץ YouTube. אם בקשה מציינת ערך לפרמטר הזה, ה-API יחזיר רק את הקטעים של הערוץ שצוין.
id string
הפרמטר id מציין רשימת מזהים מופרדים בפסיקים שמזהים באופן ייחודי את המשאבים של channelSection שמאוחזרים. במשאב channelSection, המאפיין id מציין את מזהה הקטע.
mine boolean
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. צריך להגדיר את ערך הפרמטר הזה ל-true כדי לאחזר פיד של קטעי הערוץ שמשויכים לערוץ YouTube של המשתמש המאומת.
פרמטרים אופציונליים
hl string
הפרמטר הזה הוצא משימוש. הפרמטר hl סיפק תמיכה באחזור מטא-נתונים מותאמים לשוק המקומי עבור קטע בערוץ. עם זאת, הפונקציונליות הזו הוצאה משימוש ב-YouTube Studio ובאפליקציית YouTube.
onBehalfOfContentOwner string
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה של ההרשאה של הבקשה מזהים משתמש YouTube CMS שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שהם הבעלים והמנהלים של ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון ה-CMS שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube.

גוף הבקשה

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

תשובה

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

{
  "kind": "youtube#channelSectionListResponse",
  "etag": etag,
  "items": [
    channelSection Resource
  ]
}

תכונות

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

תכונות
kind string
מזהה את הסוג של משאב ה-API. הערך יהיה youtube#channelSectionListResponse.
etag etag
ה-e של המשאב הזה.
items[] list
רשימה של Channelsections שעונים על הקריטריונים של הבקשה.

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) channelSectionForbidden למגיש הבקשה אין הרשאה לגשת לקטעי הערוץ המבוקשים.
invalidValue (400) idInvalid הבקשה מציינת מזהה לא חוקי של קטע בערוץ.
invalidValue (400) invalidCriteria לא ניתן היה להשלים את הבקשה כי הקריטריונים לסינון אינם חוקיים.
notFound (404) channelNotFound לא ניתן למצוא את הערוץ המשויך לבקשה.
notFound (404) channelSectionNotFound קטע הערוץ המשויך לבקשה לא נמצא.

רוצה לנסות?

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