מחזירה רשימה של channelSection
משאבים שתואמים לקריטריונים של בקשת ה-API.
ההשפעה על המכסה: לשיחה בשיטה הזו מוגדרת עלות מכסה של יחידה אחת.
תרחישים נפוצים
שליחת בקשה
בקשת HTTP
GET https://www.googleapis.com/youtube/v3/channelSections
פרמטרים
הטבלה הבאה מפרטת את הפרמטרים שנתמכים על ידי שאילתה זו. כל הפרמטרים המפורטים הם פרמטרים של שאילתה.
פרמטרים | ||
---|---|---|
פרמטרים נדרשים | ||
part |
string הפרמטר part מציין רשימה של נכס משאב channelSection אחד או יותר המופרדים בפסיקים, שתגובת ה-API תכלול.אם הפרמטר מזהה נכס שמכיל מאפייני צאצא, מאפייני הצאצא ייכללו בתשובה. לדוגמה, במשאב channelSection , המאפיין snippet מכיל מאפיינים אחרים, כגון כותרת תצוגה עבור המדור. אם מגדירים את part=snippet , תגובת ה-API תכיל גם את כל המאפיינים המקוננים האלה.הרשימה הבאה מכילה את שמות part שניתן לכלול בערך הפרמטר:
|
|
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים) | ||
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 מציין שפרטי הכניסה להרשאה של הבקשה מזהים משתמש CMS ב-YouTube שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם של ערוצי YouTube רבים. היא מאפשרת לבעלי התוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, ללא צורך לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון במערכת ניהול התוכן שהמשתמש מאמת באמצעותו חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
גוף הבקשה
אין להזין גוף בקשה בעת הפעלת שיטה זו.
תשובה
אם התגובה מוצלחת, שיטה זו תחזיר גוף תגובה בעל המבנה הבא:
{ "kind": "youtube#channelSectionListResponse", "etag": etag, "items": [ channelSection Resource ] }
נכסים
הטבלה הבאה מגדירה את המאפיינים שמופיעים במשאב הזה:
נכסים | |
---|---|
kind |
string מזהה את סוג המשאב של ה-API. הערך יהיה youtube#channelSectionListResponse . |
etag |
etag התג של המשאב הזה. |
items[] |
list רשימה של קיבוצי ערוצים שתואמים לקריטריונים של הבקשה. |
שגיאות
הטבלה הבאה מזהה הודעות שגיאה שה-API יכול להחזיר בתגובה לקריאה לשיטה הזו. מידע נוסף זמין בתיעוד של הודעת השגיאה.
סוג השגיאה | פרטי השגיאה | תיאור |
---|---|---|
forbidden (403) |
channelSectionForbidden |
אין לו אישור לגשת לקטעי הערוץ המבוקשים. |
invalidValue (400) |
idInvalid |
הבקשה מציינת מזהה קטע ערוץ לא חוקי. |
invalidValue (400) |
invalidCriteria |
לא ניתן להשלים את הבקשה כי הקריטריונים לסינון לא חוקיים. |
notFound (404) |
channelNotFound |
לא ניתן למצוא את הערוץ המשויך לבקשה. |
notFound (404) |
channelSectionNotFound |
לא ניתן למצוא את קטע הערוץ המשויך לבקשה. |
רוצה לנסות?
אפשר להשתמש ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את בקשת ה-API ואת התשובה.