Subscriptions

משאב subscription מכיל מידע על מינוי של משתמש ב-YouTube. מינוי מאפשר למשתמש לקבל התראה כשסרטונים חדשים מתווספים לערוץ או כשמשתמש אחר מבצע אחת מכמה פעולות ב-YouTube, כמו העלאת סרטון, דירוג סרטון או הוספת תגובה לסרטון.

Methods

ה-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
ה-Etag של מקור המידע הזה.
id string
המזהה שמשמש את YouTube לזיהוי ייחודי של המינוי.
snippet object
האובייקט snippet מכיל פרטים בסיסיים על המינוי, כולל השם והערוץ שהמשתמש נרשם אליו.
snippet.publishedAt datetime
התאריך והשעה שבהם נוצר המינוי. הערך מצוין בפורמט ISO 8601.
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
סוג הפעילות שאליה מתייחסת המינוי (רק העלאות, כל הפעילויות).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
גובה התמונה.