List
|
|||||
|
|
||||
Lists moderators for a live chat
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 |
|---|---|---|
liveChatId Required |
STRING |
The liveChatId parameter specifies the YouTube live chat for which the API should return moderators |
part Required |
STRING |
The part parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet |
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
|
liveChatId STRING Required The liveChatId parameter specifies the YouTube live chat for which the API should return moderators |
|
part STRING Required The part parameter specifies the liveChatModerator resource parts that the API response will include. Supported values are id and snippet |
|
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 liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc |
items[].etag |
STRING |
Etag of this resource |
items[].id |
STRING |
The ID that YouTube assigns to uniquely identify the moderator |
items[].kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator" |
items[].snippet |
OBJECT |
|
items[].snippet.liveChatId |
STRING |
The ID of the live chat this moderator can act on |
items[].snippet.moderatorDetails |
OBJECT |
|
items[].snippet.moderatorDetails.channelId |
STRING |
The YouTube channel ID |
items[].snippet.moderatorDetails.channelUrl |
STRING |
The channel's URL |
items[].snippet.moderatorDetails.displayName |
STRING |
The channel's display name |
items[].snippet.moderatorDetails.profileImageUrl |
STRING |
The channels's avatar URL |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModeratorListResponse" |
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 |
prevPageToken |
STRING |
The token that can be used as the value of the pageToken parameter to retrieve the previous page 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 liveChatModerator resource represents a moderator for a YouTube live chat. A chat moderator has the ability to ban/unban users from a chat, remove message, etc |
|
items[].etag STRING Etag of this resource |
|
items[].id STRING The ID that YouTube assigns to uniquely identify the moderator |
|
items[].kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModerator" |
|
items[].snippet OBJECT |
|
items[].snippet.liveChatId STRING The ID of the live chat this moderator can act on |
|
items[].snippet.moderatorDetails OBJECT |
|
items[].snippet.moderatorDetails.channelId STRING The YouTube channel ID |
|
items[].snippet.moderatorDetails.channelUrl STRING The channel's URL |
|
items[].snippet.moderatorDetails.displayName STRING The channel's display name |
|
items[].snippet.moderatorDetails.profileImageUrl STRING The channels's avatar URL |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatModeratorListResponse" |
|
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 |
|
prevPageToken STRING The token that can be used as the value of the pageToken parameter to retrieve the previous page in the result set |
|
tokenPagination OBJECT Stub token pagination template to suppress results |
|
visitorId STRING The visitorId identifies the visitor |