Playlists

משאב playlist מייצג פלייליסט ב-YouTube. פלייליסט הוא אוסף של סרטונים שאפשר לצפות בהם ברצף ולשתף עם משתמשים אחרים. כברירת מחדל, פלייליסטים גלויים לכולם, אבל אפשר להגדיר אותם כגלויים לכולם או כפרטיים.

מערכת YouTube משתמשת גם בפלייליסטים כדי לזהות אוספים מיוחדים של סרטונים בערוץ, כמו:

  • סרטונים שהועלו
  • סרטונים שקיבלו דירוג חיובי (סימון לייק)
באופן ספציפי יותר, הרשימות האלה משויכות לערוץ, שהוא אוסף של סרטונים, פלייליסטים ומידע אחר ב-YouTube של אדם, קבוצה או חברה. אפשר לאחזר את מזהי הפלייליסטים של כל אחת מהרשימות האלה מהכרטיסייה channel resource של ערוץ נתון.

לאחר מכן תוכלו להשתמש בשיטה playlistItems.list כדי לאחזר כל אחת מהרשימות האלה. אפשר גם להוסיף פריטים לרשימות האלה או להסיר מהן פריטים באמצעות הקריאה לשיטות playlistItems.insert ו-playlistItems.delete.

Methods

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

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

ייצוג משאבים

מבנה ה-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,
    "podcastStatus": enum
  },
  "contentDetails": {
    "itemCount": unsigned integer
  },
  "player": {
    "embedHtml": string
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

מאפיינים

בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:

מאפיינים
kind ‫string
מזהה את סוג משאב ה-API. הערך יהיה youtube#playlist.
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.tags[] list
הנכס הזה יצא משימוש.

תגי מילות מפתח שמשויכים לפלייליסט.
snippet.defaultLanguage string
השפה של הטקסט במאפיינים snippet.title ו-snippet.description של רכיב playlist.
snippet.localized ‫object
האובייקט snippet.localized מכיל שם ותיאור של הפלייליסט בשפה המקומית או את השם בשפת ברירת המחדל של המטא-נתונים של הפלייליסט.
  • אם בבקשת playlists.list נעשה שימוש בפרמטר hl כדי לציין שפה שבה צריך להחזיר טקסט שעבר לוקליזציה ויש טקסט שעבר לוקליזציה בשפה הזו, הטקסט הזה יוחזר בקטע הקוד של המשאב.
  • מטא-נתונים של השפה שמוגדרת כברירת מחדל מוחזרים אם לא מציינים ערך לפרמטר hl או אם מציינים ערך אבל מטא-נתונים מותאמים לשוק המקומי לא זמינים בשפה שצוינה.
הנכס מכיל ערך לקריאה בלבד. משתמשים באובייקט localizations כדי להוסיף, לעדכן או למחוק שמות מקומיים.
snippet.localized.title string
שם הפלייליסט שמותאם לשוק המקומי.
snippet.localized.description string
תיאור הפלייליסט שמותאם לשוק המקומי.
status ‫object
אובייקט status מכיל מידע על הסטטוס של הפלייליסט.
status.privacyStatus string
סטטוס הפרטיות של הפלייליסט.

הערכים התקפים של המאפיין הזה הם:
  • private
  • public
  • unlisted
status.podcastStatus string
סטטוס הפודקאסט של הפלייליסט. אם הערך הוא enabled, הפלייליסט מסומן כסדרת פודקאסטים. כדי להגדיר את סטטוס הפודקאסט של פלייליסט לערך enabled, הפלייליסט צריך לכלול תמונה לפלייליסט.

הערכים התקינים של המאפיין הזה הם:
  • enabled
  • disabled
  • unspecified
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
תיאור הפלייליסט שמותאם לשוק המקומי.