הטמעה: פלייליסטים

בדוגמאות הבאות מוסבר איך משתמשים ב-YouTube Data API (גרסה 3) כדי לבצע פונקציות שקשורות לפלייליסטים ולפריטים בפלייליסטים.

אחזור הפלייליסטים של המשתמש הנוכחי

קוראים ל-method ‏playlists.list כדי לאחזר את הפלייליסטים של המשתמש המאומת הנוכחי. בבקשה, מגדירים את הערך של הפרמטר mine כ-true. חשוב לזכור שצריך לאשר בקשה שמשתמשת בפרמטר mine באמצעות OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &mine=true

אחזור הפלייליסטים של משתמש

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

אחזור מידע על פלייליסט ספציפי

כדי לאחזר מידע על פלייליסט ספציפי אחד או יותר, צריך להפעיל את השיטה playlists.list ולהגדיר את הפרמטר id כרשימה של מזהי פלייליסטים ב-YouTube המופרדים בפסיקים, שמזהים את המשאבים הרצויים. דוגמה נפוצה לשימוש בפונקציה הזו היא בקשה לאחזר מידע נוסף על קבוצה של פלייליסטים שהוחזרו בקבוצה של תוצאות חיפוש. לדוגמה, יכול להיות שתרצו לאחזר את מספר הפריטים בכל פלייליסט.

הבקשה הבאה מפעילה את השיטה playlists.list כדי לאחזר את מספר הפריטים בשתי פלייליסטים שתואמים למונח השאילתה 'GoogleDevelopers'. המידע הזה נמצא במאפיין contentDetails.itemCount של המשאב playlist, ולכן הבקשה מגדירה את ערך הפרמטר part כ-contentDetails. 

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=contentDetails
        &id=PLOU2XLYxmsIIM9h1Ybw2DuRw6o2fkNMeR,PLyYlLs02rgBYRWBzYpoHz7m2SE8mEZ68w

הוספת פלייליסט

בדוגמה הזו קוראים ל-method‏ playlists.insert כדי ליצור פלייליסט פרטי בערוץ של המשתמש המאומת. כל בקשת API לשיטה הזו חייבת לקבל הרשאה באמצעות OAuth 2.0.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.insert?
        part=snippet,status

הקישור ל-APIs Explorer מגדיר גם פרמטר שמציין את גוף הבקשה ל-API. גוף הבקשה מכיל משאב playlist שמגדיר מידע כמו השם, התיאור וסטטוס הפרטיות של הפלייליסט. בדוגמה הזו, גוף הבקשה הוא:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "private"
  }
}

בדוגמה הבאה, הפלייליסט החדש מסומן כתוכנית פודקאסט:

{
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

דוגמאות קוד קשורות: Java, ‏ JavaScript, ‏ ‎.NET, ‏ PHP, ‏ Python

עדכון פלייליסט

בדוגמה הזו מעדכנים את סטטוס הפרטיות של פלייליסט מ-private ל-public. הדוגמה כוללת שני שלבים:

  • שלב 1: אחזור מזהה הפלייליסט

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

  • שלב 2: עדכון פלייליסט

    כדי לשנות פלייליסט ספציפי, קוראים לשיטה playlists.update. בשיטה הזו נדרש אסימון הרשאה תקף מסוג OAuth 2.0.

    גוף הבקשה חייב לכלול את החלק snippet של המשאב playlist, כי המאפיין snippet.title נדרש בקריאה לשיטה הזו. בנוסף, אם במשאב הפלייליסט שמתעדכן מצוינים ערכים למאפיינים snippet.description או snippet.tags, צריך לציין מחדש את הערכים האלה בבקשת העדכון, אחרת הם יימחקו.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status

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

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}

    בדוגמה הבאה, הפלייליסט מסומן כתוכנית פודקאסט:

    {
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "podcastStatus": "enabled"
  }
}

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

הוספת פריט לפלייליסט

