FanFundingEvents: list
Stay organized with collections
Save and categorize content based on your preferences.
Note:
This is a deprecation announcement.
The 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
feature.
Lists fan funding events for a channel. The API request must be authorized by the channel owner.
Request
HTTP request
GET https://www.googleapis.com/youtube/v3/fanFundingEvents
Authorization
This request requires authorization with at least one of the following scopes (
read more about authentication and authorization
).
Scope
|
https://www.googleapis.com/auth/youtube
|
https://www.googleapis.com/auth/youtube.force-ssl
|
https://www.googleapis.com/auth/youtube.readonly
|
Parameters
The following table lists the parameters that this query supports. All of the parameters listed are query parameters.
Parameters
|
Required parameters
|
part
|
string
The
part
parameter specifies the
fanFundingEvent
resource parts that the API response will include. Supported values are
id
and
snippet
.
|
Optional parameters
|
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
. 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
method.
|
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
.
|
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.
|
Request body
Do not provide a request body when calling this method.
Response
If successful, this method returns a response body with the following structure:
{
"kind": "youtube#fanFundingEventListResponse",
"etag":
etag
,
"nextPageToken":
string
,
"pageInfo": {
"totalResults":
integer
,
"resultsPerPage":
integer
},
"items": [
fanFundingEvent resource
]
}
Properties
The following table defines the properties that appear in this resource:
Properties
|
kind
|
string
Identifies the API resource's type. The value will be
youtube#fanFundingEventListResponse
.
|
etag
|
etag
The Etag of this resource.
|
nextPageToken
|
string
The token that can be used as the value of the
pageToken
parameter to retrieve the next page in the result set.
|
pageInfo
|
object
The
pageInfo
object encapsulates paging information for the result set.
|
pageInfo.
totalResults
|
integer
The total number of results in the result set.
|
pageInfo.
resultsPerPage
|
integer
The number of results included in the API response.
|
items[]
|
list
A list of fan funding events that match the request criteria.
|
Errors
The following table identifies error messages that the API could return in response to a call to this method. Please see the
error message
documentation for more detail.
Error type
|
Error detail
|
Description
|
forbidden (403)
|
insufficientPermissions
|
You do not have the necessary permissions to view the channel's Fan Funding events.
|
invalidValue (400)
|
fanFundingNotEnabledForChannelId
|
The channel does not have Fan Funding enabled.
|
Try it!
Use the API Explorer to call this method on live data and see the API request and response.
Except as otherwise noted, the content of this page is licensed under the
Creative Commons Attribution 4.0 License
, and code samples are licensed under the
Apache 2.0 License
. For details, see the
Google Developers Site Policies
. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2022-11-04 UTC.
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"Missing the information I need"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"Too complicated / too many steps"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"Out of date"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"Samples / code issue"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"Other"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"Easy to understand"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"Solved my problem"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"Other"
}]