מעכשיו, ה-API תומך בסימון הערוץ או הסרטונים שלכם כ'במיוחד לילדים'. בנוסף, המשאבים
channel
ו-video
מכילים עכשיו גם מאפיין שמזהה את הסטטוס 'במיוחד לילדים' של הערוץ או הסרטון. ב-10 בינואר 2020 עודכנו גם התנאים וההגבלות של שירותי YouTube API וכללי המדיניות למפתחים. למידע נוסף, אפשר לעיין בהיסטוריות הגרסאות של שירות YouTube Data API ושל התנאים וההגבלות של שירותי YouTube API.
משאב channel
מכיל מידע על ערוץ YouTube.
Methods
ה-API תומך בשיטות הבאות למשאבי channels
:
- list
- מחזירה אוסף של אפס או יותר משאבים מסוג
channel
שתואמים לקריטריונים של הבקשה. רוצים לנסות? - עדכון
- עדכון המטא-נתונים של ערוץ. חשוב לזכור שהשיטה הזו תומכת כרגע רק בעדכונים של האובייקטים
brandingSettings
ו-invideoPromotion
של המשאבchannel
ושל נכסי הצאצאים שלהם. רוצים לנסות?
ייצוג משאבים
המבנה הבא של JSON מציג את הפורמט של משאב channels
:
{ "kind": "youtube#channel", "etag": etag, "id": string, "snippet": { "title": string, "description": string, "customUrl": string, "publishedAt": datetime, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "defaultLanguage": string, "localized": { "title": string, "description": string }, "country": string }, "contentDetails": { "relatedPlaylists": { "likes": string, "favorites": string, "uploads": string } }, "statistics": { "viewCount": unsigned long, "subscriberCount": unsigned long, // this value is rounded to three significant figures "hiddenSubscriberCount": boolean, "videoCount": unsigned long }, "topicDetails": { "topicIds": [ string ], "topicCategories": [ string ] }, "status": { "privacyStatus": string, "isLinked": boolean, "longUploadsStatus": string, "madeForKids": boolean, "selfDeclaredMadeForKids": boolean }, "brandingSettings": { "channel": { "title": string, "description": string, "keywords": string, "trackingAnalyticsAccountId": string, "unsubscribedTrailer": string, "defaultLanguage": string, "country": string }, "watch": { "textColor": string, "backgroundColor": string, "featuredPlaylistId": string } }, "auditDetails": { "overallGoodStanding": boolean, "communityGuidelinesGoodStanding": boolean, "copyrightStrikesGoodStanding": boolean, "contentIdClaimsGoodStanding": boolean }, "contentOwnerDetails": { "contentOwner": string, "timeLinked": datetime }, "localizations": { (key): { "title": string, "description": string } } }
מאפיינים
בטבלה הבאה מפורטים המאפיינים שמופיעים במשאב הזה:
מאפיינים | |
---|---|
kind |
string מזהה את סוג משאב ה-API. הערך יהיה youtube#channel . |
etag |
etag ה-Etag של המשאב הזה. |
id |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ. |
snippet |
object האובייקט snippet מכיל פרטים בסיסיים על הערוץ, כמו השם, התיאור ותמונות הממוזערות שלו. |
snippet.title |
string שם הערוץ. |
snippet.description |
string תיאור הערוץ. האורך המקסימלי של הערך של המאפיין הוא 1,000 תווים. |
snippet.customUrl |
string כתובת ה-URL המותאמת אישית של הערוץ. במרכז העזרה של YouTube מוסבר מהן דרישות הסף לקבלת כתובת URL מותאמת אישית, וגם איך מגדירים את כתובת ה-URL. |
snippet.publishedAt |
datetime התאריך והשעה שבהם נוצר הערוץ. הערך מצוין בפורמט ISO 8601. |
snippet.thumbnails |
object מפה של תמונות ממוזערות שמשויכות לערוץ. לכל אובייקט במפה, המפתח הוא שם התמונה הממוזערת והערך הוא אובייקט שמכיל מידע נוסף על התמונה הממוזערת. כשמציגים תמונות ממוזערות באפליקציה, חשוב לוודא שהקוד משתמש בכתובות ה-URL של התמונות בדיוק כפי שהן מופיעות בתשובות של ה-API. לדוגמה, האפליקציה לא צריכה להשתמש בדומיין http במקום בדומיין https בכתובת URL שמוחזרת בתגובה ל-API.כתובות ה-URL של התמונות הממוזערות של הערוצים זמינות רק בדומיין https , וכך כתובות ה-URL מופיעות בתגובות ל-API. יכול להיות שיוצגו באפליקציה תמונות פגום אם היא תנסה לטעון תמונות של YouTube מהדומיין http . יכול להיות שתמונות ממוזערות יהיו ריקות בערוצים חדשים, ויכול להיות שיחלפו עד 24 שעות עד שהן יאוכלסו. |
snippet.thumbnails.(key) |
object הערכים החוקיים של המפתח הם:
|
snippet.thumbnails.(key).url |
string כתובת ה-URL של התמונה. להנחיות נוספות לגבי שימוש בכתובות URL של תמונות ממוזערות באפליקציה, אפשר לעיין בהגדרת המאפיין snippet.thumbnails . |
snippet.thumbnails.(key).width |
unsigned integer רוחב התמונה. |
snippet.thumbnails.(key).height |
unsigned integer גובה התמונה. |
snippet.defaultLanguage |
string השפה של הטקסט במאפיינים snippet.title ו-snippet.description של המשאב channel . |
snippet.localized |
object האובייקט snippet.localized מכיל כותרת ותיאור מותאמים לשוק של הערוץ, או שהוא מכיל את השם והתיאור של הערוץ בשפת ברירת המחדל של המטא-נתונים של הערוץ.
localizations כדי להוסיף, לעדכן או למחוק מטא-נתונים מותאמים לשוק המקומי. |
snippet.localized.title |
string שם הערוץ המותאם לשוק המקומי. |
snippet.localized.description |
string תיאור הערוץ המותאם לשוק המקומי. |
snippet.country |
string המדינה שאליה משויך הערוץ. כדי להגדיר את הערך של המאפיין הזה, מעדכנים את הערך של המאפיין brandingSettings.channel.country . |
contentDetails |
object האובייקט contentDetails מכיל מידע על התוכן של הערוץ. |
contentDetails.relatedPlaylists |
object האובייקט relatedPlaylists הוא מפה שמזהה פלייליסטים שמשויכים לערוץ, כמו הסרטונים שהועלו על ידי הערוץ או הסרטונים שאהבת. אפשר לאחזר כל אחד מהפלייליסטים האלה באמצעות השיטה playlists.list . |
contentDetails.relatedPlaylists.likes |
string המזהה של הפלייליסט שמכיל את הסרטונים שאהבתם בערוץ. משתמשים בשיטות playlistItems.insert ו-playlistItems.delete כדי להוסיף או להסיר פריטים מהרשימה הזו. |
contentDetails.relatedPlaylists.favorites |
string המאפיין הזה הוצא משימוש. המזהה של הפלייליסט שמכיל את הסרטונים המועדפים של הערוץ. משתמשים בשיטות playlistItems.insert ו-playlistItems.delete כדי להוסיף או להסיר פריטים מהרשימה הזו.לתשומת ליבכם: הפונקציונליות של סרטוני המועדפים ב-YouTube הוצאה משימוש. לדוגמה, המאפיין statistics.favoriteCount של המשאב video יצא משימוש ב-28 באוגוסט 2015. כתוצאה מכך, מסיבות היסטוריות, ייתכן שערך המאפיין הזה יכיל מזהה פלייליסט שמתייחס לפלייליסט ריק, ולכן לא ניתן לאחזר אותו. |
contentDetails.relatedPlaylists.uploads |
string המזהה של הפלייליסט שמכיל את הסרטונים שהועלו על ידי הערוץ. משתמשים בשיטה videos.insert כדי להעלות סרטונים חדשים, ובשיטה videos.delete כדי למחוק סרטונים שהעליתם בעבר. |
statistics |
object האובייקט statistics מכיל את הנתונים הסטטיסטיים של הערוץ. |
statistics.viewCount |
unsigned long מספר הצפיות בערוץ. |
statistics.commentCount |
unsigned long המאפיין הזה הוצא משימוש. מספר התגובות בערוץ. |
statistics.subscriberCount |
unsigned long מספר המנויים בערוץ. הערך הזה מעוגל כלפי מטה לשלוש ספרות משמעותיות. פרטים נוספים על אופן העיגול של מספרי המנויים זמינים בהיסטוריית הגרסאות או במרכז העזרה של YouTube. |
statistics.videoCount |
unsigned long מספר הסרטונים הגלויים לכולם שהועלו לערוץ. חשוב לזכור שהערך משקף את מספר הסרטונים הגלויים לכולם בערוץ, גם לבעלי הערוץ. ההתנהגות הזו תואמת למספרים שמוצגים באתר של YouTube. |
topicDetails |
object האובייקט topicDetails מכיל מידע על נושאים שמשויכים לערוץ.חשוב: פרטים נוספים על שינויים שקשורים למזהי נושאים זמינים בהגדרת הנכס topicDetails.topicIds[] ובהיסטוריית הגרסאות. |
topicDetails.topicIds[] |
list רשימה של מזהי נושאים שמשויכים לערוץ. הנכס הזה הוצא משימוש החל מ-10 בנובמבר 2016. התמיכה בו תסתיים ב-10 בנובמבר 2017. חשוב: עקב ההוצאה משימוש של Freebase ו-Freebase API, מזהי הנושאים התחילו לפעול בצורה שונה החל מ-27 בפברואר 2017. באותו זמן, YouTube התחיל להחזיר קבוצה קטנה של מזהים של נושאים שנבחרו בקפידה. |
topicDetails.topicCategories[] |
list רשימה של כתובות URL בוויקיפדיה שמתארות את תוכן הערוץ. |
status |
object האובייקט status מכיל מידע על סטטוס הפרטיות של הערוץ. |
status.privacyStatus |
string סטטוס הפרטיות של הערוץ. הערכים החוקיים למאפיין הזה הם:
|
status.isLinked |
boolean מציין אם נתוני הערוץ מזהים משתמש שכבר מקושר לשם משתמש ב-YouTube או לחשבון Google+. למשתמש שיש לו אחד מהקישורים האלה כבר יש זהות ציבורית ב-YouTube, שהיא תנאי מקדים לכמה פעולות, כמו העלאת סרטונים. |
status.longUploadsStatus |
string מציין אם הערוץ עומד בדרישות להעלאת סרטונים באורך של יותר מ-15 דקות. המאפיין הזה מוחזר רק אם הבעלים של הערוץ העניק הרשאה לבקשת ה-API. מידע נוסף על התכונה הזו זמין במרכז העזרה של YouTube. הערכים התקפים של המאפיין הזה הם:
|
status.madeForKids |
boolean הערך הזה מציין אם הערוץ מסווג כתוכן לילדים, והוא מכיל את הסטטוס הנוכחי של הערוץ בקטגוריה 'במיוחד לילדים'. לדוגמה, הסטטוס יכול להיקבע על סמך הערך של המאפיין selfDeclaredMadeForKids . למידע נוסף על הגדרת הקהל של הערוץ, הסרטונים או השידורים שלכם, תוכלו לעיין במרכז העזרה של YouTube .
|
status.selfDeclaredMadeForKids |
boolean בבקשה מסוג channels.update ,
הנכס הזה מאפשר לבעלים של הערוץ לציין שהערוץ מיועד לילדים. הערך של המאפיין מוחזר רק אם בעלי הערוץ אישר את בקשת ה-API.
|
brandingSettings |
object האובייקט brandingSettings מכיל מידע על המיתוג של הערוץ. |
brandingSettings.channel |
object האובייקט channel מכיל את מאפייני המיתוג של דף הערוץ. |
brandingSettings.channel.title |
string שם הערוץ. האורך המקסימלי של השם הוא 30 תווים. |
brandingSettings.channel.description |
string תיאור הערוץ, שמופיע בתיבה של פרטי הערוץ בדף הערוץ. האורך המקסימלי של הערך של המאפיין הוא 1,000 תווים. |
brandingSettings.channel.keywords |
string מילות מפתח שמשויכות לערוץ שלכם. הערך הוא רשימה של מחרוזות שמופרדות ברווחים. יכול להיות שמילות מפתח של ערוץ יקוצרו אם הן חורגות מהאורך המקסימלי המותר של 500 תווים, או אם הן מכילות מירכאות כפולות ללא תווי בריחה ( " ). שימו לב שהמגבלה של 500 תווים היא לא מגבלת תווים לכל מילת מפתח, אלא מגבלת אורך כוללת לכל מילות המפתח. |
brandingSettings.channel.trackingAnalyticsAccountId |
string המזהה של חשבון Google Analytics שבו אתם רוצים להשתמש כדי לעקוב אחרי התנועה לערוץ ולמדוד אותה. |
brandingSettings.channel.unsubscribedTrailer |
string הסרטון שצריך להופיע במודול הסרטונים הנבחרים בתצוגת הדפדוף של דף הערוץ לצופים שלא רשומים כמנויים. צופים שהם מנויים עשויים לראות סרטון אחר שמתמקד בפעילות הערוץ מהזמן האחרון. אם יצוין, הערך של המאפיין חייב להיות מזהה הסרטון ב-YouTube של סרטון גלוי לכולם או לא רשום שבבעלות הבעלים של הערוץ. |
brandingSettings.channel.defaultLanguage |
string השפה של הטקסט במאפיינים snippet.title ו-snippet.description של המשאב channel . |
brandingSettings.channel.country |
string המדינה שאליה משויך הערוץ. מעדכנים את המאפיין הזה כדי להגדיר את הערך של המאפיין snippet.country . |
brandingSettings.watch |
object הערה: האובייקט הזה וכל נכסי הצאצאים שלו הוצאו משימוש. האובייקט watch מכיל מאפייני מיתוג של דפי הצפייה בסרטונים של הערוץ. |
brandingSettings.watch.textColor |
string הערה: המאפיין הזה הוצא משימוש. צבע הטקסט באזור המותג בדף הצפייה של הסרטון. |
brandingSettings.watch.backgroundColor |
string הערה: המאפיין הזה הוצא משימוש. צבע הרקע של האזור הממותג בדף הצפייה בסרטון. |
brandingSettings.watch.featuredPlaylistId |
string הערה: המאפיין הזה הוצא משימוש. אם תנסו להגדיר את הערך שלו, ה-API יחזיר שגיאה. |
brandingSettings.image |
object הנכס הזה וכל נכסי הצאצא שלו הוצאו משימוש. האובייקט image מכיל מידע על תמונות שמוצגות בדף הערוץ או בדפי הצפייה בסרטונים של הערוץ. |
brandingSettings.image.bannerImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונת הבאנר שמוצגת בדף הערוץ באתר YouTube. התמונה צריכה להיות בגודל 1060 על 175 פיקסלים. |
brandingSettings.image.bannerMobileImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונת הבאנר שמוצגת בדף הערוץ באפליקציות לנייד. התמונה צריכה להיות בגודל 640 על 175 פיקסלים. |
brandingSettings.image.watchIconImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של התמונה שמופיעה מעל נגן הסרטון. זו תמונה בגובה 25 פיקסלים עם רוחב גמיש שלא יכול לחרוג מ-170 פיקסלים. אם לא תספקו את התמונה הזו, שם הערוץ יופיע במקום תמונה. |
brandingSettings.image.trackingImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של פיקסל מעקב בגודל 1px על 1px שאפשר להשתמש בו כדי לאסוף נתונים סטטיסטיים לגבי צפיות בדפי הערוץ או בסרטונים. |
brandingSettings.image.bannerTabletLowImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונה בבאנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה המקסימלי הוא 1,138 על 188 פיקסלים. |
brandingSettings.image.bannerTabletImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונת הבאנר שמוצגת בדף הערוץ באפליקציות לנייד. התמונה צריכה להיות בגודל 1,707 על 283 פיקסלים. |
brandingSettings.image.bannerTabletHdImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונה של באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 2,276 על 377 פיקסלים. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונה בבאנר ברזולוציה גבוהה במיוחד שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 2560px על 424px. |
brandingSettings.image.bannerMobileLowImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונה באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 320px על 88px. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונה בפורמט באנר ברזולוציה בינונית שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה המקסימלי הוא 960px על 263px. |
brandingSettings.image.bannerMobileHdImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 1280px על 360px. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונה בפורמט באנר ברזולוציה גבוהה מאוד שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה המקסימלי הוא 1,440 על 395 פיקסלים. |
brandingSettings.image.bannerTvImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה במיוחד שמוצגת בדף הערוץ באפליקציות לטלוויזיה. גודל התמונה המקסימלי הוא 2120 על 1192 פיקסלים. |
brandingSettings.image.bannerTvLowImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות לטלוויזיה. הגודל המקסימלי של התמונה הוא 854px על 480px. |
brandingSettings.image.bannerTvMediumImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה בינונית שמוצגת בדף הערוץ באפליקציות לטלוויזיה. גודל התמונה המקסימלי הוא 1280px על 720px. |
brandingSettings.image.bannerTvHighImageUrl |
string המאפיין הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות לטלוויזיה. גודל התמונה המקסימלי הוא 1,920 על 1,080 פיקסלים. |
brandingSettings.image.bannerExternalUrl |
string המאפיין הזה מציין את המיקום של תמונת הבאנר שבה מערכת YouTube משתמשת כדי ליצור את גדלי תמונת הבאנר השונים של הערוץ. |
brandingSettings.hints[] |
list הנכס הזה וכל נכסי הצאצא שלו הוצאו משימוש. האובייקט hints מכיל מאפייני מיתוג נוספים. |
brandingSettings.hints[].property |
string המאפיין הזה הוצא משימוש. נכס. |
brandingSettings.hints[].value |
string המאפיין הזה הוצא משימוש. הערך של המאפיין. |
auditDetails |
object האובייקט auditDetails מכיל את נתוני הערוץ שרשת מרובת ערוצים (MCN) תבדוק כדי לקבוע אם לאשר או לדחות ערוץ מסוים. חשוב לזכור שכל בקשת API שמאחזרת את החלק הזה של המשאב חייבת לספק אסימון הרשאה שמכיל את ההיקף https://www.googleapis.com/auth/youtubepartner-channel-audit . בנוסף, כל טוקן שמשתמש בהיקף הזה חייב לבטל כשה-MCN מחליט לקבל או לדחות את הערוץ, או תוך שבועיים מתאריך הנפקת הטוקן. |
auditDetails.overallGoodStanding |
boolean השדה הזה מציין אם יש בעיות בערוץ. נכון לעכשיו, השדה הזה מייצג את התוצאה של הפעולה הלוגית AND על המאפיינים communityGuidelinesGoodStanding , copyrightStrikesGoodStanding ו-contentIdClaimsGoodStanding . כלומר, הערך של המאפיין הזה הוא true אם הערך של כל המאפיינים האחרים הוא גם true . עם זאת, הערך של המאפיין הזה יהיה false אם לפחות אחד מהמאפיינים האלה יהיה בעל ערך false . עם זאת, חשוב לזכור שהשיטה שבה נקבע הערך של המאפיין הזה עשויה להשתנות. |
auditDetails.communityGuidelinesGoodStanding |
boolean מציין אם הערוץ מציית להנחיות הקהילה של YouTube. |
auditDetails.copyrightStrikesGoodStanding |
boolean מציין אם נרשמו לערוץ פסילות בעקבות הפרת זכויות יוצרים. |
auditDetails.contentIdClaimsGoodStanding |
boolean מציין אם יש בערוץ תלונות שלא טופלו. |
contentOwnerDetails |
object האובייקט contentOwnerDetails מכיל נתוני ערוץ שגלויים רק לשותף YouTube שקשר את הערוץ למערכת ניהול התוכן שלו. |
contentOwnerDetails.contentOwner |
string המזהה של בעלי התוכן שמקושר לערוץ. |
contentOwnerDetails.timeLinked |
datetime התאריך והשעה שבהם הערוץ קושר לבעלי התוכן. הערך מצוין בפורמט ISO 8601. |
localizations |
object האובייקט localizations מכיל תרגומים של המטא-נתונים של הערוץ. |
localizations.(key) |
object השפה של המטא-נתונים המותאמים לשוק המקומי שמשויכים לערך המפתח. הערך הוא מחרוזת שמכילה קוד שפה בפורמט BCP-47. |
localizations.(key).title |
string שם הערוץ המותאם לשוק המקומי. |
localizations.(key).description |
string תיאור הערוץ המותאם לשוק המקומי. |