דף זה תורגם על ידי Cloud Translation API.

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

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

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

קוראים ל-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

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

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

שלב 1: אחזור של מזהה הערוץ

אפשר להפעיל את השיטה channels.list כדי לאחזר את מזהה הערוץ המשויך לשם משתמש מסוים ב-YouTube. (בדוגמה הזו שם המשתמש הוא GoogleDevelopers). בתשובה מה-API, הנכס id מזהה את מזהה הערוץ.
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.channels.list?
        part=id
        &forUsername=GoogleDevelopers
```
שלב 2: אחזור הפלייליסטים של הערוץ

קוראים לשיטה playlists.list כדי לאחזר את הפלייליסטים של הערוץ. מגדירים את ערך הפרמטר channelId לערך שמתקבל בשלב 1.
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.list?
        part=snippet,contentDetails
        &channelId=UC_x5XG1OV2P6uZZ5FSM9Ttw
```

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

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

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

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

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

בדוגמה הזו קוראת לשיטה playlists.insert ליצירת פלייליסט פרטי בערוץ של המשתמש המאומת. כל בקשת API ל-method הזה חייבת לקבל הרשאה באמצעות 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: עדכון פלייליסט

קריאה ל-method playlists.update כדי לשנות פלייליסט ספציפי. השיטה הזו דורשת אסימון הרשאה חוקי מסוג OAuth 2.0.

גוף הבקשה חייב לכלול את החלק snippet של המשאב playlist כי המאפיין snippet.title נדרש בעת קריאה ל-method הזה. בנוסף, אם המשאב של הפלייליסט שמתעדכן מציין ערכים לנכסים snippet.description או snippet.tags, צריך לציין מחדש את הערכים האלה בבקשת העדכון, אחרת הם יימחקו.
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.update?
        part=snippet,status
```
כמו בדוגמה שלמעלה להוספת פלייליסט, הקישור ל-APIs 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"
  }
}
```
הערה: אם אתם בודקים את השאילתה הזו ב-APIs 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"
    }
  }
}
```
כדי להשלים את הבקשה ב-APIs Explorer, צריך להגדיר ערכים לנכסים snippet.playlistId ולנכסים snippet.resourceId.videoId.
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.insert?
        part=snippet
```
הערה: התיעוד של השיטה playlistItems.insert מפרט את ערכי המאפיינים האחרים שאפשר להגדיר כשמוסיפים פריט בפלייליסט.

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

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

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

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

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

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

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

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

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

מפעילים את השיטה 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
  }
}
```
כדי להשלים את הבקשה ב-APIs Explorer, צריך להגדיר ערכים לנכסים id, snippet.playlistId ו-snippet.resourceId.videoId.
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistItems.update?
        part=snippet
```

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

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

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

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

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

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

כדי להשלים את הבקשה ב-APIs 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. אם בודקים את השאילתה הזו ב-APIs Explorer, צריך להחליף את ערך הפרמטר id במזהה פלייליסט תקין.
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlistImages.delete?
        id=ID
```
הערה: אם אתם בודקים את השאילתה הזו ב-APIs Explorer, תצטרכו להחליף את ערך הפרמטר id במזהה תמונה חוקי של פלייליסט.

איך מסירים פלייליסט

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

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

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

קריאה ל-method playlists.delete כדי למחוק פלייליסט ספציפי. בבקשה, הפרמטר id מציין את מזהה הפלייליסט של הפלייליסט שמוחקים. השיטה הזו דורשת אסימון הרשאה חוקי מסוג OAuth 2.0. אם בודקים את השאילתה הזו ב-APIs Explorer, צריך להחליף את ערך הפרמטר id במזהה פלייליסט תקין.
```
https://developers.google.com/apis-explorer/#p/youtube/v3/youtube.playlists.delete?
        id=PLAYLIST_ID
```
הערה: אם אתם בודקים את השאילתה הזו ב-APIs Explorer, תצטרכו להחליף את ערך הפרמטר id במזהה פלייליסט חוקי. כדי לקבל מזהה פלייליסט, מומלץ להריץ תחילה את הבקשה שמוצגת למעלה להוספת פלייליסט. מחלצים את מזהה הפלייליסט מתגובת ה-API, ומשתמשים בערך הזה בפלייליסט שרוצים למחוק.