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