PlaylistItems

משאב playlistItem מזהה משאב אחר, כמו סרטון, שכלול בפלייליסט. בנוסף, המשאב playlistItem מכיל פרטים לגבי המשאב הכלול שקשורים באופן ספציפי לאופן השימוש באותו משאב באותו פלייליסט.

המערכת של YouTube משתמשת גם בפלייליסט כדי לזהות את רשימת הסרטונים שהועלו לערוץ. כל playlistItem ברשימה הזו מייצג סרטון אחד שהועלה. אפשר לאחזר את מזהה הפלייליסט של הרשימה ב-channel resource של ערוץ נתון. לאחר מכן אפשר להשתמש בשיטה playlistItems.list כדי להציג את הרשימה.

שיטות

ה-API תומך בשיטות הבאות למשאבים של playlistItems:

list

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

הוספה

הוספת משאב לפלייליסט. כדאי לנסות עכשיו.

עדכון

משנה פריט בפלייליסט. לדוגמה, אפשר לעדכן את מיקום הפריט בפלייליסט. כדאי לנסות עכשיו.

מחיקה

מחיקת פריט בפלייליסט. כדאי לנסות עכשיו.

ייצוג משאבים

מבנה ה-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 ה-e של המשאב הזה.
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 ערכי המפתח החוקיים הם: default – התמונה הממוזערת המוגדרת כברירת מחדל. התמונה הממוזערת המוגדרת כברירת מחדל של סרטון – או משאב שמפנה לסרטון, כמו פריט בפלייליסט או תוצאת חיפוש – היא ברוחב של 120 פיקסלים ובגובה של 90 פיקסלים. התמונה הממוזערת שמוגדרת כברירת מחדל לערוץ היא ברוחב 88 פיקסלים וגובה של 88 פיקסלים. medium – גרסה של התמונה הממוזערת ברזולוציה גבוהה יותר. לסרטון (או למקור מידע שמפנה לסרטון), רוחב התמונה הוא 320 פיקסלים וגובהה הוא 180 פיקסלים. כשמדובר בערוץ, התמונה הזו היא ברוחב של 240 פיקסלים ובגובה של 240 פיקסלים. high – גרסה של התמונה הממוזערת ברזולוציה גבוהה. לסרטון (או משאב שמפנה לסרטון), רוחב התמונה הוא 480 פיקסלים וגובהה הוא 360 פיקסלים. כשמדובר בערוץ, התמונה הזו היא ברוחב של 800 פיקסלים ובגובה של 800 פיקסלים. standard – גרסה ברזולוציה גבוהה עוד יותר של התמונה הממוזערת מזו של התמונה ברזולוציה של high. התמונה הזו זמינה לסרטונים מסוימים ולמקורות מידע אחרים שקשורים לסרטונים, כמו פריטים בפלייליסט או תוצאות חיפוש. רוחב התמונה הוא 640 פיקסלים וגובהה הוא 480 פיקסלים. maxres – הגרסה ברזולוציה הגבוהה ביותר של התמונה הממוזערת. גודל התמונה הזה זמין לסרטונים מסוימים ולמשאבים אחרים שמתייחסים לסרטונים, כמו פריטים בפלייליסט או תוצאות חיפוש. הרוחב של התמונה הזו הוא 1,280 פיקסלים וגובה של 720 פיקסלים.
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 אם הפריט הכלול הוא סרטון ב-YouTube, האובייקט contentDetails ייכלל במשאב. האובייקט מכיל מידע נוסף על הסרטון.
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.