Playlists

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

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

• סרטונים שהועלו
• סרטונים עם דירוג חיובי (עם לייק)

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

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

שיטות

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

list

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

הוספה

יצירת פלייליסט. כדאי לנסות עכשיו.

עדכון

משנה פלייליסט. למשל: אתם יכולים לשנות את השם, התיאור או סטטוס הפרטיות של פלייליסט. כדאי לנסות עכשיו.

מחיקה

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

ייצוג משאבים

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