משאב playlist
מייצג פלייליסט של YouTube. פלייליסט הוא אוסף של סרטונים שניתן לצפות בהם ברצף ולשתף עם משתמשים אחרים. כברירת מחדל, פלייליסטים גלויים באופן גלוי למשתמשים אחרים, אבל פלייליסטים יכולים להיות ציבוריים או פרטיים.
המערכת של YouTube משתמשת בפלייליסטים גם כדי לזהות אוספים מיוחדים של סרטונים בערוץ, למשל:
- סרטונים שהועלו
- סרטונים שדורגו כ'אהבתי'
channel resource
בערוץ מסוים.בשלב הבא אפשר להשתמש בשיטה
playlistItems.list
כדי לאחזר את הרשימות האלה. אפשר גם להוסיף פריטים לרשימות האלה או להסיר אותן מהן על ידי קריאה לשיטות playlistItems.insert
ו-playlistItems.delete
.
שיטות
ה-API תומך בשיטות הבאות עבור משאבי playlists
:
- list
- מחזיר אוסף של פלייליסטים שתואמים לפרמטרים של בקשת ה-API. לדוגמה, תוכלו לאחזר את כל הפלייליסטים שבבעלות המשתמש המאומת, או לאחזר פלייליסט אחד או יותר לפי המזהים הייחודיים שלהם. כדאי לנסות עכשיו.
- הוספה
- יצירת פלייליסט. כדאי לנסות עכשיו.
- עדכון
- שינוי פלייליסט. לדוגמה, אפשר לשנות את השם, התיאור או סטטוס הפרטיות של פלייליסט. כדאי לנסות עכשיו.
- מחיקה
- מוחק פלייליסט. כדאי לנסות עכשיו.
ייצוג משאבים
המבנה הבא של 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 }, "contentDetails": { "itemCount": unsigned integer }, "player": { "embedHtml": string }, "localizations": { (key): { "title": string, "description": string } } }
נכסים
הטבלה הבאה מגדירה את המאפיינים שמופיעים במשאב הזה:
נכסים | |
---|---|
kind |
string מזהה את סוג המשאב של ה-API. הערך יהיה youtube#playlist . |
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 סטטוס הפרטיות של הפלייליסט. הערכים החוקיים לנכס הזה הם:
|
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 התיאור של הפלייליסט המותאם לשוק המקומי. |