PlaylistItems: update

שינוי של פריט בפלייליסט. לדוגמה, אפשר לעדכן את מיקום הפריט בפלייליסט.

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

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

בקשה

בקשת HTTP

PUT 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, זמני ההתחלה והסיום של פריט הפלייליסט יעודכנו לערך שצוין בגוף הבקשה. אם בגוף הבקשה לא יצוינו ערכים, זמני ההתחלה והסיום הקיימים יוסרו ויוחלפו בהגדרות ברירת המחדל.

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

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

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

גוף הבקשה

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

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

    • id
    • snippet.playlistId
    • snippet.resourceId

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

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

    אם שולחים בקשה לעדכון, ובבקשה לא מצוין ערך לנכס שכבר יש לו ערך, הערך הקיים של הנכס יימחק.

תשובה

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) playlistItemsNotAccessible הבקשה אינה מורשית כראוי לעדכן את פריט הפלייליסט שצוין.
invalidValue (400) invalidPlaylistItemPosition הבקשה מנסה להגדיר את מיקום הפריט בפלייליסט לערך לא חוקי או לא נתמך. צריך לבדוק את הערך של המאפיין position ב-snippet של המשאב.
invalidValue (400) invalidResourceType הערך type שצוין עבור מזהה המשאב לא נתמך בפעולה הזו. מזהה המשאב מזהה את הפריט שיתווסף לפלייליסט – למשל youtube#video.
invalidValue (400) invalidSnippet הבקשה לא מציינת מאפיין snippet חוקי.
invalidValue (400) manualSortRequired הבקשה מנסה להגדיר את מיקום הפריט בפלייליסט, אבל הפלייליסט לא כולל מיון ידני. (לדוגמה, פריטים בפלייליסט עשויים להיות ממוינים לפי תאריך או פופולריות). כדי לטפל בשגיאה, אפשר להסיר את הרכיב snippet.position מהמשאב שהבקשה מכניסה. אם רוצים שפריט הפלייליסט יקבל מיקום מסוים ברשימה, צריך קודם לעדכן את האפשרות סידור של הפלייליסט לידני בהגדרות הפלייליסט. אפשר לשנות את ההגדרות האלה במנהל הסרטונים של YouTube.
notFound (404) playlistItemNotFound לא ניתן למצוא את הפריט בפלייליסט שזוהה בנכס id של הבקשה.
notFound (404) playlistNotFound לא ניתן למצוא את הפלייליסט שזוהה עם הפרמטר playlistId של הבקשה.
required (400) channelIdRequired הבקשה לא מציינת ערך למאפיין channelId הנדרש.
required (400) playlistIdRequired הבקשה לא מציינת ערך למאפיין playlistId הנדרש.
required (400) playlistItemIdRequired משאב הפריט של הפלייליסט שצוין בבקשה חייב להשתמש במאפיין id כדי לזהות את הפריט בפלייליסט שמתעדכן.
invalidValue (400) playlistOperationUnsupported ממשק ה-API לא תומך באפשרות לעדכן סרטונים בפלייליסט שצוין. לדוגמה, אי אפשר לעדכן סרטון בפלייליסט של הסרטונים שהעליתם.

רוצה לנסות?

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