Subscriptions: list

מחזירה משאבי מינוי שתואמים לקריטריונים של בקשת ה-API.

ההשפעה של המכסה: לקריאה לשיטה הזו יש עלות מכסה של יחידה אחת.

תרחישים נפוצים לדוגמה

בקשה

בקשת HTTP

GET https://www.googleapis.com/youtube/v3/subscriptions

פרמטרים

בטבלה הבאה מפורטים הפרמטרים שהשאילתה הזו תומכת בהם. כל הפרמטרים המפורטים הם פרמטרים של שאילתות.

פרמטרים
הפרמטרים הנדרשים
part string
הפרמטר part מציין רשימה מופרדת בפסיקים של מאפייני משאב subscription אחד או יותר שייכללו בתגובה של ה-API.

אם הפרמטר מזהה נכס שמכיל נכסי צאצא, מאפייני הצאצאים ייכללו בתגובה. לדוגמה, במשאב subscription, המאפיין snippet מכיל מאפיינים אחרים כמו שם תצוגה של המינוי. אם מגדירים את part=snippet, תגובת ה-API תכלול גם את כל המאפיינים המקוננים.

הרשימה הבאה מכילה את השמות מסוג part שניתן לכלול בערך הפרמטר:
  • contentDetails
  • id
  • snippet
  • subscriberSnippet
מסננים (יש לציין בדיוק אחד מהפרמטרים הבאים)
channelId string
הפרמטר channelId מציין מזהה של ערוץ YouTube. ה-API יחזיר רק את המינויים של הערוץ הזה.
id string
הפרמטר id מציין רשימה מופרדת בפסיקים של מזהי המינויים ל-YouTube של המשאבים שמאוחזרים. במשאב subscription, המאפיין id מציין את מזהה המינוי ל-YouTube.
mine boolean
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. צריך להגדיר את ערך הפרמטר הזה ל-true כדי לאחזר פיד של המינויים של המשתמש המאומת.
myRecentSubscribers boolean
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. צריך להגדיר את ערך הפרמטר הזה ל-true כדי לאחזר פיד של המנויים של המשתמש המאומת בסדר כרונולוגי הפוך (מהחדש לישן).

הערה: ייתכן שמספר המנויים המקסימלי שמוחזר דרך ה-API הזה יהיה מוגבל.
mySubscribers boolean
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. צריך להגדיר את ערך הפרמטר הזה ל-true כדי לאחזר פיד של המנויים של המשתמש המאומת ללא סדר מסוים. לתשומת ליבך: ייתכן שמספר המנויים המקסימלי שמוחזרים דרך ה-API הזה מוגבל.
פרמטרים אופציונליים
forChannelId string
הפרמטר forChannelId מציין רשימה של מזהי ערוצים שמופרדים בפסיקים. תגובת ה-API תכלול רק מינויים שתואמים לערוצים האלה.
maxResults unsigned integer
הפרמטר maxResults מציין את מספר הפריטים המקסימלי שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50, כולל. ערך ברירת המחדל הוא 5.
onBehalfOfContentOwner string
הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

הפרמטר onBehalfOfContentOwner מציין שפרטי הכניסה של הבקשה להרשאה מזהים משתמש YouTube CMS שפועל בשם בעלי התוכן שצוין בערך הפרמטר. הפרמטר הזה מיועד לשותפי תוכן של YouTube שהם הבעלים והמנהלים של ערוצי YouTube רבים ושונים. היא מאפשרת לבעלי תוכן לבצע אימות פעם אחת ולקבל גישה לכל נתוני הסרטונים והערוץ, בלי שיצטרכו לספק פרטי כניסה לאימות עבור כל ערוץ בנפרד. חשבון ה-CMS שאיתו המשתמש מבצע אימות חייב להיות מקושר לבעלי התוכן שצוינו ב-YouTube.
onBehalfOfContentOwnerChannel string
ניתן להשתמש בפרמטר הזה רק במסגרת בקשה מורשית תקינה. הערה: הפרמטר הזה מיועד אך ורק לשותפי תוכן של YouTube.

הפרמטר onBehalfOfContentOwnerChannel מציין את מזהה ערוץ YouTube של הערוץ שאליו מוסיפים את הסרטון. הפרמטר הזה נדרש כאשר בקשה מציינת ערך לפרמטר onBehalfOfContentOwner, ואפשר להשתמש בו רק בשילוב עם הפרמטר הזה. בנוסף, יש לאשר את הבקשה באמצעות חשבון CMS שמקושר לבעלי התוכן בפרמטר onBehalfOfContentOwner. לבסוף, הערוץ שצוין בערך הפרמטר onBehalfOfContentOwnerChannel חייב להיות מקושר לבעלי התוכן שהפרמטר onBehalfOfContentOwner מציין.

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

הערכים הקבילים הם:
  • alphabetical – מיון לפי סדר אלפביתי.
  • relevance – מיון לפי רלוונטיות.
  • unread – מיון לפי סדר הפעילות.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובת ה-API, המאפיינים nextPageToken ו-prevPageToken מזהים דפים אחרים שניתן לאחזר.

גוף הבקשה

אין לציין את גוף הבקשה בקריאה לשיטה הזו.

תשובה

אם הפעולה בוצעה בהצלחה, השיטה הזו מחזירה גוף תגובה עם המבנה הבא:

{
  "kind": "youtube#subscriptionListResponse",
  "etag": etag,
  "nextPageToken": string,
  "prevPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    subscription Resource
  ]
}

תכונות

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

תכונות
kind string
מזהה את הסוג של משאב ה-API. הערך יהיה youtube#subscriptionListResponse.
etag etag
ה-e של המשאב הזה.
nextPageToken string
האסימון שיכול לשמש כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות.
prevPageToken string
האסימון שיכול לשמש כערך הפרמטר pageToken כדי לאחזר את הדף הקודם בקבוצת התוצאות.
pageInfo object
האובייקט pageInfo כולל את פרטי החלוקה לדפים של קבוצת התוצאות.
pageInfo.totalResults integer
המספר הכולל של התוצאות בקבוצת התוצאות.
pageInfo.resultsPerPage integer
מספר התוצאות שכלולות בתגובת ה-API.
items[] list
רשימת המינויים שעומדים בקריטריונים לבקשה.

שגיאות

בטבלה הבאה מפורטות הודעות השגיאה שה-API עלול להחזיר בתגובה לקריאה לשיטה הזו. פרטים נוספים זמינים במסמכים בנושא הודעת שגיאה.

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) accountClosed לא ניתן היה לאחזר את המינויים כי החשבון של המנוי סגור.
forbidden (403) accountSuspended לא ניתן לאחזר את המינויים כי החשבון של המנוי מושעה.
forbidden (403) subscriptionForbidden המבקש אינו רשאי לגשת למינויים המבוקשים.
notFound (404) subscriberNotFound לא ניתן למצוא את המנוי שצוין בבקשה.

רוצה לנסות?

משתמשים ב-APIs Explorer כדי לקרוא ל-API הזה ולראות את הבקשה והתגובה של ה-API.