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.

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

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

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

גוף הבקשה

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

תשובה

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

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

תכונות

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

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

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שה-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.