Channels: list

הערה: ערך המאפיין statistics.subscriberCount של המשאב channel עודכן כדי לשקף שינוי במדיניות YouTube שמשפיע על האופן שבו מוצגים מספרי המנויים. מידע נוסף זמין בהיסטוריית הגרסאות או במרכז העזרה של YouTube.

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

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

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

בקשה

בקשת HTTP

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

אישור

בקשה שמאחזרת את החלק auditDetails של משאב channel חייבת לספק אסימון הרשאה שמכיל את ההיקף https://www.googleapis.com/auth/youtubepartner-channel-audit. בנוסף, כל טוקן שמשתמש בהיקף הזה חייב לבטל כשה-MCN מחליט לקבל או לדחות את הערוץ, או תוך שבועיים מתאריך הנפקת הטוקן.

פרמטרים

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

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

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

הרשימה הבאה מכילה את השמות של part שאפשר לכלול בערך הפרמטר:
  • auditDetails
  • brandingSettings
  • contentDetails
  • contentOwnerDetails
  • id
  • localizations
  • snippet
  • statistics
  • status
  • topicDetails
מסננים (צריך לציין בדיוק אחד מהפרמטרים הבאים)
categoryId string
הפרמטר הזה הוצא משימוש. הפרמטר categoryId ציין קטגוריה של מדריך YouTube, וניתן היה להשתמש בו כדי לבקש ערוצי YouTube שמשויכים לקטגוריה הזו.
forHandle string
הפרמטר forHandle מציין כינוי של YouTube, וכך מבוצעת בקשה לערוץ שמשויך לכינוי הזה. אפשר להוסיף לסמל @ לתחילת ערך הפרמטר. לדוגמה, כדי לאחזר את המשאב של הערוץ 'Google for Developers', מגדירים את ערך הפרמטר forHandle לערך GoogleDevelopers או @GoogleDevelopers.
forUsername string
הפרמטר forUsername מציין שם משתמש ב-YouTube, וכך מבקש את הערוץ שמשויך לשם המשתמש הזה.
id string
הפרמטר id מציין רשימה מופרדת בפסיקים של מזהי ערוצי YouTube של המשאבים שאוחזרים. במשאב channel, המאפיין id מציין את מזהה ערוץ YouTube של הערוץ.
managedByMe boolean
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית.

הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

כדי להורות ל-API להחזיר רק ערוצים שמנוהלים על ידי בעלי התוכן שצוין בפרמטר onBehalfOfContentOwner, צריך להגדיר את הערך של הפרמטר הזה כ-true. המשתמש צריך לעבור אימות כחשבון מערכת ניהול תוכן שמקושר לבעלים של התוכן שצוין, וצריך לספק את onBehalfOfContentOwner.
mine boolean
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית. כדי להורות ל-API להחזיר רק ערוצים שבבעלות המשתמש המאומת, מגדירים את הערך של הפרמטר הזה כ-true.
פרמטרים אופציונליים
hl string
הפרמטר hl מורה ל-API לאחזר מטא-נתונים של משאבים מותאמים לשוק המקומי עבור שפת אפליקציה ספציפית שנתמכת באתר YouTube. ערך הפרמטר חייב להיות קוד שפה שכלול ברשימה שמוחזרת על ידי השיטה i18nLanguages.list.

אם פרטי המשאב המותאמים לשוק המקומי זמינים בשפה הזו, האובייקט snippet.localized של המשאב יכיל את הערכים המותאמים לשוק המקומי. עם זאת, אם הפרטים המותאמים לא זמינים, אובייקט snippet.localized יכיל את פרטי המשאב בשפת ברירת המחדל של המשאב.
maxResults unsigned integer
הפרמטר maxResults מציין את המספר המקסימלי של פריטים שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50, כולל. ערך ברירת המחדל הוא 5.
onBehalfOfContentOwner string
אפשר להשתמש בפרמטר הזה רק בבקשה מורשית.

הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

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

גוף הבקשה

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

תשובה

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

{
  "kind": "youtube#channelListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    channel Resource
  ]
}

מאפיינים

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

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) invalidCriteria אפשר לציין רק מסנן אחד מתוך המסננים הבאים:id, categoryId, mine, managedByMe, forHandle, forUsername. במקרה של אימות של בעלי תוכן באמצעות הפרמטר onBehalfOfContentOwner, אפשר לציין רק את id או את managedByMe.
forbidden (403) channelForbidden הערוץ שצוין באמצעות הפרמטר id לא תומך בבקשה או שהבקשה לא אושרה כראוי.
notFound (404) categoryNotFound לא ניתן למצוא את הקטגוריה שזוהתה באמצעות הפרמטר categoryId. משתמשים בשיטה guideCategories.list כדי לאחזר רשימה של ערכים חוקיים.
notFound (404) channelNotFound לא ניתן למצוא את הערוץ שצוין בפרמטר id.

נסה בעצמך!

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