Channels: list

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

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

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

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

בקשה

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

גוף הבקשה

אל תספקו גוף בקשה כשאתם קוראים ל-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 אם בבקשת ה-API התואמת הפרמטר managedByMe הוגדר לערך true.
pageInfo object
האובייקט pageInfo כולל מידע על הדפים של קבוצת התוצאות.
pageInfo.totalResults integer
המספר הכולל של התוצאות בקבוצת התוצאות.
pageInfo.resultsPerPage integer
מספר התוצאות שכלולות בתגובה מה-API.
items[] list
רשימה של ערוצים שתואמים לקריטריונים של הבקשה.

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שיכולות להתקבל מה-API בתגובה לקריאה של השיטה הזו. פרטים נוספים זמינים במאמר 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 והתגובה.