PlaylistItems: insert

הוספת משאב לפלייליסט.

ההשפעה של המכסה: קריאה לשיטה הזו כוללת עלות מכסה של 50 יחידות.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

POST https://www.googleapis.com/youtube/v3/playlistItems

אישור

בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/youtubepartner
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.

פרמטרים
הפרמטרים הנדרשים
part string
הפרמטר part משרת שתי מטרות בפעולה זו. היא מזהה את המאפיינים שפעולת הכתיבה תגדיר, וגם את המאפיינים שייכללו בתגובת ה-API.

הרשימה הבאה מכילה את שמות part שניתן לכלול בערך הפרמטר:
  • contentDetails
  • id
  • snippet
  • status
פרמטרים אופציונליים
onBehalfOfContentOwner string
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

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

גוף הבקשה

יש לספק משאב KMLItem בגוף הבקשה. במשאב הזה:

  • צריך לציין ערך למאפיינים הבאים:

    • snippet.playlistId
    • snippet.resourceId

  • ניתן להגדיר ערכים למאפיינים הבאים:

    • snippet.playlistId
    • snippet.position
    • snippet.resourceId
    • contentDetails.note
    • contentDetails.startAt
    • contentDetails.endAt

תשובה

אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה משאב KMLItem בגוף התשובה.

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) playlistContainsMaximumNumberOfVideos הפלייליסט כבר מכיל את מספר הפריטים המקסימלי.
forbidden (403) playlistItemsNotAccessible הבקשה אינה מורשית כראוי להוסיף את פריט הפלייליסט שצוין.
invalidValue (400) invalidContentDetails המאפיין contentDetails בבקשה לא חוקי. סיבה אפשרית לכך היא שהשדה contentDetails.note ארוך מ-280 תווים.
invalidValue (400) invalidPlaylistItemPosition הבקשה מנסה להגדיר את מיקום הפריט בפלייליסט לערך לא חוקי או לא נתמך. צריך לבדוק את הערך של המאפיין position ב-snippet של המשאב.
invalidValue (400) invalidResourceType הערך type שצוין עבור מזהה המשאב לא נתמך בפעולה הזו. מזהה המשאב מזהה את הפריט שיתווסף לפלייליסט – למשל youtube#video.
invalidValue (400) manualSortRequired הבקשה מנסה להגדיר את מיקום הפריט בפלייליסט, אבל הפלייליסט לא כולל מיון ידני. (לדוגמה, פריטים בפלייליסט עשויים להיות ממוינים לפי תאריך או פופולריות). כדי לטפל בשגיאה, אפשר להסיר את הרכיב snippet.position מהמשאב שהבקשה מכניסה. אם רוצים שפריט הפלייליסט יקבל מיקום מסוים ברשימה, צריך קודם לעדכן את האפשרות סידור של הפלייליסט לידני בהגדרות הפלייליסט. אפשר לשנות את ההגדרות האלה במנהל הסרטונים של YouTube.
invalidValue (400) videoAlreadyInAnotherSeriesPlaylist הסרטון שאתם מנסים להוסיף לפלייליסט כבר נמצא בפלייליסט של סדרה אחרת.
notFound (404) playlistNotFound לא ניתן למצוא את הפלייליסט שזוהה עם הפרמטר playlistId של הבקשה.
notFound (404) videoNotFound הסרטון שניסית להוסיף לפלייליסט לא נמצא. יש לבדוק את הערך של המאפיין videoId כדי לוודא שהוא נכון.
required (400) channelIdRequired הבקשה לא מציינת ערך למאפיין channelId הנדרש.
required (400) playlistIdRequired הבקשה לא מציינת ערך למאפיין playlistId הנדרש.
required (400) resourceIdRequired הבקשה חייבת להכיל משאב שבו האובייקט snippet מציין resourceId.
invalidValue (400) playlistOperationUnsupported ממשק ה-API לא תומך באפשרות להוסיף סרטונים לפלייליסט שצוין. לדוגמה: אי אפשר להוסיף סרטון לפלייליסט של הסרטונים שהעליתם.

רוצה לנסות?

משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.