Insert

Adds a message to a live chat

71 variables
70 variables

Adds a message to 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

Input

This building block consumes 71 input parameters

  = Parameter name
  = Format

part STRING Required

The part parameter serves two purposes. It identifies the properties that the write operation will set as well as the properties that the API response will include. Set the parameter value to snippet

authorDetails OBJECT

authorDetails.channelId STRING

The YouTube channel ID

authorDetails.channelUrl STRING

The channel's URL

authorDetails.displayName STRING

The channel's display name

authorDetails.isChatModerator BOOLEAN

Whether the author is a moderator of the live chat

authorDetails.isChatOwner BOOLEAN

Whether the author is the owner of the live chat

authorDetails.isChatSponsor BOOLEAN

Whether the author is a sponsor of the live chat

authorDetails.isVerified BOOLEAN

Whether the author's identity has been verified by YouTube

authorDetails.profileImageUrl STRING

The channels's avatar URL

etag STRING

Etag of this resource

id STRING

The ID that YouTube assigns to uniquely identify the message

kind STRING

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

snippet OBJECT

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

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

snippet.fanFundingEventDetails OBJECT

snippet.fanFundingEventDetails.amountDisplayString STRING

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

snippet.fanFundingEventDetails.amountMicros INTEGER

The amount of the fund

snippet.fanFundingEventDetails.currency STRING

The currency in which the fund was made

snippet.fanFundingEventDetails.userComment STRING

The comment added by the user to this fan funding event

snippet.hasDisplayContent BOOLEAN

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

snippet.liveChatId STRING

snippet.messageDeletedDetails OBJECT

snippet.messageDeletedDetails.deletedMessageId STRING

snippet.messageRetractedDetails OBJECT

snippet.messageRetractedDetails.retractedMessageId STRING

snippet.pollClosedDetails OBJECT

snippet.pollClosedDetails.pollId STRING

The id of the poll that was closed

snippet.pollEditedDetails OBJECT

snippet.pollEditedDetails.id STRING

snippet.pollEditedDetails.items[] OBJECT

snippet.pollEditedDetails.items[].description STRING

Plain text description of the item

snippet.pollEditedDetails.items[].itemId STRING

snippet.pollEditedDetails.prompt STRING

snippet.pollOpenedDetails OBJECT

snippet.pollOpenedDetails.id STRING

snippet.pollOpenedDetails.items[] OBJECT

snippet.pollOpenedDetails.items[].description STRING

Plain text description of the item

snippet.pollOpenedDetails.items[].itemId STRING

snippet.pollOpenedDetails.prompt STRING

snippet.pollVotedDetails OBJECT

snippet.pollVotedDetails.itemId STRING

The poll item the user chose

snippet.pollVotedDetails.pollId STRING

The poll the user voted on

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

snippet.superChatDetails OBJECT

snippet.superChatDetails.amountDisplayString STRING

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

snippet.superChatDetails.amountMicros INTEGER

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

snippet.superChatDetails.currency STRING

The currency in which the purchase was made

snippet.superChatDetails.tier INTEGER

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

snippet.superChatDetails.userComment STRING

The comment added by the user to this Super Chat event

snippet.superStickerDetails OBJECT

snippet.superStickerDetails.amountDisplayString STRING

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

snippet.superStickerDetails.amountMicros INTEGER

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

snippet.superStickerDetails.currency STRING

The currency in which the purchase was made

snippet.superStickerDetails.superStickerMetadata OBJECT

snippet.superStickerDetails.superStickerMetadata.altText STRING

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

snippet.superStickerDetails.superStickerMetadata.altTextLanguage STRING

Specifies the localization language in which the alt text is returned

snippet.superStickerDetails.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

snippet.superStickerDetails.tier INTEGER

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

snippet.textMessageDetails OBJECT

snippet.textMessageDetails.messageText STRING

The user's message

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

snippet.userBannedDetails OBJECT

snippet.userBannedDetails.banDurationSeconds INTEGER

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

snippet.userBannedDetails.banType ENUMERATION

The type of ban

snippet.userBannedDetails.bannedUserDetails OBJECT

snippet.userBannedDetails.bannedUserDetails.channelId STRING

The YouTube channel ID

snippet.userBannedDetails.bannedUserDetails.channelUrl STRING

The channel's URL

snippet.userBannedDetails.bannedUserDetails.displayName STRING

