משאב activity
מכיל מידע על פעולה שבוצעה על ידי ערוץ או משתמש מסוימים ב-YouTube. הפעולות שמדווחות בפיד הפעילות כוללות דירוג סרטון, שיתוף סרטון, סימון סרטון כמועדף, העלאת סרטון וכו'. כל משאב activity
מזהה את סוג הפעולה, את הערוץ שמשויך לפעולה ואת המשאבים שמשויכים לפעולה, כמו הסרטון שקיבל דירוג או הועלה.
Methods
ה-API תומך בשיטות הבאות למשאבי activities
:
- list
- מחזירה רשימה של אירועים של פעילות בערוץ שתואמים לקריטריונים של הבקשה. לדוגמה, אפשר לאחזר אירועים שמשויכים לערוץ מסוים או לערוץ של המשתמש עצמו. כדאי לנסות עכשיו.
ייצוג משאבים
מבנה ה-JSON הבא מציג את הפורמט של משאב activities
:
{ "kind": "youtube#activity", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelId": string, "title": string, "description": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } }, "channelTitle": string, "type": string, "groupId": string }, "contentDetails": { "upload": { "videoId": string }, "like": { "resourceId": { "kind": string, "videoId": string, } }, "favorite": { "resourceId": { "kind": string, "videoId": string, } }, "comment": { "resourceId": { "kind": string, "videoId": string, "channelId": string, } }, "subscription": { "resourceId": { "kind": string, "channelId": string, } }, "playlistItem": { "resourceId": { "kind": string, "videoId": string, }, "playlistId": string, "playlistItemId": string }, "recommendation": { "resourceId": { "kind": string, "videoId": string, "channelId": string, }, "reason": string, "seedResourceId": { "kind": string, "videoId": string, "channelId": string, "playlistId": string } }, "social": { "type": string, "resourceId": { "kind": string, "videoId": string, "channelId": string, "playlistId": string }, "author": string, "referenceUrl": string, "imageUrl": string }, "channelItem": { "resourceId": { } }, } }
מאפיינים
בטבלה הבאה מוגדרים המאפיינים שמופיעים במשאב הזה:
מאפיינים | |
---|---|
kind |
string מזהה את סוג משאב ה-API. הערך יהיה youtube#activity . |
etag |
etag ה-Etag של מקור המידע הזה. |
id |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הפעילות. |
snippet |
object האובייקט snippet מכיל פרטים בסיסיים על הפעילות, כולל סוג הפעילות ומזהה הקבוצה. |
snippet.publishedAt |
datetime התאריך והשעה שבהם התרחשה הפעילות. הערך מצוין בפורמט ISO 8601. |
snippet.channelId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ שמשויך לפעילות. |
snippet.title |
string השם של המשאב שמשויך בעיקר לפעילות. |
snippet.description |
string תיאור המשאב שמשויך בעיקר לפעילות. |
snippet.thumbnails |
object מפה של תמונות ממוזערות שמשויכות למשאב שמשויך בעיקר לפעילות. לכל אובייקט במפה, המפתח הוא השם של התמונה הממוזערת, והערך הוא אובייקט שמכיל מידע נוסף על התמונה הממוזערת. |
snippet.thumbnails.(key) |
object הערכים התקפים של המפתח הם:
|
snippet.thumbnails.(key).url |
string כתובת ה-URL של התמונה. |
snippet.thumbnails.(key).width |
unsigned integer רוחב התמונה. |
snippet.thumbnails.(key).height |
unsigned integer גובה התמונה. |
snippet.channelTitle |
string שם הערוץ שאחראי לפעילות הזו |
snippet.type |
string סוג הפעילות שהמשאב מתאר. הערכים התקינים של המאפיין הזה הם:
|
snippet.groupId |
string מזהה הקבוצה שמשויך לפעילות. מזהה קבוצה מזהה אירועי משתמש שמשויכים לאותו משתמש ולאותו משאב. לדוגמה, אם משתמש מדרג סרטון ומסמן את אותו סרטון כמועדף, לרשומות של האירועים האלה יהיה אותו מזהה קבוצה בפיד הפעילות של המשתמש. בממשק המשתמש, אפשר לקבץ אירועים עם אותו ערך של groupId כדי להימנע מחזרות. |
contentDetails |
object האובייקט contentDetails מכיל מידע על התוכן שמשויך לפעילות. לדוגמה, אם הערך של snippet.type הוא videoRated , התוכן של האובייקט contentDetails מזהה את הסרטון שסווג. |
contentDetails.upload |
object אובייקט upload מכיל מידע על הסרטון שהועלה. המאפיין הזה מופיע רק אם הערך של snippet.type הוא upload . |
contentDetails.upload.videoId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון שהועלה. |
contentDetails.like |
object האובייקט like מכיל מידע על משאב שקיבל דירוג חיובי (למשל לייק). המאפיין הזה מופיע רק אם הערך של snippet.type הוא like . |
contentDetails.like.resourceId |
object האובייקט resourceId מכיל מידע שמזהה את המשאב שסווג. |
contentDetails.like.resourceId.kind |
string סוג משאב ה-API. |
contentDetails.like.resourceId.videoId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון, אם המשאב שסווג הוא סרטון. המאפיין הזה מופיע רק אם הערך של resourceId.kind הוא youtube#video . |
contentDetails.favorite |
object האובייקט favorite מכיל מידע על סרטון שסומן כסרטון מועדף. המאפיין הזה מופיע רק אם הערך של snippet.type הוא favorite . |
contentDetails.favorite.resourceId |
object האובייקט resourceId מכיל מידע שמזהה את המשאב שסומן כמועדף. |
contentDetails.favorite.resourceId.kind |
string סוג משאב ה-API. |
contentDetails.favorite.resourceId.videoId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון המועדף. המאפיין הזה מופיע רק אם הערך של resourceId.kind הוא youtube#video .הערה: בשלב הזה, השיטה activities.list לא מחזירה משאבים לתגובות חדשות. |
contentDetails.comment |
object האובייקט comment מכיל מידע על משאב שהתקבלה לגביו תגובה. המאפיין הזה מופיע רק אם הערך של snippet.type הוא comment . |
contentDetails.comment.resourceId |
object האובייקט resourceId מכיל מידע שמזהה את המשאב שמשויך לתגובה. |
contentDetails.comment.resourceId.kind |
string סוג משאב ה-API. |
contentDetails.comment.resourceId.videoId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון שמשויך לתגובה. המאפיין הזה מופיע רק אם הערך של resourceId.kind הוא youtube#video . |
contentDetails.comment.resourceId.channelId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ שמשויך לתגובה. המאפיין הזה מופיע רק אם הערך של resourceId.kind הוא youtube#channel . |
contentDetails.subscription |
object האובייקט subscription מכיל מידע על ערוץ שהמשתמש נרשם אליו. המאפיין הזה מופיע רק אם הערך של snippet.type הוא subscription . |
contentDetails.subscription.resourceId |
object האובייקט resourceId מכיל מידע שמזהה את המשאב שהמשתמש נרשם אליו. |
contentDetails.subscription.resourceId.kind |
string סוג משאב ה-API. |
contentDetails.subscription.resourceId.channelId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ שהמשתמש נרשם אליו. המאפיין הזה מופיע רק אם הערך של resourceId.kind הוא youtube#channel . |
contentDetails.playlistItem |
object האובייקט playlistItem מכיל מידע על פריט חדש בפלייליסט. המאפיין הזה מופיע רק אם הערך של snippet.type הוא playlistItem . |
contentDetails.playlistItem.resourceId |
object האובייקט resourceId מכיל מידע שמזהה את המשאב שנוסף לפלייליסט. |
contentDetails.playlistItem.resourceId.kind |
string סוג משאב ה-API. |
contentDetails.playlistItem.resourceId.videoId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון שנוסף לפלייליסט. המאפיין הזה מופיע רק אם הערך של resourceId.kind הוא youtube#video . |
contentDetails.playlistItem.playlistId |
string הערך שמשמש את YouTube לזיהוי ייחודי של הפלייליסט. |
contentDetails.playlistItem.playlistItemId |
string הערך שמשמש את YouTube לזיהוי ייחודי של הפריט בפלייליסט. |
contentDetails.recommendation |
object האובייקט recommendation מכיל מידע על משאב מומלץ. המאפיין הזה מופיע רק אם הערך של snippet.type הוא recommendation . |
contentDetails.recommendation.resourceId |
object האובייקט resourceId מכיל מידע שמזהה את המשאב המומלץ. |
contentDetails.recommendation.resourceId.kind |
string סוג משאב ה-API. |
contentDetails.recommendation.resourceId.videoId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הסרטון, אם המשאב המומלץ הוא סרטון. המאפיין הזה מופיע רק אם הערך של resourceId.kind הוא youtube#video . |
contentDetails.recommendation.resourceId.channelId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ, אם המשאב המומלץ הוא ערוץ. המאפיין הזה מופיע רק אם הערך של resourceId.kind הוא youtube#channel . |
contentDetails.recommendation.reason |
string הסיבה לכך שהמשאב מומלץ למשתמש. הערכים התקינים של המאפיין הזה הם:
|
contentDetails.recommendation.seedResourceId |
object האובייקט seedResourceId מכיל מידע על המשאב שגרם להמלצה. |
contentDetails.recommendation.seedResourceId.kind |
string סוג משאב ה-API. |
contentDetails.recommendation.seedResourceId.videoId |
string המזהה שבו YouTube משתמש כדי לזהות את הסרטון באופן ייחודי, אם ההמלצה נוצרה בעקבות סרטון מסוים. המאפיין הזה מופיע רק אם הערך של seedResourceId.kind הוא youtube#video . |
contentDetails.recommendation.seedResourceId.channelId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ, אם ההמלצה נוצרה בגלל ערוץ מסוים. המאפיין הזה מופיע רק אם הערך של seedResourceId.kind הוא youtube#channel . |
contentDetails.recommendation.seedResourceId.playlistId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הפלייליסט, אם ההמלצה נוצרה בגלל פלייליסט מסוים. המאפיין הזה מופיע רק אם הערך של seedResourceId.kind הוא youtube#playlist . |
contentDetails.social |
object האובייקט social מכיל פרטים על פוסט ברשת חברתית. המאפיין הזה מופיע רק אם הערך של snippet.type הוא social . |
contentDetails.social.type |
string השם של הרשת החברתית. הערכים התקינים של המאפיין הזה הם:
|
contentDetails.social.resourceId |
object האובייקט resourceId כולל מידע שמזהה את המקור שמשויך לפוסט ברשת החברתית. |
contentDetails.social.resourceId.kind |
string סוג משאב ה-API. |
contentDetails.social.resourceId.videoId |
string המזהה ש-YouTube משתמש בו כדי לזהות באופן ייחודי את הסרטון שמוצג בפוסט ברשת חברתית, אם הפוסט מתייחס לסרטון. המאפיין הזה יופיע רק אם הערך של המאפיין social.resourceId.kind הוא youtube#video . |
contentDetails.social.resourceId.channelId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ שמוצג בפוסט ברשת חברתית, אם הפוסט מתייחס לערוץ. המאפיין הזה יופיע רק אם הערך של המאפיין social.resourceId.kind הוא youtube#channel . |
contentDetails.social.resourceId.playlistId |
string המזהה שמשמש את YouTube לזיהוי ייחודי של הפלייליסט שמוצג בפוסט ברשת החברתית, אם הפוסט מתייחס לפלייליסט. המאפיין הזה יופיע רק אם הערך של המאפיין social.resourceId.kind הוא youtube#playlist . |
contentDetails.social.author |
string המחבר של הפוסט ברשת החברתית. |
contentDetails.social.referenceUrl |
string כתובת ה-URL של הפוסט ברשת החברתית. |
contentDetails.social.imageUrl |
string תמונה של יוצר הפוסט. |
contentDetails.channelItem |
object האובייקט channelItem מכיל פרטים על משאב שנוסף לערוץ. המאפיין הזה מופיע רק אם הערך של snippet.type הוא channelItem . |
contentDetails.channelItem.resourceId |
object האובייקט resourceId מכיל מידע שמזהה את המשאב שנוסף לערוץ. |