Subscriptions

משאב 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 התג של המשאב הזה.
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 ערכי מפתח חוקיים הם: default – תמונת ברירת המחדל של התמונה הממוזערת של המשאב הזה. התמונה הממוזערת המוגדרת כברירת מחדל לסרטון – או למשאב המתייחס לסרטון, כמו פריט בפלייליסט או תוצאת חיפוש – היא ברוחב של 120 פיקסלים ובגובה של 90 פיקסלים. התמונה הממוזערת המוגדרת כברירת מחדל עבור ערוץ היא ברוחב 88 פיקסלים ובגובה 88 פיקסלים. medium – גרסה ברזולוציה גבוהה יותר של התמונה הממוזערת. כשמדובר בסרטון (או משאב שמתייחס לסרטון), התמונה הזו היא ברוחב 320 פיקסלים ובגובה של 180 פיקסלים. בערוץ, התמונה הזו היא ברוחב 240 פיקסלים ובגובה 240 פיקסלים. high – גרסה ברזולוציה גבוהה של התמונה הממוזערת. כשמדובר בסרטון (או משאב שמתייחס לסרטון), התמונה הזו היא ברוחב של 480 פיקסלים ובגובה של 360 פיקסלים. בערוץ, התמונה הזו היא ברוחב 800 פיקסלים ובגובה 800 פיקסלים.
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 סוג הפעילות שהמינוי הזה משויך אליה (העלאות בלבד, הכול). הערכים החוקיים לנכס הזה הם: all uploads
subscriberSnippet	object האובייקט subscriberSnippet מכיל פרטים בסיסיים על המנוי.
subscriberSnippet.title	string השם של ערוץ המנויים.
subscriberSnippet.description	string תיאור הערוץ של המנוי.
subscriberSnippet.channelId	string המזהה שמערכת YouTube מקצה כדי לזהות באופן ייחודי את הערוץ של המנוי.
subscriberSnippet.thumbnails	object תמונות ממוזערות של הערוץ של המנויים.
subscriberSnippet.thumbnails.(key)	object ערכי מפתח חוקיים הם: default – תמונת ברירת המחדל של התמונה הממוזערת של המשאב הזה. התמונה הממוזערת המוגדרת כברירת מחדל לסרטון – או למשאב המתייחס לסרטון, כמו פריט בפלייליסט או תוצאת חיפוש – היא ברוחב של 120 פיקסלים ובגובה של 90 פיקסלים. התמונה הממוזערת המוגדרת כברירת מחדל עבור ערוץ היא ברוחב 88 פיקסלים ובגובה 88 פיקסלים. medium – גרסה ברזולוציה גבוהה יותר של התמונה הממוזערת. כשמדובר בסרטון (או משאב שמתייחס לסרטון), התמונה הזו היא ברוחב 320 פיקסלים ובגובה של 180 פיקסלים. בערוץ, התמונה הזו היא ברוחב 240 פיקסלים ובגובה 240 פיקסלים. high – גרסה ברזולוציה גבוהה של התמונה הממוזערת. כשמדובר בסרטון (או משאב שמתייחס לסרטון), התמונה הזו היא ברוחב של 480 פיקסלים ובגובה של 360 פיקסלים. בערוץ, התמונה הזו היא ברוחב 800 פיקסלים ובגובה 800 פיקסלים.
subscriberSnippet.thumbnails.(key).url	string כתובת ה-URL של התמונה.
subscriberSnippet.thumbnails.(key).width	unsigned integer רוחב התמונה.
subscriberSnippet.thumbnails.(key).height	unsigned integer גובה התמונה.