Sponsors: list

הערה: השיטה הזו הוצאה משימוש ב-31 במרץ 2020. החליפה את השיטה members.list. אפשר למצוא מידע על השיטה הזו במסמכי התיעוד של YouTube Data API.

החל מ-30 בספטמבר 2020 לא תהיה יותר תמיכה בשיטה sponsors.list. לקוחות ה-API צריכים לעדכן את הקריאות ל-method sponsors.list כדי להשתמש במקום זאת ב-method members.list.

רשימה של החברים (לשעבר 'נותני חסות') בערוץ. הבעלים של הערוץ צריכים לאשר את בקשת ה-API.

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

בקשה

בקשת HTTP

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

אישור

בקשה זו מחייבת הרשאה עם לפחות אחד מההיקפים הבאים (מידע נוסף על אימות והרשאה).

היקף
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl
https://www.googleapis.com/auth/youtube.readonly

פרמטרים

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

פרמטרים
הפרמטרים הנדרשים
part string
הפרמטר part מציין את חלקי המשאבים של sponsor שייכללו בתגובת ה-API. הערכים הנתמכים הם id ו-snippet.
פרמטרים אופציונליים
filter string
הפרמטר filter מציין אילו ערוצים נותני חסות יחזירו. ערך ברירת המחדל הוא newest.

הערכים הקבילים הם:
  • all – החזרת כל נותני החסות, מהחדש ביותר לישן ביותר.
  • newest – הצגת דף אחד של נותני החסות האחרונים. הבקשות הבאות שמשתמשות ב-nextPageToken מאחזרות מנויים חדשים יותר כאשר הם נרשמים.
maxResults unsigned integer
הפרמטר maxResults מציין את מספר הפריטים המקסימלי שצריך להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50, כולל. ערך ברירת המחדל הוא 5.
pageToken string
הפרמטר pageToken מזהה דף ספציפי בקבוצת התוצאות שצריך להחזיר. בתגובת ה-API, המאפיינים nextPageToken ו-prevPageToken מזהים דפים אחרים שניתן לאחזר.

גוף הבקשה

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

תשובה

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

{
  "kind": "youtube#sponsorListResponse",
  "etag": etag,
  "nextPageToken": string,
  "pageInfo": {
    "totalResults": integer,
    "resultsPerPage": integer
  },
  "items": [
    sponsor resource
  ]
}

תכונות

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

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

שגיאות

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

סוג השגיאה פרטי השגיאה תיאור
forbidden (403) insufficientPermissions אין לך את ההרשאות הדרושות כדי לראות את נותני החסות של הערוץ.
invalidValue (400) invalidValueInRequest הבקשה מכילה ערך לא חוקי.
invalidValue (400) sponsorshipNotEnabledForChannelId בערוץ לא מופעלות חסויות.

רוצה לנסות?

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