ה-API תומך עכשיו באפשרות לסמן את הערוץ או
הסרטונים שלך כמיועדים 'במיוחד לילדים'. בנוסף, המשאבים
channel
ו-video
מכילים עכשיו גם נכס שמזהה את הסטטוס 'במיוחד לילדים'
של הערוץ או הסרטון. התנאים וההגבלות של שירותי YouTube API והמדיניות למפתחים
עודכנו גם הם ב-10 בינואר 2020. למידע נוסף, אפשר לעיין בהיסטוריית הגרסאות של
שירות YouTube Data API
ובתנאים ובהגבלות של שירותי YouTube API.
משאב channel
מכיל מידע על ערוץ YouTube.
שיטות
ה-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 ה-e של המשאב הזה. |
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 מפה של תמונות ממוזערות שמשויכות לערוץ. עבור כל אובייקט במפה, המפתח הוא השם של התמונה הממוזערת והערך הוא אובייקט שמכיל מידע אחר על התמונה הממוזערת. בעת הצגת תמונות ממוזערות באפליקציה שלך, ודא שהקוד משתמש בכתובות האתרים של התמונות בדיוק כפי שהן מוחזרות בתגובות של API. לדוגמה, אין להשתמש בדומיין http במקום בדומיין https בכתובת URL שהוחזרה בתגובת API.כתובות URL של תמונות ממוזערות של ערוצים זמינות רק בדומיין https . כך כתובות ה-URL מופיעות בתגובות של API. אם האפליקציה תנסה לטעון תמונות ל-YouTube מהדומיין http , עשויות להופיע תמונות לא תקינות. יכול להיות שתמונות ממוזערות יהיו ריקות בערוצים חדשים שנוצרו, והאכלוס שלהן עשוי להימשך עד יום אחד. |
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. התמיכה ב-API תתבצע עד 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. גודל התמונה הוא 1,060 פיקסלים על 175 פיקסלים. |
brandingSettings.image.bannerMobileImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת הבאנר שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה הוא 640 פיקסלים על 175 פיקסלים. |
brandingSettings.image.watchIconImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של התמונה שמופיעה מעל נגן הווידאו. זוהי תמונה בגובה 25 פיקסלים וברוחב גמיש שלא יכול לחרוג מ-170 פיקסלים. אם לא תספקו את התמונה הזו, שם הערוץ שלכם יופיע במקום תמונה. |
brandingSettings.image.trackingImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של פיקסל למעקב בגודל 1 x 1 פיקסל למעקב שיכול לשמש לאיסוף נתונים סטטיסטיים על הצפיות בערוץ או בדפי הסרטונים. |
brandingSettings.image.bannerTabletLowImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות בטאבלט. הגודל המקסימלי של התמונה הוא 1138 על 188 פיקסלים. |
brandingSettings.image.bannerTabletImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר שמוצגת בדף הערוץ באפליקציות טאבלט. גודל התמונה הוא 1,707 פיקסלים על 283 פיקסלים. |
brandingSettings.image.bannerTabletHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות בטאבלט. הגודל המקסימלי של התמונה הוא 2276 על 377 פיקסלים. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה במיוחד שמוצגת בדף הערוץ באפליקציות לטאבלט. הגודל המקסימלי של התמונה הוא 2560 על 424 פיקסלים. |
brandingSettings.image.bannerMobileLowImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 320 על 88 פיקסלים. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה בינונית שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 960 x 263 פיקסלים. |
brandingSettings.image.bannerMobileHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 1280 פיקסלים על 360 פיקסלים. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה מאוד שתוצג בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 1440 על 395 פיקסלים. |
brandingSettings.image.bannerTvImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה במיוחד שמוצגת בדף הערוץ באפליקציות טלוויזיה. הגודל המקסימלי של התמונה הוא 2120 על 1192 פיקסלים. |
brandingSettings.image.bannerTvLowImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות טלוויזיה. הגודל המקסימלי של התמונה הוא 854 x 480 פיקסלים. |
brandingSettings.image.bannerTvMediumImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה בינונית שמוצגת בדף הערוץ באפליקציות טלוויזיה. הגודל המקסימלי של התמונה הוא 1280 על 720 פיקסלים. |
brandingSettings.image.bannerTvHighImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות טלוויזיה. הגודל המקסימלי של התמונה הוא 1920 על 1080 פיקסלים. |
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 תיאור הערוץ שהותאם לשוק המקומי. |