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
התג של המשאב הזה.
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
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
התיאור של הפלייליסט המותאם לשוק המקומי.