FanFundingEvents: list
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
ملاحظة: هذا إعلان بشأن الإيقاف.
لقد تمّ إيقاف ميزة التمويل من المعجبين وسيتمّ إيقاف واجهة برمجة تطبيقات التمويل من المعجبين في 28 شباط (فبراير) 2017. يتزامن إعلان الإيقاف هذا مع إصدار ميزة
Super Chat الجديدة في YouTube.
يسرد أحداث التمويل من المعجبين لقناة. يجب أن يأذن مالك القناة بطلب واجهة برمجة التطبيقات.
طلب
طلب 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 التي ستتضمنها استجابة واجهة برمجة التطبيقات. القيمتان المسموح بإدراجهما هما id وsnippet. |
| المعلّمات الاختيارية |
hl |
string
توجِّه المَعلمة hl واجهة برمجة التطبيقات لاسترداد سلسلة عرض عملة مترجمة للغة لغة تطبيق معتمَدة على موقع YouTube الإلكتروني. على سبيل المثال، سيتم عرض العملة باللغة الإنجليزية على النحو $1.50، ولكن سيتم عرضها باللغة الفرنسية على الشكل 1,50$.
يجب أن تكون قيمة المعلّمة رمز لغة مضمّنًا في القائمة المعروضة باستخدام طريقة i18nLanguages.list. |
maxResults |
unsigned integer
تحدّد المعلمة maxResults الحد الأقصى لعدد العناصر التي يجب عرضها في مجموعة النتائج. القيم المقبولة هي 0 إلى 50، بما في ذلك القيم الواقعة بينهما. القيمة التلقائية هي 5. |
pageToken |
string
تحدّد المعلمة pageToken الصفحة المحدّدة في مجموعة النتائج التي يُطلب من خادم واجهة برمجة التطبيقات عرضها. في استجابة واجهة برمجة التطبيقات، تحدّد الخاصية nextPageToken الصفحة التالية من نتائج الطلب. |
نص الطلب
لا تقدِّم نص طلب عند طلب هذه الطريقة.
الإجابة
إذا نجحت هذه الطريقة، فإنها تعرض نص الاستجابة بالبنية التالية:
{
"kind": "youtube#fanFundingEventListResponse",
"etag": etag,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
fanFundingEvent resource
]
}
أماكن إقامة
يحدد الجدول التالي الخصائص التي تظهر في هذا المورد:
| أماكن إقامة |
kind |
string
تحدد نوع مورد واجهة برمجة التطبيقات. ستكون القيمة youtube#fanFundingEventListResponse. |
etag |
etag
Etag لهذا المورد. |
nextPageToken |
string
الرمز المميّز الذي يمكن استخدامه كقيمة للمعلَمة pageToken لاسترداد الصفحة التالية في مجموعة النتائج |
pageInfo |
object
يتضمّن الكائن pageInfo معلومات الصفحات في مجموعة النتائج. |
pageInfo.totalResults |
integer
إجمالي عدد النتائج في مجموعة النتائج. |
pageInfo.resultsPerPage |
integer
عدد النتائج المضمّنة في استجابة واجهة برمجة التطبيقات. |
items[] |
list
قائمة بأحداث التمويل من المعجبين التي تستوفي معايير الطلب. |
الأخطاء
يحدد الجدول التالي رسائل الخطأ التي يمكن أن تعرضها واجهة برمجة التطبيقات ردًا على استدعاء لهذه الطريقة. يرجى الاطلاع على وثائق رسالة الخطأ لمزيد من التفاصيل.
| نوع الخطأ |
تفاصيل الخطأ |
الوصف |
forbidden (403) |
insufficientPermissions |
ليست لديك الأذونات اللازمة لعرض أحداث التمويل من المعجبين في القناة. |
invalidValue (400) |
fanFundingNotEnabledForChannelId |
عدم تفعيل ميزة التمويل من المعجبين في القناة. |
جرِّب هذه الميزة الآن.
استخدم مستكشف واجهة برمجة التطبيقات لاستدعاء هذه الطريقة في البيانات المباشرة والاطلاع على طلب واجهة برمجة التطبيقات والاستجابة لها.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2023-02-22 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2023-02-22 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\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."]]
