liveChatId STRING Required

The liveChatId parameter specifies the ID of the chat whose messages will be returned

part STRING Required

The part parameter specifies the liveChatComment 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 messages 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 property identify other pages that could be retrieved

profileImageSize INTEGER

The profileImageSize parameter specifies the size of the user profile pictures that should be returned in the result set. Default: 88

etag STRING

Etag of this resource

eventId STRING

Serialized EventId of the request which produced this response

items[] OBJECT

A liveChatMessage resource represents a chat message in a YouTube Live Chat

items[].authorDetails OBJECT

items[].authorDetails.channelId STRING

The YouTube channel ID

items[].authorDetails.channelUrl STRING

The channel's URL

items[].authorDetails.displayName STRING

The channel's display name

items[].authorDetails.isChatModerator BOOLEAN

Whether the author is a moderator of the live chat

items[].authorDetails.isChatOwner BOOLEAN

Whether the author is the owner of the live chat

items[].authorDetails.isChatSponsor BOOLEAN

Whether the author is a sponsor of the live chat

items[].authorDetails.isVerified BOOLEAN

Whether the author's identity has been verified by YouTube

items[].authorDetails.profileImageUrl STRING

The channels's avatar URL

items[].etag STRING

Etag of this resource

items[].id STRING

The ID that YouTube assigns to uniquely identify the message

items[].kind STRING

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

items[].snippet OBJECT

items[].snippet.authorChannelId STRING

The ID of the user that authored this message, this field is not always filled. textMessageEvent - the user that wrote the message fanFundingEvent - the user that funded the broadcast newSponsorEvent - the user that just became a sponsor messageDeletedEvent - the moderator that took the action messageRetractedEvent - the author that retracted their message userBannedEvent - the moderator that took the action superChatEvent - the user that made the purchase

items[].snippet.displayMessage STRING

Contains a string that can be displayed to the user. If this field is not present the message is silent, at the moment only messages of type TOMBSTONE and CHAT_ENDED_EVENT are silent

items[].snippet.fanFundingEventDetails OBJECT

items[].snippet.fanFundingEventDetails.amountDisplayString STRING

A rendered string that displays the fund amount and currency to the user

items[].snippet.fanFundingEventDetails.amountMicros INTEGER

The amount of the fund

items[].snippet.fanFundingEventDetails.currency STRING

The currency in which the fund was made

items[].snippet.fanFundingEventDetails.userComment STRING

The comment added by the user to this fan funding event

items[].snippet.hasDisplayContent BOOLEAN

Whether the message has display content that should be displayed to users

items[].snippet.liveChatId STRING

items[].snippet.messageDeletedDetails OBJECT

items[].snippet.messageDeletedDetails.deletedMessageId STRING

items[].snippet.messageRetractedDetails OBJECT

items[].snippet.messageRetractedDetails.retractedMessageId STRING

items[].snippet.pollClosedDetails OBJECT

items[].snippet.pollClosedDetails.pollId STRING

The id of the poll that was closed

items[].snippet.pollEditedDetails OBJECT

items[].snippet.pollEditedDetails.id STRING

items[].snippet.pollEditedDetails.prompt STRING

items[].snippet.pollOpenedDetails OBJECT

items[].snippet.pollOpenedDetails.id STRING

items[].snippet.pollOpenedDetails.prompt STRING

items[].snippet.pollVotedDetails OBJECT

items[].snippet.pollVotedDetails.itemId STRING

The poll item the user chose

items[].snippet.pollVotedDetails.pollId STRING

The poll the user voted on

items[].snippet.publishedAt DATE_TIME

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

items[].snippet.superChatDetails OBJECT

items[].snippet.superChatDetails.amountDisplayString STRING

A rendered string that displays the fund amount and currency to the user

items[].snippet.superChatDetails.amountMicros INTEGER

The amount purchased by the user, in micros (1,750,000 micros = 1.75)

items[].snippet.superChatDetails.currency STRING

The currency in which the purchase was made

items[].snippet.superChatDetails.tier INTEGER

The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1

items[].snippet.superChatDetails.userComment STRING

The comment added by the user to this Super Chat event

items[].snippet.superStickerDetails OBJECT

items[].snippet.superStickerDetails.amountDisplayString STRING

A rendered string that displays the fund amount and currency to the user

items[].snippet.superStickerDetails.amountMicros INTEGER

The amount purchased by the user, in micros (1,750,000 micros = 1.75)

items[].snippet.superStickerDetails.currency STRING

The currency in which the purchase was made

items[].snippet.superStickerDetails.tier INTEGER

The tier in which the amount belongs. Lower amounts belong to lower tiers. The lowest tier is 1

items[].snippet.textMessageDetails OBJECT

items[].snippet.textMessageDetails.messageText STRING

The user's message

items[].snippet.type ENUMERATION

The type of message, this will always be present, it determines the contents of the message as well as which fields will be present

items[].snippet.userBannedDetails OBJECT

items[].snippet.userBannedDetails.banDurationSeconds INTEGER

The duration of the ban. This property is only present if the banType is temporary

items[].snippet.userBannedDetails.banType ENUMERATION

The type of ban

kind STRING

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

nextPageToken STRING

The token that can be used as the value of the pageToken parameter to retrieve the next page in the result set

offlineAt DATE_TIME

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

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

pollingIntervalMillis INTEGER

The amount of time the client should wait before polling again

tokenPagination OBJECT

Stub token pagination template to suppress results

visitorId STRING

The visitorId identifies the visitor