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
      }
    }
  }
}

תכונות

הטבלה הבאה מגדירה את המאפיינים שיופיעו במשאב הזה:

תכונות
kindstring
מזהה את הסוג של משאב ה-API. הערך יהיה youtube#subscription.
etagetag
ה-e של המשאב הזה.
idstring
המזהה שמשמש את YouTube לזיהוי ייחודי של המינוי.
snippetobject
האובייקט snippet מכיל פרטים בסיסיים על המינוי, כולל שם המינוי והערוץ שאליו המשתמש נרשם.
snippet.publishedAtdatetime
התאריך והשעה שבהם נוצר המינוי. הערך מצוין בפורמט ISO 8601.
snippet.channelTitlestring
שם הערוץ שאליו שייך המינוי.
snippet.titlestring
שם המינוי.
snippet.descriptionstring
פרטי המינוי.
snippet.resourceIdobject
האובייקט id מכיל מידע על הערוץ שהמשתמש נרשם אליו.
snippet.resourceId.kindstring
הסוג של משאב ה-API.
snippet.resourceId.channelIdstring
הערך שמשמש את YouTube לזיהוי ייחודי של הערוץ שהמשתמש נרשם אליו.
snippet.channelIdstring
המזהה שמשמש את YouTube לזיהוי ייחודי של הערוץ של המנוי. האובייקט resource_id מזהה את הערוץ שהמשתמש נרשם אליו.
snippet.thumbnailsobject
מפה של תמונות ממוזערות שמשויכות למינוי. עבור כל אובייקט במפה, המפתח הוא השם של התמונה הממוזערת והערך הוא אובייקט שמכיל מידע נוסף על התמונה הממוזערת.
snippet.thumbnails.(key)object
ערכי המפתח החוקיים הם:
  • default – התמונה הממוזערת המוגדרת כברירת מחדל למשאב הזה. התמונה הממוזערת המוגדרת כברירת מחדל של סרטון – או משאב שמפנה לסרטון, כמו פריט בפלייליסט או תוצאת חיפוש – היא ברוחב של 120 פיקסלים ובגובה של 90 פיקסלים. התמונה הממוזערת שמוגדרת כברירת מחדל לערוץ היא ברוחב 88 פיקסלים וגובה של 88 פיקסלים.
  • medium – גרסה של התמונה הממוזערת ברזולוציה גבוהה יותר. לסרטון (או למקור מידע שמפנה לסרטון), רוחב התמונה הוא 320 פיקסלים וגובהה הוא 180 פיקסלים. כשמדובר בערוץ, התמונה הזו היא ברוחב של 240 פיקסלים ובגובה של 240 פיקסלים.
  • high – גרסה של התמונה הממוזערת ברזולוציה גבוהה. לסרטון (או משאב שמפנה לסרטון), רוחב התמונה הוא 480 פיקסלים וגובהה הוא 360 פיקסלים. כשמדובר בערוץ, התמונה הזו היא ברוחב של 800 פיקסלים ובגובה של 800 פיקסלים.
snippet.thumbnails.(key).urlstring
כתובת ה-URL של התמונה.
snippet.thumbnails.(key).widthunsigned integer
רוחב התמונה.
snippet.thumbnails.(key).heightunsigned integer
גובה התמונה.
contentDetailsobject
האובייקט contentDetails מכיל נתונים סטטיסטיים בסיסיים לגבי המינוי.
contentDetails.totalItemCountunsigned integer
המספר המשוער של הפריטים שאליהם המינוי מפנה.
contentDetails.newItemCountunsigned integer
מספר הפריטים החדשים במינוי מאז הקריאה האחרונה של התוכן שלו.
contentDetails.activityTypestring
סוג הפעילות עבור המינוי הזה (רק העלאות, הכול).

הערכים החוקיים לנכס הזה הם:
  • all
  • uploads
subscriberSnippetobject
האובייקט subscriberSnippet מכיל פרטים בסיסיים על המנוי.
subscriberSnippet.titlestring
שם הערוץ של המנוי.
subscriberSnippet.descriptionstring
תיאור הערוץ של המנוי.
subscriberSnippet.channelIdstring
המזהה שהוקצה על ידי YouTube לזיהוי ייחודי של הערוץ של המנוי.
subscriberSnippet.thumbnailsobject
תמונות ממוזערות של הערוץ של המנוי.
subscriberSnippet.thumbnails.(key)object
ערכי המפתח החוקיים הם:
  • default – התמונה הממוזערת המוגדרת כברירת מחדל למשאב הזה. התמונה הממוזערת המוגדרת כברירת מחדל של סרטון – או משאב שמפנה לסרטון, כמו פריט בפלייליסט או תוצאת חיפוש – היא ברוחב של 120 פיקסלים ובגובה של 90 פיקסלים. התמונה הממוזערת שמוגדרת כברירת מחדל לערוץ היא ברוחב 88 פיקסלים וגובה של 88 פיקסלים.
  • medium – גרסה של התמונה הממוזערת ברזולוציה גבוהה יותר. לסרטון (או למקור מידע שמפנה לסרטון), רוחב התמונה הוא 320 פיקסלים וגובהה הוא 180 פיקסלים. כשמדובר בערוץ, התמונה הזו היא ברוחב של 240 פיקסלים ובגובה של 240 פיקסלים.
  • high – גרסה של התמונה הממוזערת ברזולוציה גבוהה. לסרטון (או משאב שמפנה לסרטון), רוחב התמונה הוא 480 פיקסלים וגובהה הוא 360 פיקסלים. כשמדובר בערוץ, התמונה הזו היא ברוחב של 800 פיקסלים ובגובה של 800 פיקסלים.
subscriberSnippet.thumbnails.(key).urlstring
כתובת ה-URL של התמונה.
subscriberSnippet.thumbnails.(key).widthunsigned integer
רוחב התמונה.
subscriberSnippet.thumbnails.(key).heightunsigned integer
גובה התמונה.