משאב playlistItem
מזהה משאב אחר, כמו סרטון, שכלול בפלייליסט. בנוסף, המשאב playlistItem
מכיל פרטים על המשאב הכלול שקשורים באופן ספציפי לאופן שבו המשאב הזה משמש בפלייליסט הזה.
מערכת YouTube משתמשת גם בפלייליסט כדי לזהות את רשימת הסרטונים שהועלו בערוץ, כאשר כל playlistItem
ברשימה מייצג סרטון אחד שהועלה. אפשר לאחזר את מזהה הפלייליסט של הרשימה הזו מהמשאב channel
של ערוץ נתון. לאחר מכן תוכלו להשתמש בשיטה playlistItems.list
ברשימה.
Methods
ה-API תומך בשיטות הבאות למשאבי playlistItems
:
- list
- מחזירה אוסף של פריטים בפלייליסט שתואמים לפרמטר הבקשה של ה-API. אפשר לאחזר את כל הפריטים בפלייליסט מסוים או פריט אחד או יותר בפלייליסט לפי המזהים הייחודיים שלהם. כדאי לנסות עכשיו.
- insert
- הוספת משאב לפלייליסט. כדאי לנסות עכשיו.
- עדכון
- שינוי פריט בפלייליסט. לדוגמה, אפשר לעדכן את המיקום של הפריט בפלייליסט. כדאי לנסות עכשיו.
- מחיקה
- מחיקת פריט בפלייליסט. כדאי לנסות עכשיו.
ייצוג משאבים
המבנה הבא של JSON מציג את הפורמט של משאב playlistItems
:
{ "kind": "youtube#playlistItem", "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, "videoOwnerChannelTitle": string, "videoOwnerChannelId": string, "playlistId": string, "position": unsigned integer, "resourceId": { "kind": string, "videoId": string, } }, "contentDetails": { "videoId": string, "startAt": string, "endAt": string, "note": string, "videoPublishedAt": datetime }, "status": { "privacyStatus": string } }
מאפיינים
בטבלה הבאה מפורטים המאפיינים שמופיעים במשאב הזה:
מאפיינים | |
---|---|
kind |
string מזהה את סוג משאב ה-API. הערך יהיה youtube#playlistItem . |
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.videoOwnerChannelTitle |
string שם הערוץ שהעלה את הסרטון הזה. |
snippet.videoOwnerChannelId |
string מזהה הערוץ שאליו הועלה הסרטון הזה. |
snippet.playlistId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הפלייליסט שבו נמצא פריט הפלייליסט. |
snippet.position |
unsigned integer הסדר שבו הפריט מופיע בפלייליסט. הערך מתקבל מאינדקס שמתחיל בספרה אפס, כך שהפריט הראשון מקבל את המיקום 0 , הפריט השני מקבל את המיקום 1 וכן הלאה. |
snippet.resourceId |
object האובייקט id מכיל מידע שאפשר להשתמש בו כדי לזהות באופן ייחודי את המשאב שכלול בפלייליסט כפריט בפלייליסט. |
snippet.resourceId.kind |
string הסוג של המשאב שאליו מתייחסים. |
snippet.resourceId.videoId |
string אם הערך של המאפיין snippet.resourceId.kind הוא youtube#video , המאפיין הזה יופיע והערך שלו יכיל את המזהה שמערכת YouTube משתמשת בו כדי לזהות באופן ייחודי את הסרטון בפלייליסט. |
contentDetails |
object האובייקט contentDetails נכלל במשאב אם הפריט הכלול הוא סרטון ב-YouTube. האובייקט מכיל מידע נוסף על הסרטון. |
contentDetails.videoId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של סרטון. כדי לאחזר את המשאב video , צריך להגדיר את פרמטר השאילתה id לערך הזה בבקשת ה-API. |
contentDetails.startAt |
string הערה: המאפיין הזה הוצא משימוש, ואם הוא מוגדר, הערך שלו לא מטופל. הזמן, שנמדד בשניות מתחילת הסרטון, שבו הסרטון אמור להתחיל לפעול. (הבעלים של הפלייליסט יכולים לציין את הזמנים שבהם הסרטון צריך להתחיל ולהפסיק לפעול כשהסרטון מופעל בהקשר של הפלייליסט). ערך ברירת המחדל הוא 0 . |
contentDetails.endAt |
string הערה: המאפיין הזה הוצא משימוש, ואם הוא מוגדר, הערך שלו לא מטופל. הזמן, שנמדד בשניות מתחילת הסרטון, שבו הסרטון אמור להפסיק לפעול. (הבעלים של הפלייליסט יכולים לציין את הזמנים שבהם הסרטון צריך להתחיל ולהפסיק לפעול כשהסרטון מופעל בהקשר של הפלייליסט). כברירת מחדל, ההנחה היא שה- video.endTime הוא סוף הסרטון. |
contentDetails.note |
string הערה שנוצרה על ידי משתמש לגבי הפריט הזה. האורך המקסימלי של ערך המאפיין הוא 280 תווים. |
contentDetails.videoPublishedAt |
datetime התאריך והשעה שבהם הסרטון פורסם ב-YouTube. הערך מצוין בפורמט ISO 8601. |
status |
object האובייקט status מכיל מידע על סטטוס הפרטיות של פריט הפלייליסט. |
status.privacyStatus |
string סטטוס הפרטיות של פריט הפלייליסט. הערוץ שהעלה את הסרטון שמייצג את פריט הפלייליסט יכול להגדיר את הערך הזה באמצעות השיטה videos.insert או videos.update . |