FanFundingEvents: list
Sử dụng bộ sưu tập để sắp xếp ngăn nắp các trang
Lưu và phân loại nội dung dựa trên lựa chọn ưu tiên của bạn.
Lưu ý: Đây là thông báo về việc ngừng sử dụng.
Tính năng Tài trợ của người hâm mộ đã ngừng hoạt động và API Tài trợ của người hâm mộ sẽ bị tắt vào ngày 28 tháng 2 năm 2017. Thông báo về việc ngừng cung cấp này trùng với việc phát hành tính năng
Super Chat mới của YouTube.
Liệt kê các sự kiện tài trợ của người hâm mộ cho một kênh. Yêu cầu API phải được chủ sở hữu kênh cho phép.
Yêu cầu
Yêu cầu HTTP
GET https://www.googleapis.com/youtube/v3/fanFundingEvents
Ủy quyền
Yêu cầu này yêu cầu uỷ quyền có ít nhất một trong các phạm vi sau (đọc thêm về xác thực và cấp phép).
| Phạm vi |
|---|
https://www.googleapis.com/auth/youtube |
https://www.googleapis.com/auth/youtube.force-ssl |
https://www.googleapis.com/auth/youtube.readonly |
Các tham số
Bảng sau trình bày các tham số mà truy vấn này hỗ trợ. Tất cả thông số được liệt kê đều là thông số truy vấn.
| Các tham số |
| Các thông số bắt buộc |
part |
string
Tham số part chỉ định các phần tài nguyên fanFundingEvent mà phản hồi API sẽ đưa vào. Giá trị được hỗ trợ là id và snippet. |
| Tham số không bắt buộc |
hl |
string
Thông số hl hướng dẫn API truy xuất chuỗi hiển thị nội dung được bản địa hóa cho một ngôn ngữ ứng dụng cụ thể mà trang web YouTube hỗ trợ. Ví dụ: bằng tiếng Anh, đơn vị tiền tệ sẽ hiển thị là $1.50, nhưng bằng tiếng Pháp, đơn vị tiền tệ sẽ hiển thị là 1,50$.
Giá trị thông số phải là mã ngôn ngữ có trong danh sách được phương thức i18nLanguages.list trả về. |
maxResults |
unsigned integer
Tham số maxResults chỉ định số lượng mục tối đa cần trả về trong tập hợp kết quả. Giá trị được chấp nhận là từ 0 đến 50, bao gồm cả hai giá trị này. Giá trị mặc định là 5. |
pageToken |
string
Tham số pageToken xác định trang cụ thể trong tập hợp kết quả mà máy chủ API được yêu cầu trả về. Trong một phản hồi API, thuộc tính nextPageToken xác định trang kết quả tiếp theo cho yêu cầu. |
Nội dung yêu cầu
Không cung cấp nội dung yêu cầu khi gọi phương thức này.
Phản hồi
Nếu thành công, phương thức này sẽ trả về nội dung phản hồi với cấu trúc sau:
{
"kind": "youtube#fanFundingEventListResponse",
"etag": etag,
"nextPageToken": string,
"pageInfo": {
"totalResults": integer,
"resultsPerPage": integer
},
"items": [
fanFundingEvent resource
]
}
Thuộc tính
Bảng sau đây xác định các thuộc tính xuất hiện trong tài nguyên này:
| Thuộc tính |
kind |
string
Xác định loại tài nguyên API. Giá trị sẽ là youtube#fanFundingEventListResponse. |
etag |
etag
Etag của tài nguyên này. |
nextPageToken |
string
Mã thông báo có thể được dùng làm giá trị của thông số pageToken để truy xuất trang tiếp theo trong tập hợp kết quả. |
pageInfo |
object
Đối tượng pageInfo đóng gói thông tin phân trang cho tập hợp kết quả. |
pageInfo.totalResults |
integer
Tổng số kết quả trong tập hợp kết quả. |
pageInfo.resultsPerPage |
integer
Số lượng kết quả có trong phản hồi API. |
items[] |
list
Danh sách các sự kiện liên quan đến Tài trợ của người hâm mộ phù hợp với tiêu chí của yêu cầu. |
Lỗi
Bảng sau đây xác định các thông báo lỗi mà API có thể trả về khi một lệnh gọi đến phương thức này. Vui lòng xem tài liệu về thông báo lỗi để biết thêm thông tin chi tiết.
| Loại lỗi |
Thông tin chi tiết về lỗi |
Mô tả |
forbidden (403) |
insufficientPermissions |
Bạn không có các quyền cần thiết để xem sự kiện Tài trợ của người hâm mộ của kênh. |
invalidValue (400) |
fanFundingNotEnabledForChannelId |
Kênh chưa bật tính năng Tài trợ của người hâm mộ. |
Hãy dùng thử!
Hãy dùng API Explorer để gọi phương thức này trên dữ liệu trực tiếp và xem yêu cầu cũng như phản hồi của API.
Trừ phi có lưu ý khác, nội dung của trang này được cấp phép theo Giấy phép ghi nhận tác giả 4.0 của Creative Commons và các mẫu mã lập trình được cấp phép theo Giấy phép Apache 2.0. Để biết thông tin chi tiết, vui lòng tham khảo Chính sách trang web của Google Developers. Java là nhãn hiệu đã đăng ký của Oracle và/hoặc các đơn vị liên kết với Oracle.
Cập nhật lần gần đây nhất: 2023-02-22 UTC.
[null,null,["Cập nhật lần gần đây nhất: 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."]]
