Playlists: list

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

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

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

בקשה

בקשת HTTP

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

פרמטרים

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

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

אם הפרמטר מזהה נכס שמכיל נכסי צאצא, מאפייני הצאצאים ייכללו בתגובה. לדוגמה, במשאב playlist, המאפיין snippet מכיל מאפיינים כמו author, title, description ו-timeCreated. לכן, אם מגדירים part=snippet, תגובת ה-API תכלול את כל המאפיינים האלה.

הרשימה הבאה מכילה את שמות part שאפשר לכלול בערך הפרמטר:
  • contentDetails
  • id
  • localizations
  • player
  • snippet
  • status
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים)
channelId string
הערך הזה מציין שה-API צריך להחזיר רק את הפלייליסטים של הערוץ שצוין.
id string
הפרמטר id מציין רשימה מופרדת בפסיקים של מזהי הפלייליסטים ב-YouTube של המשאבים שמאוחזרים. במשאב playlist, המאפיין id מציין את מזהה הפלייליסט ב-YouTube של הפלייליסט.
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.
onBehalfOfContentOwnerChannel string
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה ערוץ YouTube של הערוץ שאליו מוסיפים את הסרטון. הפרמטר הזה נדרש כאשר בקשה מציינת ערך לפרמטר onBehalfOfContentOwner, ואפשר להשתמש בו רק בשילוב עם הפרמטר הזה. בנוסף, יש לאשר את הבקשה באמצעות חשבון CMS שמקושר לבעלי התוכן בפרמטר onBehalfOfContentOwner. לבסוף, הערוץ שצוין בערך הפרמטר onBehalfOfContentOwnerChannel חייב להיות מקושר לבעלי התוכן שהפרמטר onBehalfOfContentOwner מציין.

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

גוף הבקשה

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

תשובה

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

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

תכונות

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

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) channelClosed הערוץ שצוין בפרמטר channelId נסגר.
forbidden (403) channelSuspended הערוץ שצוין בפרמטר channelId הושעה.
forbidden (403) playlistForbidden הפלייליסט שזוהה עם הפרמטר id של הבקשה לא תומך בבקשה, או שהבקשה לא מורשית כראוי.
notFound (404) channelNotFound לא ניתן למצוא את הערוץ שצוין בפרמטר channelId.
notFound (404) playlistNotFound לא ניתן למצוא את הפלייליסט שזוהה עם הפרמטר id של הבקשה.
invalidValue (400) playlistOperationUnsupported ממשק ה-API לא תומך ביכולת ליצור רשימה של הפלייליסטים שצוינו. לדוגמה: אי אפשר להוסיף לרשימה את הפלייליסט לצפייה בהמשך.

רוצה לנסות?

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