List
|
|||||
|
|
||||
Lists sponsors for a channel
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- Manage your YouTube account
- See, edit, and permanently delete your YouTube videos, ratings, comments and captions
- View your YouTube account
Input
This building block consumes 4 input parameters
| Name | Format | Description |
|---|---|---|
part Required |
STRING |
The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet |
filter |
ENUMERATION |
The filter parameter specifies which channel sponsors to return |
maxResults |
INTEGER |
The maxResults parameter specifies the maximum number of items that should be returned in the result set |
pageToken |
STRING |
The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved |
= Parameter name
= Format
|
part STRING Required The part parameter specifies the sponsor resource parts that the API response will include. Supported values are id and snippet |
|
filter ENUMERATION The filter parameter specifies which channel sponsors to return |
|
maxResults INTEGER The maxResults parameter specifies the maximum number of items that should be returned in the result set |
|
pageToken STRING The pageToken parameter identifies a specific page in the result set that should be returned. In an API response, the nextPageToken and prevPageToken properties identify other pages that could be retrieved |
Output
This building block provides 21 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
Etag of this resource |
eventId |
STRING |
Serialized EventId of the request which produced this response |
items[] |
OBJECT |
A sponsor resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits |
items[].etag |
STRING |
Etag of this resource |
items[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#sponsor" |
items[].snippet |
OBJECT |
|
items[].snippet.channelId |
STRING |
The id of the channel being sponsored |
items[].snippet.cumulativeDurationMonths |
INTEGER |
The cumulative time a user has been a sponsor in months |
items[].snippet.sponsorDetails |
OBJECT |
|
items[].snippet.sponsorDetails.channelId |
STRING |
The YouTube channel ID |
items[].snippet.sponsorDetails.channelUrl |
STRING |
The channel's URL |
items[].snippet.sponsorDetails.displayName |
STRING |
The channel's display name |
items[].snippet.sponsorDetails.profileImageUrl |
STRING |
The channels's avatar URL |
items[].snippet.sponsorSince |
DATE_TIME |
The date and time when the user became a sponsor. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#sponsorListResponse" |
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 |
Paging details for lists of resources, including total number of items available and number of resources returned in a single page |
pageInfo.resultsPerPage |
INTEGER |
The number of results included in the API response |
pageInfo.totalResults |
INTEGER |
The total number of results in the result set |
tokenPagination |
OBJECT |
Stub token pagination template to suppress results |
visitorId |
STRING |
The visitorId identifies the visitor |
= Parameter name
= Format
|
etag STRING Etag of this resource |
|
eventId STRING Serialized EventId of the request which produced this response |
|
items[] OBJECT A sponsor resource represents a sponsor for a YouTube channel. A sponsor provides recurring monetary support to a creator and receives special benefits |
|
items[].etag STRING Etag of this resource |
|
items[].kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#sponsor" |
|
items[].snippet OBJECT |
|
items[].snippet.channelId STRING The id of the channel being sponsored |
|
items[].snippet.cumulativeDurationMonths INTEGER The cumulative time a user has been a sponsor in months |
|
items[].snippet.sponsorDetails OBJECT |
|
items[].snippet.sponsorDetails.channelId STRING The YouTube channel ID |
|
items[].snippet.sponsorDetails.channelUrl STRING The channel's URL |
|
items[].snippet.sponsorDetails.displayName STRING The channel's display name |
|
items[].snippet.sponsorDetails.profileImageUrl STRING The channels's avatar URL |
|
items[].snippet.sponsorSince DATE_TIME The date and time when the user became a sponsor. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#sponsorListResponse" |
|
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 Paging details for lists of resources, including total number of items available and number of resources returned in a single page |
|
pageInfo.resultsPerPage INTEGER The number of results included in the API response |
|
pageInfo.totalResults INTEGER The total number of results in the result set |
|
tokenPagination OBJECT Stub token pagination template to suppress results |
|
visitorId STRING The visitorId identifies the visitor |