AI-generated Key Takeaways
-
This
sponsorsresource is deprecated as of March 31, 2020, and has been replaced by thememberresource, with thesponsors.listmethod no longer supported after September 30, 2020. -
A
sponsorresource represents a YouTube channel member who provides recurring monetary support and receives special benefits. -
The
sponsors.listmethod allowed API clients to list the sponsors for a channel, but now they should usemembers.listinstead. -
The
sponsorsresource contains properties such askind,etag,id, andsnippetwhich includes detailed information like the channel ID, display name, profile image URL, and the date they became a sponsor.
member resource. You can find
information about that resource in the YouTube Data API documentation.As part of this deprecation, the
sponsors.list method will no longer be supported
on or after September 30, 2020. API clients should update calls to the
sponsors.list method to use the
members.list method instead.
A sponsor resource represents a channel member (formerly known as a "sponsor") for a YouTube channel.
A member provides recurring monetary support to a creator and receives
special benefits. For example, members are able to chat when the creator turns on members-only mode for a chat.
Methods
The API supports the following methods for sponsors resources:
- list
- Lists sponsors for a channel. The API request must be authorized by the channel owner. Try it now.
Resource representation
The following JSON structure shows the format of a sponsors resource:
{
"kind": "youtube#sponsor",
"etag": etag,
"id": string,
"snippet": {
"channelId": string,
"sponsorDetails": {
"channelId": string,
"channelUrl": string,
"displayName": string,
"profileImageUrl": string
},
"sponsorSince": datetime
}
}Properties
The following table defines the properties that appear in this resource:
| Properties | |
|---|---|
kind |
stringIdentifies the API resource's type. The value will be youtube#sponsor. |
etag |
etagThe Etag of this resource. |
id |
stringThe ID that YouTube assigns to uniquely identify the sponsor. |
snippet |
objectThe snippet object contains details about the sponsor. |
snippet.channelId |
stringThis ID identifies the channel being sponsored. |
snippet.sponsorDetails |
objectThis object contains details about the sponsor. |
snippet.sponsorDetails.channelId |
stringThe YouTube channel ID. |
snippet.sponsorDetails.channelUrl |
stringThe channel's URL. |
snippet.sponsorDetails.displayName |
stringThe channel's display name. |
snippet.sponsorDetails.profileImageUrl |
stringThe channels's avatar URL. |
snippet.sponsorSince |
datetimeThe date and time when the user became a sponsor. The value is specified in ISO 8601 ( YYYY-MM-DDThh:mm:ss.sZ) format. |