PlaylistItems: insert

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

השפעה על המכסה: קריאה ל-method הזה מנצלת 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.

גוף הבקשה

מציינים playlistItem resource בגוף הבקשה. במשאב הזה:

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

    • snippet.playlistId
    • snippet.resourceId

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

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

תשובה

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

שגיאות

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

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