ChannelSections: list

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

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

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

בקשה

בקשת 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 שונים. הוא מאפשר לבעלי התוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, בלי לספק פרטי כניסה לאימות לכל ערוץ בנפרד. החשבון במערכת ניהול התוכן שהמשתמש מאמת צריך להיות מקושר לבעל התוכן ב-YouTube שצוין.

גוף הבקשה

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

תשובה

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

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

מאפיינים

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

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

שגיאות

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

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

רוצה לנסות?

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