בדוגמה הזו מוצגת הוספה של פריט לפלייליסט. צריך לאשר את הבקשה הזו באמצעות OAuth 2.0. בדוגמה הזו יש שני שלבים:

  • שלב 1: אחזור מזהה הפלייליסט המתאים

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

  • שלב 2: מוסיפים סרטון לפלייליסט

    כדי להוסיף סרטון לפלייליסט, צריך להפעיל את השיטה playlistItems.insert. צריך לאשר את הבקשה הזו באמצעות OAuth 2.0. גוף הבקשה הוא משאב playlistItem שמציין לפחות את הערכים הבאים:

    • השדה snippet.playlistId מזהה את הפלייליסט שאליו רוצים להוסיף את הסרטון. זהו מזהה הפלייליסט שקיבלתם בשלב 1.
    • השדה snippet.resourceId.kind מכיל את הערך youtube#video.
    • השדה snippet.resourceId.videoId מזהה את הסרטון שרוצים להוסיף לפלייליסט. ערך הנכס הוא מזהה סרטון ייחודי ב-YouTube.

    בקשת ה-API שבהמשך מוסיפה סרטון לפלייליסט. גוף הבקשה הוא:

    {
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    }
  }
}

    כדי להשלים את הבקשה ב-API Explorer, צריך להגדיר ערכים לנכסים snippet.playlistId ו-snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet

    הערה: במסמכי העזרה של השיטה playlistItems.insert מפורטים שאר ערכי המאפיינים שאפשר להגדיר כשמוסיפים פריט לפלייליסט.

הוספת תמונה לפלייליסט

אפשר להשתמש בשיטה playlistImages.insert של ה-API בגרסה 3 כדי להעלות תמונה ממוזערת בהתאמה אישית ולהגדיר אותה לפלייליסט. הערך של הפרמטר playlistId בבקשה מזהה את הפלייליסט שבו תמונה הממוזערת תשמש.

לא ניתן לבדוק את השאילתה הזו באמצעות API Explorer כי אין ב-API Explorer תמיכה בהעלאת קובצי מדיה, וזו דרישה לשיטה הזו.

עדכון פריט בפלייליסט

בדוגמה הזו מעדכנים פריט בפלייליסט כך שיהיה הפריט הראשון בפלייליסט. צריך לאשר את הבקשה הזו באמצעות OAuth 2.0. הדוגמה הזו כוללת שלושה שלבים:

  • שלב 1: אחזור מזהה הפלייליסט המתאים

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

  • שלב 2: אחזור הפריטים בפלייליסט שנבחר

    קוראים ל-method‏ playlistItems.list כדי לאחזר את רשימת הסרטונים בפלייליסט שנבחר. מגדירים את הערך של הפרמטר playlistId למזהה הפלייליסט שקיבלתם בשלב 1.

    כל משאב בתשובה מה-API מכיל את המאפיין id, שמזהה את מזהה הפריט בפלייליסט שמזהה את הפריט באופן ייחודי. בשלב הבא תשתמשו בערך הזה כדי להסיר פריט מהרשימה.

  • שלב 3: מעדכנים את הפריט שנבחר בפלייליסט

    כדי לשנות את המיקום של הסרטון בפלייליסט, קוראים ל-method‏ playlistItems.update. מגדירים את ערך הפרמטר part לערך snippet. גוף הבקשה חייב להיות משאב playlistItem שמגדיר לפחות את הערכים הבאים:

    • מגדירים את המאפיין id למזהה הפריט בפלייליסט שהתקבל בשלב 2.
    • מגדירים את המאפיין snippet.playlistId למזהה הפלייליסט שהתקבל בשלב 1.
    • מגדירים את המאפיין snippet.resourceId.kind לערך youtube#video.
    • מגדירים את המאפיין snippet.resourceId.videoId למזהה הווידאו שמזהה באופן ייחודי את הסרטון שכלול בפלייליסט.
    • מגדירים את המאפיין snippet.position לערך 0 או למיקום שבו רוצים שהפריט יופיע (באמצעות אינדקס שמתחיל ב-0).

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

    {
  "id": "PLAYLIST_ITEM_ID",
  "snippet": {
    "playlistId": "PLAYLIST_ID",
    "resourceId": {
      "kind": "youtube#video",
      "videoId": "VIDEO_ID"
    },
    "position": 0
  }
}

    כדי להשלים את הבקשה ב-API Explorer, צריך להגדיר ערכים לנכסים id, ‏ snippet.playlistId ו-snippet.resourceId.videoId.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet

