משאב subscription
מכיל מידע על מינוי של משתמש YouTube. הרשמה מודיעה למשתמש כאשר סרטונים חדשים מתווספים לערוץ או כאשר משתמש אחר מבצע אחת מכמה פעולות ב-YouTube, כגון העלאת סרטון, דירוג סרטון או הוספת תגובה לסרטון.
שיטות
ה-API תומך בשיטות הבאות למשאבים של subscriptions
:
- list
- מחזיר את משאבי המינויים שתואמים לקריטריונים של בקשת ה-API. כדאי לנסות עכשיו.
- הוספה
- הוספת מינוי לערוץ של המשתמש המאומת. כדאי לנסות עכשיו.
- מחיקה
- מחיקת מינוי. כדאי לנסות עכשיו.
ייצוג משאבים
מבנה ה-JSON הבא מציג את הפורמט של משאב subscriptions
:
{ "kind": "youtube#subscription", "etag": etag, "id": string, "snippet": { "publishedAt": datetime, "channelTitle": string, "title": string, "description": string, "resourceId": { "kind": string, "channelId": string, }, "channelId": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } } }, "contentDetails": { "totalItemCount": unsigned integer, "newItemCount": unsigned integer, "activityType": string }, "subscriberSnippet": { "title": string, "description": string, "channelId": string, "thumbnails": { (key): { "url": string, "width": unsigned integer, "height": unsigned integer } } } }
תכונות
הטבלה הבאה מגדירה את המאפיינים שיופיעו במשאב הזה:
תכונות | |
---|---|
kind | string מזהה את הסוג של משאב ה-API. הערך יהיה youtube#subscription . |
etag | etag ה-e של המשאב הזה. |
id | string המזהה שמשמש את YouTube לזיהוי ייחודי של המינוי. |
snippet | object האובייקט snippet מכיל פרטים בסיסיים על המינוי, כולל שם המינוי והערוץ שאליו המשתמש נרשם. |
snippet.publishedAt | datetime התאריך והשעה שבהם נוצר המינוי. הערך מצוין בפורמט ISO 8601. |
snippet.channelTitle | string שם הערוץ שאליו שייך המינוי. |
snippet.title | string שם המינוי. |
snippet.description | string פרטי המינוי. |
snippet.resourceId | object האובייקט id מכיל מידע על הערוץ שהמשתמש נרשם אליו. |
snippet.resourceId.kind | string הסוג של משאב ה-API. |
snippet.resourceId.channelId | string הערך שמשמש את YouTube לזיהוי ייחודי של הערוץ שהמשתמש נרשם אליו. |
snippet.channelId | string המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ של המנוי. האובייקט resource_id מזהה את הערוץ שהמשתמש נרשם אליו. |
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 גובה התמונה. |
contentDetails | object האובייקט contentDetails מכיל נתונים סטטיסטיים בסיסיים לגבי המינוי. |
contentDetails.totalItemCount | unsigned integer המספר המשוער של הפריטים שאליהם המינוי מפנה. |
contentDetails.newItemCount | unsigned integer מספר הפריטים החדשים במינוי מאז הקריאה האחרונה של התוכן שלו. |
contentDetails.activityType | string סוג הפעילות עבור המינוי הזה (רק העלאות, הכול). הערכים החוקיים לנכס הזה הם:
|
subscriberSnippet | object האובייקט subscriberSnippet מכיל פרטים בסיסיים על המנוי. |
subscriberSnippet.title | string שם הערוץ של המנוי. |
subscriberSnippet.description | string תיאור הערוץ של המנוי. |
subscriberSnippet.channelId | string המזהה שהוקצה על ידי YouTube לזיהוי ייחודי של הערוץ של המנוי. |
subscriberSnippet.thumbnails | object תמונות ממוזערות של הערוץ של המנוי. |
subscriberSnippet.thumbnails.(key) | object ערכי המפתח החוקיים הם:
|
subscriberSnippet.thumbnails.(key).url | string כתובת ה-URL של התמונה. |
subscriberSnippet.thumbnails.(key).width | unsigned integer רוחב התמונה. |
subscriberSnippet.thumbnails.(key).height | unsigned integer גובה התמונה. |