משאב playlist מייצג פלייליסט ב-YouTube. פלייליסט הוא אוסף של סרטונים שאפשר לצפות בהם ברצף ולשתף עם משתמשים אחרים. כברירת מחדל, פלייליסטים גלויים לכולם, אבל אפשר להגדיר אותם כגלויים לכולם או כפרטיים.
מערכת YouTube משתמשת גם בפלייליסטים כדי לזהות אוספים מיוחדים של סרטונים בערוץ, כמו:
- סרטונים שהועלו
- סרטונים שקיבלו דירוג חיובי (סימון לייק)
channel resource של ערוץ נתון.לאחר מכן תוכלו להשתמש בשיטה
playlistItems.list כדי לאחזר כל אחת מהרשימות האלה. אפשר גם להוסיף פריטים לרשימות האלה או להסיר מהן פריטים באמצעות הקריאה לשיטות playlistItems.insert ו-playlistItems.delete.
Methods
ה-API תומך בשיטות הבאות למשאבי playlists:
- list
- מחזירה אוסף של פלייליסטים שתואמים לפרמטרים של בקשת ה-API. לדוגמה, אפשר לאחזר את כל הפלייליסטים שבבעלות המשתמש המאומת, או לאחזר פלייליסט אחד או יותר לפי המזהים הייחודיים שלהם. כדאי לנסות עכשיו.
- הוספה
- יוצר פלייליסט. כדאי לנסות עכשיו.
- עדכון
- Modifies a playlist. לדוגמה, אפשר לשנות את השם, התיאור או סטטוס הפרטיות של פלייליסט. כדאי לנסות עכשיו.
- מחיקה
- מחיקת פלייליסט. כדאי לנסות עכשיו.
ייצוג משאבים
מבנה ה-JSON הבא מציג את הפורמט של משאב playlists:
{
"kind": "youtube#playlist",
"etag": etag,
"id": string,
"snippet": {
"publishedAt": datetime,
"channelId": string,
"title": string,
"description": string,
"thumbnails": {
(key): {
"url": string,
"width": unsigned integer,
"height": unsigned integer
}
},
"channelTitle": string,
"defaultLanguage": string,
"localized": {
"title": string,
"description": string
}
},
"status": {
"privacyStatus": string,
"podcastStatus": enum
},
"contentDetails": {
"itemCount": unsigned integer
},
"player": {
"embedHtml": string
},
"localizations": {
(key): {
"title": string,
"description": string
}
}
}מאפיינים
בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:
| מאפיינים | |
|---|---|
kind |
stringמזהה את סוג משאב ה-API. הערך יהיה youtube#playlist. |
etag |
etagה-Etag של מקור המידע הזה. |
id |
stringהמזהה שמשמש את YouTube לזיהוי ייחודי של הפלייליסט. |
snippet |
objectאובייקט snippet מכיל פרטים בסיסיים על הפלייליסט, כמו השם והתיאור שלו. |
snippet.publishedAt |
datetimeהתאריך והשעה שבהם נוצר הפלייליסט. הערך מצוין בפורמט ISO 8601. |
snippet.channelId |
stringהמזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ שפרסם את הפלייליסט. |
snippet.title |
stringשם הפלייליסט. |
snippet.description |
stringתיאור הפלייליסט. |
snippet.thumbnails |
objectמפה של תמונות ממוזערות שמשויכות לפלייליסט. לכל אובייקט במפה, המפתח הוא השם של התמונה הממוזערת, והערך הוא אובייקט שמכיל מידע נוסף על התמונה הממוזערת. |
snippet.thumbnails.(key) |
objectהערכים התקפים של המפתח הם:
|
snippet.thumbnails.(key).url |
stringכתובת ה-URL של התמונה. |
snippet.thumbnails.(key).width |
unsigned integerרוחב התמונה. |
snippet.thumbnails.(key).height |
unsigned integerגובה התמונה. |
snippet.channelTitle |
stringשם הערוץ שהסרטון שייך לו. |
snippet.tags[] |
listהנכס הזה יצא משימוש. תגי מילות מפתח שמשויכים לפלייליסט. |
snippet.defaultLanguage |
stringהשפה של הטקסט במאפיינים snippet.title ו-snippet.description של רכיב playlist. |
snippet.localized |
objectהאובייקט snippet.localized מכיל שם ותיאור של הפלייליסט בשפה המקומית או את השם בשפת ברירת המחדל של המטא-נתונים של הפלייליסט.
localizations כדי להוסיף, לעדכן או למחוק שמות מקומיים. |
snippet.localized.title |
stringשם הפלייליסט שמותאם לשוק המקומי. |
snippet.localized.description |
stringתיאור הפלייליסט שמותאם לשוק המקומי. |
status |
objectאובייקט status מכיל מידע על הסטטוס של הפלייליסט. |
status.privacyStatus |
stringסטטוס הפרטיות של הפלייליסט. הערכים התקפים של המאפיין הזה הם:
|
status.podcastStatus |
stringסטטוס הפודקאסט של הפלייליסט. אם הערך הוא enabled, הפלייליסט מסומן כסדרת פודקאסטים. כדי להגדיר את סטטוס הפודקאסט של פלייליסט לערך enabled, הפלייליסט צריך לכלול תמונה לפלייליסט.הערכים התקינים של המאפיין הזה הם:
|
contentDetails |
objectאובייקט contentDetails מכיל מידע על תוכן הפלייליסט, כולל מספר הסרטונים בפלייליסט. |
contentDetails.itemCount |
unsigned integerמספר הסרטונים בפלייליסט. |
player |
objectהאובייקט player מכיל מידע שמשמש להפעלת הפלייליסט בנגן מוטמע. |
player.embedHtml |
stringתג <iframe> שמשבץ נגן שיפעיל את הפלייליסט. |
localizations |
objectאובייקט localizations מכיל תרגומים של המטא-נתונים של הפלייליסט. |
localizations.(key) |
objectהשפה של הטקסט המותאם לשוק המקומי שמשויך לערך המפתח. הערך הוא מחרוזת שמכילה קוד שפה בפורמט BCP-47. |
localizations.(key).title |
stringשם הפלייליסט שמותאם לשוק המקומי. |
localizations.(key).description |
stringתיאור הפלייליסט שמותאם לשוק המקומי. |