List

Lists Super Chat events for a channel

4 variables
34 variables

Lists Super Chat events 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

  = Parameter name
  = Format

part STRING Required

The part parameter specifies the superChatEvent resource parts that the API response will include. Supported values are id and snippet

hl STRING

The hl parameter instructs the API to retrieve localized resource metadata for a specific application language that the YouTube website supports. The parameter value must be a language code included in the list returned by the i18nLanguages.list method.

If localized resource details are available in that language, the resource's snippet.localized object will contain the localized values. However, if localized details are not available, the snippet.localized object will contain resource details in the resource's default language

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 34 output parameters

  = Parameter name
  = Format

etag STRING

Etag of this resource

eventId STRING

Serialized EventId of the request which produced this response

items[] OBJECT

A superChatEvent resource represents a Super Chat purchase on a YouTube channel

items[].etag STRING

Etag of this resource

items[].id STRING

The ID that YouTube assigns to uniquely identify the Super Chat event

items[].kind STRING

Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEvent"

items[].snippet OBJECT

items[].snippet.amountMicros INTEGER

The purchase amount, in micros of the purchase currency. e.g., 1 is represented as 1000000

items[].snippet.channelId STRING

Channel id where the event occurred

items[].snippet.commentText STRING

The text contents of the comment left by the user

items[].snippet.createdAt DATE_TIME

The date and time when the event occurred. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format

items[].snippet.currency STRING

The currency in which the purchase was made. ISO 4217

items[].snippet.displayString STRING

A rendered string that displays the purchase amount and currency (e.g., "$1.00"). The string is rendered for the given language

items[].snippet.isSuperChatForGood BOOLEAN

True if this event is a Super Chat for Good purchase

items[].snippet.isSuperStickerEvent BOOLEAN

True if this event is a Super Sticker event

items[].snippet.messageType INTEGER

The tier for the paid message, which is based on the amount of money spent to purchase the message

items[].snippet.nonprofit OBJECT

Nonprofit information

items[].snippet.nonprofit.nonprofitLegalName STRING

Legal name of the nonprofit

items[].snippet.superStickerMetadata OBJECT

items[].snippet.superStickerMetadata.altText STRING

Internationalized alt text that describes the sticker image and any animation associated with it

items[].snippet.superStickerMetadata.altTextLanguage STRING

Specifies the localization language in which the alt text is returned

items[].snippet.superStickerMetadata.stickerId STRING

Unique identifier of the Super Sticker. This is a shorter form of the alt_text that includes pack name and a recognizable characteristic of the sticker

items[].snippet.supporterDetails OBJECT

items[].snippet.supporterDetails.channelId STRING

The YouTube channel ID

items[].snippet.supporterDetails.channelUrl STRING

The channel's URL

items[].snippet.supporterDetails.displayName STRING

The channel's display name

items[].snippet.supporterDetails.profileImageUrl STRING

The channels's avatar URL

kind STRING

Identifies what kind of resource this is. Value: the fixed string "youtube#superChatEventListResponse"

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