ה-API תומך עכשיו באפשרות לסמן את הערוץ
סרטונים שמוגדרים בקטגוריה 'במיוחד לילדים'. בנוסף,
channel
ו-video
משאבים גם מכילים עכשיו נכס שמזהה את התוכן בקטגוריה 'במיוחד לילדים'
בסטטוס של הערוץ או הסרטון. התנאים וההגבלות של שירותי YouTube API והמדיניות למפתחים
עודכנו גם ב-10 בינואר 2020. לקבלת מידע נוסף ניתן לעיין בהיסטוריית הגרסאות של
שירות YouTube Data API
התנאים וההגבלות של שירותי ממשקי ה-API של YouTube.
משאב channel
מכיל מידע על ערוץ YouTube.
שיטות
ה-API תומך ב-methods הבאות למשאבים של 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 . יכול להיות שתמונות ממוזערות יהיו ריקות בערוצים חדשים, והאכלוס עשוי להימשך עד יום אחד. |
snippet.thumbnails.(key) |
object ערכי המפתח החוקיים הם:
|
snippet.thumbnails.(key).url |
string כתובת ה-URL של התמונה. יש לעיין בהגדרת הנכס snippet.thumbnails כדי לקבל הנחיות נוספות לגבי שימוש בכתובות URL של תמונות ממוזערות באפליקציה. |
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 מספר המנויים שיש לערוץ. הערך הזה יעוגל כלפי מטה ל-3 נתונים משמעותיים. כדאי לעיין היסטוריית גרסאות או מידע נוסף במרכז העזרה של 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 תווים, או אם הם מכילים מירכאות ללא תו בריחה (escape) ( " ). שימו לב שהאורך של 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 המאפיין הזה הוצא משימוש. כתובת האתר של פיקסל למעקב בגודל 1 x 1 פיקסלים שיכול לשמש לאיסוף נתונים סטטיסטיים על צפיות בערוץ או בדפי הסרטונים. |
brandingSettings.image.bannerTabletLowImageUrl |
string הנכס הזה הוצא משימוש. כתובת האתר של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות של טאבלט. גודל התמונה המקסימלי הוא 1138 פיקסלים על 188 פיקסלים. |
brandingSettings.image.bannerTabletImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר שמוצגת בדף הערוץ באפליקציות לטאבלט. גודל התמונה הוא 1,707 פיקסלים על 283 פיקסלים. |
brandingSettings.image.bannerTabletHdImageUrl |
string המאפיין הזה הוצא משימוש. כתובת האתר של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות של טאבלט. גודל התמונה המקסימלי הוא 2276 פיקסלים על 377 פיקסלים. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונה בבאנר ברזולוציה גבוהה במיוחד שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה המקסימלי הוא 2560 פיקסלים על 424 פיקסלים. |
brandingSettings.image.bannerMobileLowImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה המקסימלי הוא 320 פיקסלים על 88 פיקסלים. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה בינונית שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה המקסימלי הוא 960 פיקסלים על 263 פיקסלים. |
brandingSettings.image.bannerMobileHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה המקסימלי הוא 1280 פיקסלים על 360 פיקסלים. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
string הנכס הזה הוצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה מאוד שמוצגת בדף הערוץ באפליקציות לנייד. גודל התמונה המקסימלי הוא 1440 פיקסלים על 395 פיקסלים. |
brandingSettings.image.bannerTvImageUrl |
string הנכס הזה הוצא משימוש. כתובת האתר של תמונת באנר ברזולוציה גבוהה במיוחד שמוצגת בדף הערוץ ביישומי טלוויזיה. גודל התמונה המקסימלי הוא 2120px על 1192px. |
brandingSettings.image.bannerTvLowImageUrl |
string הנכס הזה הוצא משימוש. כתובת האתר של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ ביישומי טלוויזיה. גודל התמונה המקסימלי הוא 854 על 480 פיקסלים. |
brandingSettings.image.bannerTvMediumImageUrl |
string המאפיין הזה הוצא משימוש. כתובת האתר של תמונת באנר ברזולוציה בינונית שמוצגת בדף הערוץ ביישומי טלוויזיה. גודל התמונה המקסימלי הוא 1280 פיקסלים על 720 פיקסלים. |
brandingSettings.image.bannerTvHighImageUrl |
string הנכס הזה הוצא משימוש. כתובת האתר של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ ביישומי טלוויזיה. גודל התמונה המקסימלי הוא 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 תיאור הערוץ המותאם לשוק המקומי. |