YouTube Data API . liveChatBans

Instance Methods

delete(id)

Removes a chat ban.

insert(part, body=None)

Adds a new ban to the chat.

Method Details

delete(id)
Removes a chat ban.

Args:
  id: string, The id parameter identifies the chat ban to remove. The value uniquely identifies both the ban and the chat. (required)
insert(part, body=None)
Adds a new ban to the chat.

Args:
  part: 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. (required)
  body: object, The request body.
    The object takes the form of:

{ # A liveChatBan resource represents a ban for a YouTube live chat.
    "etag": "A String", # Etag of this resource.
    "id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
    "kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan".
    "snippet": { # The snippet object contains basic details about the ban.
      "banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
      "bannedUserDetails": {
        "channelId": "A String", # The YouTube channel ID.
        "channelUrl": "A String", # The channel's URL.
        "displayName": "A String", # The channel's display name.
        "profileImageUrl": "A String", # The channels's avatar URL.
      },
      "liveChatId": "A String", # The chat this ban is pertinent to.
      "type": "A String", # The type of ban.
    },
  }


Returns:
  An object of the form:

    { # A liveChatBan resource represents a ban for a YouTube live chat.
      "etag": "A String", # Etag of this resource.
      "id": "A String", # The ID that YouTube assigns to uniquely identify the ban.
      "kind": "youtube#liveChatBan", # Identifies what kind of resource this is. Value: the fixed string "youtube#liveChatBan".
      "snippet": { # The snippet object contains basic details about the ban.
        "banDurationSeconds": "A String", # The duration of a ban, only filled if the ban has type TEMPORARY.
        "bannedUserDetails": {
          "channelId": "A String", # The YouTube channel ID.
          "channelUrl": "A String", # The channel's URL.
          "displayName": "A String", # The channel's display name.
          "profileImageUrl": "A String", # The channels's avatar URL.
        },
        "liveChatId": "A String", # The chat this ban is pertinent to.
        "type": "A String", # The type of ban.
      },
    }