מעלה תמונה ממוזערת מותאמת אישית של סרטון ל-YouTube ומגדירה אותו לסרטון.
השיטה הזו תומכת בהעלאת מדיה. קבצים שהועלו חייבים לעמוד במגבלות הבאות:
- גודל הקובץ המקסימלי: 2MB
- סוגי MIME מקובלים של מדיה:
image/jpeg,image/png,application/octet-stream
ההשפעה על מכסה: לשיחה בשיטה הזו יש עלות מכסה של כ-50 יחידות.
תרחישים נפוצים לדוגמה
בקשה
בקשת HTTP
POST https://www.googleapis.com/upload/youtube/v3/thumbnails/set
הרשאה
לבקשה הזו נדרשת הרשאה עם היקף הרשאות אחד לפחות (מידע נוסף על אימות והרשאה).
| היקף |
|---|
https://www.googleapis.com/auth/youtubepartner |
https://www.googleapis.com/auth/youtube.upload |
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים הרשומים הם פרמטרים של שאילתה.
| פרמטרים | ||
|---|---|---|
| פרמטרים נדרשים | ||
videoId |
stringהפרמטר videoId מציין מזהה וידאו של YouTube שעבורו מופיעה התמונה הממוזערת המותאמת אישית. |
|
| פרמטרים אופציונליים | ||
onBehalfOfContentOwner |
stringהערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube. הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה להרשאה של הבקשה מזהים משתמש ב-YouTube CMS שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שבבעלותם ובניהולם של ערוצי YouTube רבים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, ללא צורך לספק פרטי כניסה לאימות לכל ערוץ בנפרד. חשבון ה-CMS בפועל שאיתו המשתמש מאמת צריך להיות מקושר לבעלי התוכן שצוינו ב-YouTube. |
|
גוף הבקשה
גוף הבקשה מכיל את התמונה הממוזערת שאתם מעלים. גוף הבקשה לא מכיל משאב thumbnail.
תשובה
אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:
{
"kind": "youtube#thumbnailSetResponse",
"etag": etag,
"items": [
thumbnail resource
]
}
מאפיינים
הטבלה הבאה מגדירה את המאפיינים שמופיעים במשאב הזה:
| מאפיינים | |
|---|---|
kind |
stringזיהוי הסוג של משאב ה-API. הערך יהיה youtube#thumbnailSetResponse. |
etag |
etagה-Etag של המשאב הזה. |
items[] |
listרשימה של תמונות ממוזערות. |
שגיאות
הטבלה הבאה מזהה הודעות שגיאה שה-API יכול להחזיר בתגובה לקריאה לשיטה הזו. לפרטים נוספים, כדאי לעיין במסמכי התיעוד בנושא הודעת שגיאה.
| סוג השגיאה | פרטי השגיאה | תיאור |
|---|---|---|
badRequest (400) |
invalidImage |
תוכן התמונה שסיפקת לא חוקי. |
badRequest (400) |
mediaBodyRequired |
הבקשה לא כוללת את תוכן התמונה. |
forbidden (403) |
forbidden |
לא ניתן להגדיר את התמונה הממוזערת לסרטון שצוין. יכול להיות שהבקשה לא אושרה כראוי. |
forbidden (403) |
forbidden |
למשתמש המאומת אין הרשאות להעלות תמונות ממוזערות מותאמות אישית לסרטונים ולהגדיר אותן. |
notFound (404) |
videoNotFound |
הסרטון שניסית להוסיף לו תמונה ממוזערת לא נמצא. צריך לבדוק את ערך הפרמטר videoId של הבקשה כדי לוודא שהוא נכון. |
tooManyRequests (429) |
uploadRateLimitExceeded |
הערוץ העלה יותר מדי תמונות ממוזערות לאחרונה. אפשר לנסות לשלוח את הבקשה שוב מאוחר יותר. |
רוצה לנסות?
צריך להשתמש ב-APIs Explorer כדי להפעיל את ה-API הזה ולראות את הבקשה והתגובה ל-API.