עדכון התמונה של פלייליסט

אפשר להשתמש בשיטה playlistImages.update של ה-API בגרסה 3 כדי לעדכן את התמונה הממוזערת של פלייליסט. הערך של הפרמטר playlistId בבקשה מזהה את הפלייליסט שבו תמונה הממוזערת תשמש.

לא ניתן לבדוק את השאילתה הזו באמצעות API Explorer כי אין ב-API Explorer תמיכה בהעלאת קובצי מדיה, וזו דרישה לשיטה הזו.

הסרת פריט מפלייליסט

בדוגמה הזו מוחקים סרטון מפלייליסט. צריך לאשר את הבקשה הזו באמצעות OAuth 2.0. בדוגמה הזו יש שלושה שלבים. שני השלבים הראשונים זהים לאלה שמפורטים בדוגמה שלמעלה לעדכון פריט בפלייליסט.

אחרי שמבצעים את השלבים האלה, צריך להפעיל את השיטה playlistItems.delete כדי להסיר סרטון מהפלייליסט. מגדירים את הפרמטר id בבקשה למזהה הפריט בפלייליסט של הפריט שרוצים להסיר. צריך לאשר את הבקשה הזו באמצעות OAuth 2.0.

חשוב לזכור שמזהה הפריט בפלייליסט המשמש לזיהוי סרטון בפלייליסט שונה ממזהה הווידאו ב-YouTube שמזהה את הסרטון באופן ייחודי. מזהה הפריט בפלייליסט מזהה את הסרטון כפריט בפלייליסט מסוים.

כדי להשלים את הבקשה ב-API Explorer, צריך להגדיר את הערך של נכס id.

https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.delete?
        id=PLAYLIST_ITEM_ID

איך מסירים תמונה של פלייליסט

בדוגמה הזו מוחקת תמונה של פלייליסט. הדוגמה כוללת שני שלבים:

  • שלב 1: אחזור הפלייליסט

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

  • שלב 2: אחזור מזהה התמונה של הפלייליסט

    קוראים לשיטה playlistImages.list כדי לאחזר את התמונה הממוזערת של פלייליסט. משתמשים במזהה הפלייליסט שרוצים לשנות.

  • שלב 3: מחיקת תמונה של פלייליסט

    כדי למחוק תמונה ספציפית של פלייליסט, קוראים ל-method‏ playlistImages.delete. בבקשה, הפרמטר id מציין את המזהה של תמונת הפלייליסט שנמחקת. בשיטה הזו נדרש אסימון הרשאה תקף מסוג OAuth 2.0. אם בודקים את השאילתה הזו ב-API Explorer, צריך להחליף את ערך הפרמטר id במזהה פלייליסט תקין.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
        id=ID

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

הסרת פלייליסט

בדוגמה הזו מוחקים פלייליסט. הדוגמה כוללת שני שלבים:

  • שלב 1: אחזור מזהה הפלייליסט

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

  • שלב 2: מחיקת פלייליסט

    כדי למחוק פלייליסט ספציפי, קוראים ל-method‏ playlists.delete. בבקשה, הפרמטר id מציין את מזהה הפלייליסט שנמחק. בשיטה הזו נדרש אסימון הרשאה תקף מסוג OAuth 2.0. אם בודקים את השאילתה הזו ב-API Explorer, צריך להחליף את ערך הפרמטר id במזהה פלייליסט תקין.

    https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID

    הערה: אם אתם בודקים את השאילתה הזו ב-API Explorer, תצטרכו להחליף את ערך הפרמטר id במזהה פלייליסט תקין. כדי לקבל מזהה פלייליסט, מומלץ קודם להריץ את הבקשה שמוצגת למעלה להוספת פלייליסט. מחלצים את מזהה הפלייליסט מהתגובה של ה-API ומשתמשים בערך הזה לפלייליסט שרוצים למחוק.