Playlists: update

שינוי פלייליסט. לדוגמה, אפשר לשנות את השם, התיאור או סטטוס הפרטיות של פלייליסט.

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

תרחישים נפוצים

שליחת בקשה

בקשת HTTP

PUT https://www.googleapis.com/youtube/v3/playlists

הרשאה

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

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

פרמטרים

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

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

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

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

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

גוף הבקשה

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

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

    • id
    • snippet.title

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

    • snippet.title
    • snippet.description
    • status.privacyStatus
    • snippet.defaultLanguage
    • localizations.(key)
    • localizations.(key).title
    • localizations.(key).description

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

תשובה

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
badRequest (400) defaultLanguageNotSetError צריך להגדיר את defaultLanguage כדי לעדכן את localizations.
badRequest (400) localizationValidationError אחד מהערכים באובייקט ההתאמה לשוק המקומי נכשל באימות. משתמשים בשיטה playlists.list כדי לאחזר ערכים חוקיים, ומקפידים לעדכן אותם בהתאם להנחיות שמפורטות בתיעוד המשאבים בנושא פלייליסטים.
forbidden (403) playlistForbidden הפעולה הזו אסורה או שהבקשה לא אושרה כראוי.
invalidValue (400) invalidPlaylistSnippet הבקשה מספקת קטע טקסט לא חוקי לפלייליסט.
notFound (404) playlistNotFound לא ניתן למצוא את הפלייליסט שמזוהה באמצעות הפרמטר id של הבקשה.
required (400) playlistTitleRequired הבקשה חייבת לכלול כותרת לפלייליסט.
invalidValue (400) playlistOperationUnsupported ממשק ה-API לא תומך באפשרות לעדכן את הפלייליסט שצוין. לדוגמה, אי אפשר לעדכן את המאפיינים של הפלייליסט עם הסרטונים שהעליתם.

רוצה לנסות?

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