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

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

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

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

יש להפעיל את השיטה 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 לאחזור מספר הפריטים בשני פלייליסטים שתואמים למונח השאילתה "GoogleDevelopers". המידע הזה נמצא בנכס 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 לשיטה הזו חייבת להיות מורשית באמצעות 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"
  }
}

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

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

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

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

יש להפעיל את השיטה playlist.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
```
כמו בדוגמה שלמעלה להוספת פלייליסט, הקישור ל-APIs Explorer מגדיר פרמטר שמציין את גוף הבקשה ל-API. גוף הבקשה מכיל משאב playlist, שמגדיר מידע כמו השם, התיאור וסטטוס הפרטיות של הפלייליסט. בדוגמה זו נעשה שימוש בגוף הבקשה הבא:
```
{
  "id": "PLAYLIST_ID",
  "snippet": {
    "title": "New playlist",
    "description": "New playlist description"
  },
  "status": {
    "privacyStatus": "public"
  }
}
```
הערה: אם בודקים את השאילתה הזו ב-APIs Explorer, יש להחליף מזהה פלייליסט חוקי בגוף המשאב. כדי לקבל מזהה פלייליסט, מומלץ קודם כל להריץ את הבקשה המוצגת למעלה להוספת פלייליסט. חלץ את מזהה הפלייליסט מהתגובה ל-API והשתמש בערך הזה עבור הפלייליסט שברצונך לעדכן. הכותרת והתיאור של הפלייליסט שבהם נעשה שימוש בדוגמה זו זהים לאלה שמופיעים בדוגמה זו.

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

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

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

יש להפעיל את השיטה playlist.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 מזהה את ערכי הנכס האחרים שאפשר להגדיר כשמוסיפים פריט לפלייליסט.

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

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

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

יש להפעיל את השיטה playlist.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
```

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

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

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

צריך להפעיל את השיטה 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 והשתמש בערך עבור הפלייליסט שברצונך למחוק.