התכונה 'מימון על ידי אוהדים' הוצאה משימוש ו-Fan Funding API יושבת ב-28 בפברואר 2017. ההודעה על ההוצאה משימוש קרובה להשקה של התכונה החדשה YouTube Chat.
רשימת אירועי מימון של מעריצים בערוץ. בקשת ה-API חייבת לקבל הרשאה מהבעלים של הערוץ.
שליחת בקשה
בקשת HTTP
GET https://www.googleapis.com/youtube/v3/fanFundingEvents
הרשאה
לבקשה הזו נדרשת הרשאה עם לפחות אחד מהיקפי ההרשאות הבאים (מידע נוסף על אימות והרשאה).
היקף |
---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtube.readonly |
פרמטרים
הטבלה הבאה מפרטת את הפרמטרים שנתמכים על ידי שאילתה זו. כל הפרמטרים המפורטים הם פרמטרים של שאילתה.
פרמטרים | ||
---|---|---|
פרמטרים נדרשים | ||
part |
string הפרמטר part מציין את חלקי ה-fanFundingEvent שהתגובה ל-API תכלול. הערכים הנתמכים הם id ו-snippet . |
|
פרמטרים אופציונליים | ||
hl |
string הפרמטר hl מורה ל-API לאחזר מחרוזת תצוגה של מטבעות מקומיים עבור שפת אפליקציה ספציפית שנתמכת באתר YouTube. לדוגמה, המטבע יוצג באנגלית בתור $1.50 , אבל בצרפתית הוא יוצג בתור 1,50$ .ערך הפרמטר חייב להיות קוד שפה שכלול ברשימה, ושמוחזרת בשיטה i18nLanguages.list . |
|
maxResults |
unsigned integer הפרמטר maxResults מציין את מספר הפריטים המקסימלי שיש להחזיר בקבוצת התוצאות. הערכים הקבילים הם 0 עד 50 , כולל. ערך ברירת המחדל הוא 5 . |
|
pageToken |
string הפרמטר pageToken מזהה את הדף הספציפי בקבוצת התוצאות שהתבקשה על ידי שרת ה-API להחזיר. בתגובת API, המאפיין nextPageToken מזהה את דף התוצאות הבא של הבקשה. |
גוף הבקשה
אין להזין גוף בקשה בעת הפעלת שיטה זו.
תשובה
אם התגובה מוצלחת, שיטה זו תחזיר גוף תגובה בעל המבנה הבא:
{ "kind": "youtube#fanFundingEventListResponse", "etag": etag, "nextPageToken": string, "pageInfo": { "totalResults": integer, "resultsPerPage": integer }, "items": [ fanFundingEvent resource ] }
נכסים
הטבלה הבאה מגדירה את המאפיינים שמופיעים במשאב הזה:
נכסים | |
---|---|
kind |
string מזהה את סוג המשאב של ה-API. הערך יהיה youtube#fanFundingEventListResponse . |
etag |
etag התג של המשאב הזה. |
nextPageToken |
string האסימון שיכול לשמש כערך של הפרמטר pageToken כדי לאחזר את הדף הבא בקבוצת התוצאות. |
pageInfo |
object האובייקט pageInfo כולל פרטי החלפה לקבוצת התוצאות. |
pageInfo.totalResults |
integer מספר התוצאות הכולל בקבוצת התוצאות. |
pageInfo.resultsPerPage |
integer מספר התוצאות הכלולות בתגובת ה-API. |
items[] |
list רשימה של אירועי מימון של מעריצים שתואמים לקריטריונים של הבקשה. |
שגיאות
הטבלה הבאה מזהה הודעות שגיאה שה-API יכול להחזיר בתגובה לקריאה לשיטה הזו. מידע נוסף זמין בתיעוד של הודעת השגיאה.
סוג השגיאה | פרטי השגיאה | תיאור |
---|---|---|
forbidden (403) |
insufficientPermissions |
אין לך את ההרשאות הדרושות כדי להציג את אירועי 'מימון על ידי אוהדים' של הערוץ. |
invalidValue (400) |
fanFundingNotEnabledForChannelId |
'מימון על ידי אוהדים' לא מופעל בערוץ. |
רוצה לנסות?
אפשר להשתמש ב-API Explorer כדי להפעיל שיטה זו בנתונים בזמן אמת, ולראות את הבקשה והתגובה ב-API.