PlaylistItems

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

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

Methods

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

list
הפונקציה מחזירה אוסף של פריטים בפלייליסט שתואמים לפרמטרים של בקשת ה-API. אפשר לאחזר את כל הפריטים בפלייליסט מסוים, או לאחזר פריט אחד או יותר בפלייליסט לפי המזהים הייחודיים שלהם. כדאי לנסות עכשיו.
הוספה
‫
Adds a resource to a playlist. כדאי לנסות עכשיו.
עדכון
‫
Modifies a playlist item. לדוגמה, אפשר לעדכן את המיקום של הפריט בפלייליסט. כדאי לנסות עכשיו.
מחיקה
מחיקת פריט בפלייליסט. כדאי לנסות עכשיו.

ייצוג משאבים

מבנה ה-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
הערכים התקפים של המפתח הם:
  • ‫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
האובייקט 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.