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
התג של המשאב הזה.
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 – הגרסה ברזולוציה הגבוהה ביותר של התמונה הממוזערת. גודל תמונה זה זמין לסרטונים מסוימים ולמשאבים אחרים הקשורים לסרטונים, כגון פריטים בפלייליסט או תוצאות חיפוש. התמונה ברוחב 1280 פיקסלים ובגובה 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
האובייקט 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.