FanFundingEvents: list
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
הערה: זוהי הודעה על הוצאה משימוש.
התכונה 'מימון על ידי אוהדים' הוצאה משימוש ו-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.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2023-02-22 (שעון UTC).
[null,null,["עדכון אחרון: 2023-02-22 (שעון UTC)."],[[["\u003cp\u003eThe Fan Funding feature has been deprecated and its API will be shut down on February 28, 2017, replaced by YouTube's new Super Chat feature.\u003c/p\u003e\n"],["\u003cp\u003eThis API lists fan funding events for a channel, and the request must be authorized by the channel owner using one of the specified scopes.\u003c/p\u003e\n"],["\u003cp\u003eThe API requires the \u003ccode\u003epart\u003c/code\u003e parameter to specify which \u003ccode\u003efanFundingEvent\u003c/code\u003e resource parts to include, and supports optional parameters like \u003ccode\u003ehl\u003c/code\u003e, \u003ccode\u003emaxResults\u003c/code\u003e, and \u003ccode\u003epageToken\u003c/code\u003e for customization.\u003c/p\u003e\n"],["\u003cp\u003eThe API does not require a request body, and the response structure includes properties like \u003ccode\u003ekind\u003c/code\u003e, \u003ccode\u003eetag\u003c/code\u003e, \u003ccode\u003enextPageToken\u003c/code\u003e, \u003ccode\u003epageInfo\u003c/code\u003e, and \u003ccode\u003eitems\u003c/code\u003e, providing information about the result set and fan funding events.\u003c/p\u003e\n"],["\u003cp\u003eThe API may return errors like \u003ccode\u003eforbidden (403)\u003c/code\u003e for insufficient permissions or \u003ccode\u003einvalidValue (400)\u003c/code\u003e if fan funding is not enabled for the channel.\u003c/p\u003e\n"]]],["The Fan Funding feature and its API are deprecated and will be shut down on February 28, 2017, replaced by Super Chat. The API, accessible via a `GET` request, requires channel owner authorization and lists fan funding events. Key parameters include `part` (required), `hl`, `maxResults`, and `pageToken` (optional). The response includes details like kind, etag, and a list of fan funding events, while error handling is available.\n"],null,["# FanFundingEvents: list\n\n**Note:** This is a deprecation announcement. \n\nThe Fan Funding feature has been deprecated, and the Fan Funding API will be turned off on February 28, 2017. This deprecation announcement coincides with the release of YouTube's new [Super Chat](https://youtube.googleblog.com/2017/01/can-we-chat-hello-super-chat.html) feature.\nLists fan funding events for a channel. The API request must be authorized by the channel owner.\n\nRequest\n-------\n\n### HTTP request\n\n```\nGET https://www.googleapis.com/youtube/v3/fanFundingEvents\n```\n\n### Authorization\n\nThis request requires authorization with at least one of the following scopes ([read more about authentication and authorization](/youtube/v3/live/authentication)).\n\n| Scope |\n|-----------------------------------------------------|\n| `https://www.googleapis.com/auth/youtube` |\n| `https://www.googleapis.com/auth/youtube.force-ssl` |\n| `https://www.googleapis.com/auth/youtube.readonly` |\n\n### Parameters\n\nThe following table lists the parameters that this query supports. All of the parameters listed are query parameters.\n\n| Parameters ||\n|--------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| **Required parameters** |||\n| `part` | `string` The **part** parameter specifies the `fanFundingEvent` resource parts that the API response will include. Supported values are `id` and `snippet`. |\n| **Optional parameters** |||\n| `hl` | `string` The **hl** parameter instructs the API to retrieve a localized currency display string for a specific [application language that the YouTube website supports](/youtube/v3/docs/i18nLanguages). For example, in English, currency would be displayed as `$1.50`, but in French, it would be displayed as `1,50$`. The parameter value must be a language code included in the list returned by the [i18nLanguages.list](/youtube/v3/docs/i18nLanguages/list) method. |\n| `maxResults` | `unsigned integer` The **maxResults** parameter specifies the maximum number of items that should be returned in the result set. Acceptable values are `0` to `50`, inclusive. The default value is `5`. |\n| `pageToken` | `string` The **pageToken** parameter identifies the specific page in the result set that the API server is being asked to return. In an API response, the `nextPageToken` property identifies the next page of results for the request. |\n\n### Request body\n\nDo not provide a request body when calling this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure: \n\n```objective-c\n{\n \"kind\": \"youtube#fanFundingEventListResponse\",\n \"etag\": etag,\n \"nextPageToken\": string,\n \"pageInfo\": {\n \"totalResults\": integer,\n \"resultsPerPage\": integer\n },\n \"items\": [\n fanFundingEvent resource\n ]\n}\n```\n\n### Properties\n\nThe following table defines the properties that appear in this resource:\n\n| Properties ||\n|---------------------------|----------------------------------------------------------------------------------------------------------------------------|\n| `kind` | `string` Identifies the API resource's type. The value will be `youtube#fanFundingEventListResponse`. |\n| `etag` | `etag` The Etag of this resource. |\n| `nextPageToken` | `string` The token that can be used as the value of the `pageToken` parameter to retrieve the next page in the result set. |\n| `pageInfo` | `object` The `pageInfo` object encapsulates paging information for the result set. |\n| pageInfo.`totalResults` | `integer` The total number of results in the result set. |\n| pageInfo.`resultsPerPage` | `integer` The number of results included in the API response. |\n| `items[]` | `list` A list of fan funding events that match the request criteria. |\n\nErrors\n------\n\nThe following table identifies error messages that the API could return in response to a call to this method. Please see the [error message](/youtube/v3/live/docs/errors) documentation for more detail.\n\n| Error type | Error detail | Description |\n|----------------------|------------------------------------|-------------------------------------------------------------------------------------|\n| `forbidden (403)` | `insufficientPermissions` | You do not have the necessary permissions to view the channel's Fan Funding events. |\n| `invalidValue (400)` | `fanFundingNotEnabledForChannelId` | The channel does not have Fan Funding enabled. |\n\nTry it!\n-------\n\nUse the API Explorer to call this method on live data and see the API request and response."]]