The channel's display name

snippet.userBannedDetails.bannedUserDetails.profileImageUrl STRING

The channels's avatar URL

Output

This building block provides 70 output parameters

  = Parameter name
  = Format

authorDetails OBJECT

authorDetails.channelId STRING

The YouTube channel ID

authorDetails.channelUrl STRING

The channel's URL

authorDetails.displayName STRING

The channel's display name

authorDetails.isChatModerator BOOLEAN

Whether the author is a moderator of the live chat

authorDetails.isChatOwner BOOLEAN

Whether the author is the owner of the live chat

authorDetails.isChatSponsor BOOLEAN

Whether the author is a sponsor of the live chat

authorDetails.isVerified BOOLEAN

Whether the author's identity has been verified by YouTube

authorDetails.profileImageUrl STRING

The channels's avatar URL

etag STRING

Etag of this resource

id STRING

The ID that YouTube assigns to uniquely identify the message

kind STRING

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

snippet OBJECT

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

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

snippet.fanFundingEventDetails OBJECT

snippet.fanFundingEventDetails.amountDisplayString STRING

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

snippet.fanFundingEventDetails.amountMicros INTEGER

The amount of the fund

snippet.fanFundingEventDetails.currency STRING

The currency in which the fund was made

snippet.fanFundingEventDetails.userComment STRING

The comment added by the user to this fan funding event

snippet.hasDisplayContent BOOLEAN

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

snippet.liveChatId STRING

snippet.messageDeletedDetails OBJECT

snippet.messageDeletedDetails.deletedMessageId STRING

snippet.messageRetractedDetails OBJECT

snippet.messageRetractedDetails.retractedMessageId STRING

snippet.pollClosedDetails OBJECT

snippet.pollClosedDetails.pollId STRING

The id of the poll that was closed

snippet.pollEditedDetails OBJECT

snippet.pollEditedDetails.id STRING

snippet.pollEditedDetails.items[] OBJECT

snippet.pollEditedDetails.items[].description STRING

Plain text description of the item

snippet.pollEditedDetails.items[].itemId STRING

snippet.pollEditedDetails.prompt STRING

snippet.pollOpenedDetails OBJECT

snippet.pollOpenedDetails.id STRING

snippet.pollOpenedDetails.items[] OBJECT

snippet.pollOpenedDetails.items[].description STRING

Plain text description of the item

snippet.pollOpenedDetails.items[].itemId STRING

snippet.pollOpenedDetails.prompt STRING

snippet.pollVotedDetails OBJECT

snippet.pollVotedDetails.itemId STRING

The poll item the user chose

snippet.pollVotedDetails.pollId STRING

The poll the user voted on

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

snippet.superChatDetails OBJECT

snippet.superChatDetails.amountDisplayString STRING

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

snippet.superChatDetails.amountMicros INTEGER

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

snippet.superChatDetails.currency STRING

The currency in which the purchase was made

snippet.superChatDetails.tier INTEGER

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

snippet.superChatDetails.userComment STRING

The comment added by the user to this Super Chat event

snippet.superStickerDetails OBJECT

snippet.superStickerDetails.amountDisplayString STRING

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

snippet.superStickerDetails.amountMicros INTEGER

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

snippet.superStickerDetails.currency STRING

The currency in which the purchase was made

snippet.superStickerDetails.superStickerMetadata OBJECT

snippet.superStickerDetails.superStickerMetadata.altText STRING

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

snippet.superStickerDetails.superStickerMetadata.altTextLanguage STRING

Specifies the localization language in which the alt text is returned

snippet.superStickerDetails.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

snippet.superStickerDetails.tier INTEGER

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

snippet.textMessageDetails OBJECT

snippet.textMessageDetails.messageText STRING

The user's message

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

snippet.userBannedDetails OBJECT

snippet.userBannedDetails.banDurationSeconds INTEGER

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

snippet.userBannedDetails.banType ENUMERATION

The type of ban

snippet.userBannedDetails.bannedUserDetails OBJECT

snippet.userBannedDetails.bannedUserDetails.channelId STRING

The YouTube channel ID

snippet.userBannedDetails.bannedUserDetails.channelUrl STRING

The channel's URL

snippet.userBannedDetails.bannedUserDetails.displayName STRING

The channel's display name

snippet.userBannedDetails.bannedUserDetails.profileImageUrl STRING

The channels's avatar URL