ה-API תומך עכשיו באפשרות לסמן את הערוץ או את הסרטונים בקטגוריה "במיוחד לילדים". בנוסף, המשאבים
channel
ו-video מכילים עכשיו מאפיין שמזהה את הסטטוס "במיוחד לילדים" של הערוץ או הסרטון. ב-10 בינואר 2020 עודכנו גם התנאים וההגבלות של שירותי ה-API של YouTube וכללי המדיניות למפתחים. מידע נוסף מופיע בהיסטוריית הגרסאות של YouTube Data API Service ושל תנאים והגבלות של שירותי ה-API של YouTube.
משאב channel מכיל מידע על ערוץ YouTube.
Methods
ה-API תומך בשיטות הבאות למשאבי channels:
- list
- הפונקציה מחזירה אוסף של אפס או יותר משאבי
channelשתואמים לקריטריונים של הבקשה. רוצים לנסות? - update
- עדכון המטא-נתונים של ערוץ. חשוב לשים לב שהשיטה הזו תומכת כרגע רק בעדכונים לאובייקטים
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מספר הפעמים הכולל שכל הסרטונים בכל הפורמטים נצפו בערוץ. החל מ-24 באוגוסט 2026, בכל פורמטי הסרטונים (סרטונים ארוכים, שידורים חיים וסרטוני Shorts) בערוץ, |
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. התמונה היא בגודל 1,060 פיקסלים על 175 פיקסלים. |
brandingSettings.image.bannerMobileImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת הבאנר שמוצגת בדף הערוץ באפליקציות לנייד. התמונה היא במידות 640 פיקסלים על 175 פיקסלים. |
brandingSettings.image.watchIconImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של התמונה שמופיעה מעל נגן הווידאו. זו תמונה בגובה 25 פיקסלים עם רוחב גמיש שלא יכול להיות גדול מ-170 פיקסלים. אם לא תספקו את התמונה הזו, במקומה יופיע שם הערוץ. |
brandingSettings.image.trackingImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של פיקסל מעקב בגודל 1x1 שאפשר להשתמש בו כדי לאסוף נתונים סטטיסטיים על צפיות בדפי הערוץ או הסרטון. |
brandingSettings.image.bannerTabletLowImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות לטאבלט. הגודל המקסימלי של התמונה הוא 1,138x188 פיקסלים. |
brandingSettings.image.bannerTabletImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר שמוצגת בדף הערוץ באפליקציות לטאבלט. התמונה היא במידות 1,707 פיקסלים על 283 פיקסלים. |
brandingSettings.image.bannerTabletHdImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות לטאבלטים. הגודל המקסימלי של התמונה הוא 2,276 פיקסלים על 377 פיקסלים. |
brandingSettings.image.bannerTabletExtraHdImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה במיוחד שמוצגת בדף הערוץ באפליקציות לטאבלטים. הגודל המקסימלי של התמונה הוא 2,560 פיקסלים על 424 פיקסלים. |
brandingSettings.image.bannerMobileLowImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 320 פיקסלים על 88 פיקסלים. |
brandingSettings.image.bannerMobileMediumHdImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה בינונית שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 960x263 פיקסלים. |
brandingSettings.image.bannerMobileHdImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 1,280x360 פיקסלים. |
brandingSettings.image.bannerMobileExtraHdImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה מאוד שמוצגת בדף הערוץ באפליקציות לנייד. הגודל המקסימלי של התמונה הוא 1,440 פיקסלים על 395 פיקסלים. |
brandingSettings.image.bannerTvImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה במיוחד שמוצגת בדף הערוץ באפליקציות לטלוויזיה. הגודל המקסימלי של התמונה הוא 2,120x1,192 פיקסלים. |
brandingSettings.image.bannerTvLowImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה נמוכה שמוצגת בדף הערוץ באפליקציות לטלוויזיה. הגודל המקסימלי של התמונה הוא 854x480 פיקסלים. |
brandingSettings.image.bannerTvMediumImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה בינונית שמוצגת בדף הערוץ באפליקציות לטלוויזיה. הגודל המקסימלי של התמונה הוא 1,280x720 פיקסלים. |
brandingSettings.image.bannerTvHighImageUrl |
stringהמאפיין הזה יצא משימוש. כתובת ה-URL של תמונת באנר ברזולוציה גבוהה שמוצגת בדף הערוץ באפליקציות לטלוויזיה. הגודל המקסימלי של התמונה הוא 1,920x1,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תיאור הערוץ המותאם לשוק המקומי. |