שירותי YouTube API – הפונקציונליות המינימלית הנדרשת

הערה: במאמר תאימות למדיניות למפתחים של 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

נגנים מוטמעים חייבים לכלול חלון תצוגה בגודל של לפחות 200 על 200 פיקסלים. אם הנגן מציג לחצני בקרה, הוא חייב להיות גדול מספיק כדי להציג את הלחצנים במלואם בלי לכווץ את אזור התצוגה מתחת לגודל המינימלי. מומלץ להשתמש בנגנים ביחס גובה-רוחב של 16:9 ברוחב של לפחות 480 פיקסלים ובגובה של לפחות 270 פיקסלים.

הפעלה אוטומטית והפעלות לפי סקריפט

בקטע הזה נסביר על הפעלות אוטומטיות. היא חלה על נגנים מוטמעים של YouTube שמשתמשים בפרמטר הנגן autoplay או שמפעילים באופן פרוגרמטי הפעלה אוטומטית באמצעות שירות YouTube IFrame Player API או שירות אחר של YouTube API.

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

• אסור לכלול בדף או במסך יותר מנגן YouTube אחד שמפעיל תוכן בו-זמנית באופן אוטומטי.

• כל תמונה ממוזערת ב-YouTube שמפעילה הפעלה חייבת להיות ברוחב של 120 פיקסלים לפחות ובגובה של 70 פיקסלים לפחות.

מאפייני הנגן של YouTube

המאפיינים והפרמטרים של נגן YouTube – כולל, למשל, המראה של המיתוג של YouTube בנגן – מפורטים במסמכי העזרה ובמפרטים של YouTube API‏ (https://developers.google.com/youtube). אסור לבצע שינויים בנגן YouTube שלא מתוארים במפורש במסמכי התיעוד של ה-API.

שכבות-על ופריימים

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

העברות סמן העכבר

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

העלאת סרטונים

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

הדרישות לגבי הנתונים

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

	שם	תיאור
מאפייני המשאב
	snippet.title	נדרש. שם הסרטון. אם הערך חורג מ-100 תווים, מערכת YouTube מחזירה שגיאה. פלטפורמת YouTube תומכת בכל התווים התקינים של UTF-8, מלבד < ו->.
	snippet.description	נדרש. תיאור הסרטון. אם הערך חורג מ-5,000 בייטים, מערכת YouTube מחזירה שגיאה. פלטפורמת 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)	חובה (הצעה). שם הערוץ. אם התגובה קשורה לערוץ, לקוח ה-API צריך להציג את שם הערוץ. אם התגובה מתייחסת לסרטון, לקוח ה-API חייב להציג את שם הערוץ שהעלה את הסרטון.
	snippet.title (video)	חובה מותנה (הצעה). שם הסרטון. צריך להציג את הערך הזה אם התגובה קשורה לסרטון.
	snippet.moderationStatus	חובה מותנה. אם ערך הפרמטר moderationStatus בבקשת ה-API הוא heldForReview או likelySpam, בתצוגה צריך לציין בבירור את הסטטוס הזה באמצעות ערך הנכס, שפה דומה (למשל 'התגובה הזו מושהית לבדיקה'), כותרת (למשל 'בהמתנה לבדיקה') או שפה אחרת שאינה משתמעת לשתי פנים. השיטה commentThreads.list תומכת ביכולת לאחזר תגובות על סמך סטטוס הבקרה שלהן.

הוספת תגובות

	שם	תיאור
מאפייני המשאב
	snippet.title (channel)	נדרש. שם הערוץ. אם המשתמש מוסיף תגובה לגבי ערוץ, לקוח ה-API חייב להציג את שם הערוץ. אם המשתמש מוסיף תגובה לגבי סרטון, לקוח ה-API חייב להציג את שם הערוץ שהעלה את הסרטון.
	snippet.title (video)	נדרש. אם המשתמש מוסיף תגובה לגבי סרטון, לקוח ה-API חייב להציג את שם הסרטון.
דרישות נוספות
	Comment author's channel name	נדרש. לקוח ה-API צריך לציין בבירור את חשבון המשתמש ב-YouTube שאליו יוקצה התגובה. אם פרטי הכניסה של הבקשה מזהים בעל תוכן והפרמטר onBehalfOfContentOwner מוגדר, משתמש ה-API צריך גם להיות מסוגל לציין את ערוץ YouTube שאליו תשויך התגובה.

הוספת תשובות לתגובות

	שם	תיאור
מאפייני המשאב
	snippet.textDisplay	נדרש. הטקסט של התגובה. לקוח ה-API חייב להציג את הטקסט של התגובה שהמשתמש מגיב לה, בהתאם לכללים שמוגדרים בקטע הצגת תגובות במסמך הזה.
	snippet.title (channel)	נדרש. שם הערוץ. אם המשתמש משיב לתגובה לגבי ערוץ, לקוח ה-API חייב להציג את שם הערוץ. אם המשתמש משיב לתגובה על סרטון, לקוח ה-API חייב להציג את שם הערוץ שהעלה את הסרטון.
	snippet.title (video)	נדרש. אם המשתמש משיב לתגובה על סרטון, לקוח ה-API צריך להציג את שם הסרטון.
דרישות נוספות
	Comment author's channel name	נדרש. לקוח ה-API צריך לזהות בבירור את חשבון המשתמש ב-YouTube שאליו תשויך התשובה לתגובה. אם פרטי הכניסה של הבקשה מזהים בעל תוכן והפרמטר onBehalfOfContentOwner מוגדר, משתמש ה-API צריך גם להיות מסוגל לציין את ערוץ YouTube שאליו תשויך התשובה לתגובה.

עריכה או מחיקה של תשובות לתגובות

	שם	תיאור
מאפייני המשאב
	snippet.textDisplay	נדרש. הטקסט של התגובה. לקוח ה-API צריך להציג את הטקסט של התגובה שהמשתמש עורך או מחק בהתאם לכללים שמוגדרים בקטע הצגת תגובות במסמך הזה.
	snippet.title (channel)	נדרש. שם הערוץ. אם המשתמש עורך או מחק תגובה לגבי ערוץ, לקוח ה-API חייב להציג את שם הערוץ. אם המשתמש עורך או מחק תגובה לגבי סרטון, לקוח ה-API חייב להציג את שם הערוץ שהעלה את הסרטון.
	snippet.title (video)	נדרש. אם המשתמש עורך או מוחק תגובה לגבי סרטון, לקוח ה-API חייב להציג את שם הסרטון.
דרישות נוספות
	Comment author's channel name	נדרש. לקוח ה-API צריך לציין בבירור את חשבון המשתמש ב-YouTube שאליו משויך התגובה.

איך חוסמים משתמשים בצ'אט בשידור חי (או מסירים את החסימה)

	שם	תיאור
מאפייני המשאב
	snippet.title (channel)	נדרש. השם של ערוץ YouTube שמושע או שההשעיה שלו בוטלה. בנוסף, השם חייב לקשר לערוץ או שצריך להציג גם את כתובת ה-URL של הערוץ.
דרישות נוספות
	שם הערוץ של מחבר התגובה	נדרש. לקוח ה-API חייב לזהות בבירור את חשבון המשתמש ב-YouTube שבו נעשה שימוש כדי להוסיף או להסיר את האיסור.