מעלה תמונה של סימן מים ל-YouTube ומגדיר אותה לערוץ.
השיטה הזו תומכת בהעלאת מדיה. הקבצים שמעלים צריכים לעמוד במגבלות הבאות:
- גודל קובץ מקסימלי: 10MB
- סוגי MIME של מדיה שמתקבלים:
image/jpeg,image/png,application/octet-stream
השפעה על המכסה: העלות של קריאה לשיטה הזו היא 50 יחידות מכסה.
בקשה
בקשת HTTP
POST https://www.googleapis.com/upload/youtube/v3/watermarks/set
אישור
כדי לבצע את הבקשה הזו, צריך להעניק הרשאה עם אחת מההיקפים הבאים. למידע נוסף על אימות ומתן הרשאות, אפשר לעיין במאמר הטמעה של הרשאות OAuth 2.0.
| היקף |
|---|
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 |
פרמטרים
בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים שמופיעים ברשימה הם פרמטרים של שאילתות.
| פרמטרים | ||
|---|---|---|
| פרמטרים נדרשים | ||
channelId |
stringהפרמטר channelId מציין את מזהה הערוץ ב-YouTube שעבורו מסופק סימן המים. |
|
| פרמטרים אופציונליים | ||
onBehalfOfContentOwner |
stringהערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן ב-YouTube. הפרמטר onBehalfOfContentOwner מציין שאמצעי ההזדהות של ההרשאה שמוגדרים בבקשה מזהים משתמש ב-YouTube CMS, שפועל בשם בעל התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן ב-YouTube שהם הבעלים של ערוצי YouTube רבים ומנהלים אותם. הכלי מאפשר לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוצים שלהם, בלי לספק פרטי אימות לכל ערוץ בנפרד. החשבון במערכת ניהול התוכן שהמשתמש מאמת צריך להיות מקושר לבעלי התוכן ב-YouTube שצוינו. |
|
גוף הבקשה
מציינים משאב watermark בגוף הבקשה. המשאב מכיל את המאפיינים הבאים:
-
timing(object, חובה): מציין את התזמון של הצגת סימן המים.-
timing.type(string, חובה): הערך צריך להיותoffsetFromStartאוoffsetFromEnd. -
timing.offsetMs(unsigned long, חובה): היסטור התחלה באלפיות השנייה. אם הערך שלtypeהואoffsetFromEnd, הערך של חייב להיות לפחות1000אלפיות השנייה. -
timing.durationMs(unsigned long, אופציונלי): משך הזמן שבו המודעה מוצגת, באלפיות השנייה (מינימום1000אלפיות השנייה). אם הערך שלtypeהואoffsetFromEnd, הערך לא יכול להיות גדול מ-offsetMs.
-
-
targetChannelId(string, אופציונלי): מזהה הערוץ ב-YouTube שאליו סימן המים מקשר. אם התג הזה לא מצוין, הקישורים יהיו לערוץ שמזוהה על ידיchannelId. -
position(object, הוצא משימוש): המערכת של YouTube מתעלמת מהערך הזה. סימני מים תמיד ממוקמים בפינה השמאלית העליונה.
תשובה
אם הפעולה בוצעה ללא שגיאות, השיטה הזו מחזירה קוד סטטוס HTTP 204 No Content.
שגיאות
בטבלה הבאה מפורטות הודעות השגיאה שה-API יכול להחזיר בתגובה לקריאה של השיטה הזו. פרטים נוספים זמינים במאמר YouTube Data API – שגיאות.
| סוג השגיאה | פרטי השגיאה | תיאור |
|---|---|---|
badRequest (400) |
imageFormatUnsupported |
התמונה שסיפקת היא בפורמט שלא נתמך. |
badRequest (400) |
imageTooTall |
התמונה ששלחת גבוהה מדי. |
badRequest (400) |
imageTooWide |
התמונה שצירפת רחבה מדי. |
badRequest (400) |
mediaBodyRequired |
הבקשה לא כוללת את תוכן התמונה. |
forbidden (403) |
forbidden |
אי אפשר להגדיר את סימן המים לערוץ שצוין. יכול להיות שהבקשה לא אושרה כראוי, או שהפרמטר channelId מוגדר לערך לא תקין. |
רוצה לנסות?
משתמשים ב-APIs Explorer כדי להפעיל את ה-API הזה ולראות את בקשת ה-API והתגובה.