Playlists

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

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

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

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

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

שיטות

ה-API תומך בשיטות הבאות למשאבים של 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
  },
  "contentDetails": {
    "itemCount": unsigned integer
  },
  "player": {
    "embedHtml": string
  },
  "localizations": {
    (key): {
      "title": string,
      "description": string
    }
  }
}

תכונות

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

תכונות
kind	string מזהה את הסוג של משאב ה-API. הערך יהיה youtube#playlist.
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.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
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 תיאור הפלייליסט שהותאם לשוק המקומי.