Insert

13 variables

12 variables

Adds a new ban to the 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 13 input parameters

Name	Format	Description
`part` Required	`STRING`	The part parameter serves two purposes in this operation. It identifies the properties that the write operation will set as well as the properties that the API response returns. Set the parameter value to snippet
`etag`	`STRING`	Etag of this resource
`id`	`STRING`	The ID that YouTube assigns to uniquely identify the ban
`kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan"
`snippet`	`OBJECT`
`snippet.banDurationSeconds`	`INTEGER`	The duration of a ban, only filled if the ban has type TEMPORARY
`snippet.bannedUserDetails`	`OBJECT`
`snippet.bannedUserDetails.channelId`	`STRING`	The YouTube channel ID
`snippet.bannedUserDetails.channelUrl`	`STRING`	The channel's URL
`snippet.bannedUserDetails.displayName`	`STRING`	The channel's display name
`snippet.bannedUserDetails.profileImageUrl`	`STRING`	The channels's avatar URL
`snippet.liveChatId`	`STRING`	The chat this ban is pertinent to
`snippet.type`	`ENUMERATION`	The type of ban

= Parameter name
= Format

part STRING Required

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

etag STRING

Etag of this resource

id STRING

The ID that YouTube assigns to uniquely identify the ban

kind STRING

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

snippet OBJECT

snippet.banDurationSeconds INTEGER

The duration of a ban, only filled if the ban has type TEMPORARY

snippet.bannedUserDetails OBJECT

snippet.bannedUserDetails.channelId STRING

The YouTube channel ID

snippet.bannedUserDetails.channelUrl STRING

The channel's URL

snippet.bannedUserDetails.displayName STRING

The channel's display name

snippet.bannedUserDetails.profileImageUrl STRING

The channels's avatar URL

snippet.liveChatId STRING

The chat this ban is pertinent to

snippet.type ENUMERATION

The type of ban

Output

This building block provides 12 output parameters

Name	Format	Description
`etag`	`STRING`	Etag of this resource
`id`	`STRING`	The ID that YouTube assigns to uniquely identify the ban
`kind`	`STRING`	Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan"
`snippet`	`OBJECT`
`snippet.banDurationSeconds`	`INTEGER`	The duration of a ban, only filled if the ban has type TEMPORARY
`snippet.bannedUserDetails`	`OBJECT`
`snippet.bannedUserDetails.channelId`	`STRING`	The YouTube channel ID
`snippet.bannedUserDetails.channelUrl`	`STRING`	The channel's URL
`snippet.bannedUserDetails.displayName`	`STRING`	The channel's display name
`snippet.bannedUserDetails.profileImageUrl`	`STRING`	The channels's avatar URL
`snippet.liveChatId`	`STRING`	The chat this ban is pertinent to
`snippet.type`	`ENUMERATION`	The type of ban