הערה: בקטע ציות למדיניות למפתחים של YouTube תמצאו הנחיות ודוגמאות שיעזרו לכם לוודא שלקוחות ה-API שלכם פועלים בהתאם לחלקים ספציפיים בתנאים ובמדיניות של שירותי YouTube API (התנאים וההגבלות של ממשקי ה-API). המדריך מספק תובנות לגבי האופן שבו YouTube אוכף היבטים מסוימים של התנאים וההגבלות של ה-API, אבל הוא לא מחליף אף מסמך קיים.
המסמך הזה מגדיר דרישות פונקציונליות מינימליות ללקוחות API המיישמים או מספקים גישה לתכונות ספציפיות של שירותי YouTube API ("לקוחות API").
הדרישות וההנחיות האלה מבטיחות שלקוחות ה-API יספקו חוויית משתמש עקבית שמגנה על האינטרסים של משתמשי YouTube, בעלי התוכן והמפרסמים. הכללים האלה הם חלק בלתי נפרד מהתנאים וההגבלות של YouTube API, ויש לפעול על פיהם במהלך הפיתוח וההטמעה של לקוחות API.
הדרישות שבמסמך הזה צפויות להשתנות, כדי שנוכל להבטיח חוויית משתמש טובה יותר בתכונות הקיימות של YouTube. הן ישתנו גם בתגובה לתכונות החדשות והמעודכנות של YouTube. לפעמים, שינויים כאלה עשויים לחייב אתכם לעדכן את לקוחות ה-API כך שיענו על דרישות חדשות. היסטוריית הגרסאות של התנאים וההגבלות מתעדת כל שינוי, ולכן יש לבדוק את המסמך לעיתים קרובות, או להירשם לפיד ה-RSS שלו, כדי לוודא שתוכלי ללמוד במהירות על שינויים שעשויים להשפיע על לקוחות ה-API שלך.
בנוסף לדרישות שמפורטות במסמך הזה, מומלץ מאוד לפעול בהתאם לשיטות המומלצות שמתוארות במדיניות של שירותי YouTube API ומפורטות במקומות אחרים במסמכי התיעוד של שירותי YouTube API. גם אם השיטות האלה לא נחוצות במפורש, הן עוזרות ללקוחות ה-API להתאושש מהר יותר משגיאות ולבצע אופטימיזציה של השימוש במכסות אם הם משתמשים בשירותי YouTube API שמקצים מכסות. עם זאת, השיטות האלה עוזרות להבטיח את תקינות הסביבה העסקית של YouTube, ומעל הכול, לספק את החוויה הטובה ביותר שאפשר למשתמשים של לקוחות ה-API שלכם ובאפליקציות של YouTube.
הפעלת סרטון ונגן מוטמע של YouTube
הדרישות בקטע הזה קשורות באופן ספציפי לנגני YouTube מוטמעים. המדיניות של שירותי YouTube API כוללת גם מספר סעיפי מדיניות הרלוונטיים ללקוחות API שמפעילים תוכן אודיו-ויזואלי של YouTube.
גודל נגן YouTube מוטמע
נגנים מוטמעים חייבים לכלול אזור תצוגה של לפחות 200px על 200px. אם הנגן מציג פקדים, הוא צריך להיות גדול מספיק כדי להציג את הפקדים במלואם בלי לכווץ את אזור התצוגה מתחת לגודל המינימלי. מומלץ להשתמש בנגנים בפורמט 16:9 שיהיו ברוחב של 480 פיקסלים ובגובה של 270 פיקסלים לפחות.
הפעלה אוטומטית והפעלה באמצעות סקריפטים
הקטע הזה עוסק בהפעלות אוטומטיות. המדיניות חלה על נגנים מוטמעים ב-YouTube שמשתמשים בפרמטר autoplay של הנגן או מפעילים באופן פרוגרמטי הפעלה אוטומטית באמצעות שירות YouTube IFrame Player API, שירות YouTube Android Player API או שירות אחר של YouTube API.
-
נגנים מוטמעים שמפעילים סרטון באופן אוטומטי צריכים להתחיל את ההפעלה מיד עם טעינת הדף או מיד כאשר הנגן המוטמע נראה במלואו. עם זאת, לקוח API לא יכול להפעיל הפעלה אוטומטית עד שהנגן גלוי ויותר מחצי מהנגן גלוי בדף או במסך.
-
אסור שבדף או במסך יהיה יותר מנגן YouTube אחד שמפעיל תוכן בו-זמנית באופן אוטומטי.
-
כל תמונה ממוזערת של YouTube שמפעילה סרטון חייבת להיות ברוחב של לפחות 120 פיקסלים ואורך של 70 פיקסלים.
מאפייני נגן YouTube
מאפיינים ופרמטרים של נגן YouTube – כולל, לדוגמה, מראה המיתוג של YouTube בנגן – מפורטים במסמכי התיעוד והמפרטים של ממשק ה-API של YouTube (https://developers.google.com/youtube). אין לבצע שינויים בנגן YouTube שלא מתוארים במפורש במסמכי התיעוד של ה-API.
שכבות-על ומסגרות
אסור להציג שכבות-על, מסגרות או רכיבים חזותיים אחרים לפני חלק בנגן המוטמע של YouTube, כולל לחצני הנגן. באופן דומה, אסור להשתמש בשכבות-על, במסגרות או ברכיבים חזותיים אחרים כדי לטשטש חלקים בנגן מוטמע, כולל לחצני הנגן.
העברות סמן העכבר
אין להשתמש בהעברות עכבר או באירועי מגע בנגן YouTube כדי ליזום פעולה כלשהי מטעמו של המשתמש, כגון פתיחת חלון או הרשמה לערוץ.
העלאת סרטונים
אם לקוחות API מאפשרים למשתמשים להעלות תוכן לפלטפורמות מרובות, צריכה להיות למשתמשים אפשרות לבחור ולבטל את הבחירה בפלטפורמות שאליהן הם רוצים להעלות את הסרטונים שלהם.
הדרישות לגבי הנתונים
לקוחות API שמאפשרים למשתמשים להעלות סרטונים ל-YouTube חייבים לאפשר למשתמשים להגדיר את הערכים שברשימה הבאה. כל המאפיינים שלא מופיעים הם אופציונליים.
| שם | תיאור | |
|---|---|---|
| נכסי משאבים | ||
snippet.title |
נדרש. שם הסרטון. המערכת של YouTube מחזירה שגיאה אם הערך חורג מ-100 תווים. המערכת של YouTube תומכת בכל תווי UTF-8 התקפים, מלבד < ו->.
| |
snippet.description |
נדרש. תיאור הסרטון. המערכת של YouTube מחזירה שגיאה אם הערך גדול מ-5,000 בייטים. המערכת של YouTube תומכת בכל תווי UTF-8 התקפים, מלבד < ו->. |
|
status.privacyStatus |
נדרש. הגדרת הפרטיות של הסרטון. למשתמשים צריכה להיות אפשרות לבחור אם הסרטון שהם מעלים יהיה גלוי לכולם, פרטי או לא רשום. | |
| פרמטרים של בקשה | ||
onBehalfOfContentOwnerChannel |
נדרש תנאי. אם פרטי הכניסה להרשאה של הבקשה מזהים בעלי תוכן והפרמטר onBehalfOfContentOwner מוגדר, המשתמש ב-API צריך להיות מסוגל גם לציין את ערוץ YouTube שאליו הסרטון מועלה. |
|
מוצגות תגובות
| שם | תיאור | |
|---|---|---|
| נכסי משאבים | ||
snippet.textDisplay |
נדרש. הטקסט של התגובה. לקוח ה-API חייב (א) להציג את הטקסט המלא של תגובה או תשובה לתגובה, או (ב) לחתוך את הטקסט ולספק לצופה דרך לגשת בקלות לטקסט המלא מהגרסה הקטועה. הדרישה הזו חלה על כל התגובות והתשובות לתגובות, ללא קשר לסוג המשאב שאליו התגובות משויכות (סרטונים, ערוצים וכו'). לתשומת ליבך: ערך הנכס snippet.topLevelComment של המשאב commentThread הוא משאב comment והוא ערך replies.comments[] של המשאב comment. לכן הדרישה הזו חלה גם על הנכסים snippet.topLevelComment.snippet.textDisplay ו-replies.comments[].snippet.textDisplay. |
|
snippet.title( channel) |
חובה (הצעה). כותרת הערוץ.
|
|
snippet.title( video) |
נדרש תנאי (הצעה). שם הסרטון. יש להציג את הערך הזה אם התגובה מתייחסת לסרטון. | |
snippet.moderationStatus |
נדרש תנאי. אם ערך הפרמטר moderationStatus בבקשת ה-API הוא heldForReview או likelySpam, צריך לציין בבירור את הסטטוס הזה במסך באמצעות ערך הנכס, שפה דומה (למשל, 'התגובה הזו ממתינה לבדיקה'), כותרת (למשל, 'בהמתנה לבדיקה') או שפה חד-משמעית אחרת. השיטה commentThreads.list תומכת באפשרות לאחזר תגובות על סמך סטטוס הניהול שלהן. |
|
הוספת תגובות
| שם | תיאור | |
|---|---|---|
| נכסי משאבים | ||
snippet.title( channel) |
נדרש. כותרת הערוץ.
|
|
snippet.title( video) |
נדרש. אם המשתמש מוסיף תגובה לסרטון, לקוח ה-API חייב להציג את שם הסרטון. | |
| דרישות אחרות | ||
Comment author's channel name |
נדרש. לקוח ה-API חייב לזהות בבירור את חשבון המשתמש ב-YouTube שאליו התגובה תשויך. אם פרטי הכניסה של ההרשאה של הבקשה מזהים בעלי תוכן והפרמטר onBehalfOfContentOwner מוגדר, המשתמש ב-API צריך גם להיות מסוגל לציין את ערוץ YouTube שאליו התגובה תשויך. |
|
הוספת תשובות לתגובות
| שם | תיאור | |
|---|---|---|
| נכסי משאבים | ||
snippet.textDisplay |
נדרש. הטקסט של התגובה. לקוח ה-API חייב להציג את הטקסט של התגובה שעליה המשתמש משיב, בהתאם לכללים שמוגדרים בקטע הצגת תגובות במסמך הזה. | |
snippet.title( channel) |
נדרש. כותרת הערוץ.
|
|
snippet.title( video) |
נדרש. אם המשתמש משיב לתגובה לגבי סרטון, לקוח ה-API חייב להציג את כותרת הסרטון. | |
| דרישות אחרות | ||
Comment author's channel name |
נדרש. לקוח ה-API חייב לזהות בבירור את חשבון המשתמש ב-YouTube שאליו תשויך התשובה לתגובה. אם פרטי הכניסה להרשאה של הבקשה מזהים בעלי תוכן והפרמטר onBehalfOfContentOwner מוגדר, המשתמש ב-API צריך גם להיות מסוגל לציין את ערוץ YouTube שאליו תשויך התשובה לתגובה. |
|
עריכה או מחיקה של תשובות לתגובות
| שם | תיאור | |
|---|---|---|
| נכסי משאבים | ||
snippet.textDisplay |
נדרש. הטקסט של התגובה. לקוח ה-API חייב להציג את הטקסט של התגובה שהמשתמש עורך או מוחק, בהתאם לכללים שמוגדרים בקטע הצגת תגובות במסמך הזה. | |
snippet.title( channel) |
נדרש. כותרת הערוץ.
|
|
snippet.title( video) |
נדרש. אם המשתמש עורך או מוחק תגובה לסרטון, לקוח ה-API חייב להציג את שם הסרטון. | |
| דרישות אחרות | ||
Comment author's channel name |
נדרש. לקוח ה-API חייב לזהות בבירור את חשבון המשתמש ב-YouTube שאליו התגובה מיוחסת. | |
חסימת משתמש מצ'אט בשידור חי (או הסרת חסימה)
| שם | תיאור | |
|---|---|---|
| נכסי משאבים | ||
snippet.title( channel) |
נדרש. השם של ערוץ YouTube שנחסם או שהחסימה שלו בוטלה. בנוסף, השם חייב לקשר לערוץ או להציג גם את כתובת ה-URL של הערוץ. | |
| דרישות אחרות | ||
| שם הערוץ של מחבר התגובה | נדרש. לקוח ה-API צריך לזהות בבירור את חשבון המשתמש ב-YouTube שמשמש להוספה או להסרה של החסימה. | |