LiveChatBans

liveChatBan リソースは、YouTube ユーザーと、そのユーザーが参加を禁止されている YouTube チャットを識別します。

メソッド

この API は、liveChatBans リソースの次のメソッドをサポートしています。

insert
特定のユーザーがチャットに参加できないようにします。API リクエストは、チャンネル所有者または禁止に関連するチャットのモデレーターによって承認されている必要があります。今すぐ試す
delete
特定のユーザーがチャットに投稿できないようにする禁止を解除し、そのユーザーがチャットに参加できるようにします。API リクエストは、チャンネル所有者または禁止に関連するチャットのモデレーターによって承認されている必要があります。今すぐ試す

リソース表現

次の JSON 構造は、liveChatBans リソースの形式を示しています。

{
  "kind": "youtube#liveChatBan",
  "etag": etag,
  "id": string,
  "snippet": {
    "liveChatId": string,
    "type": string,
    "banDurationSeconds": unsigned long,
    "bannedUserDetails": {
      "channelId": string
    }
  }
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#liveChatBan になります。
etag etag
このリソースの Etag。
id string
禁止を一意に識別するために YouTube が割り当てる ID。
snippet object
snippet オブジェクトは、禁止されたユーザーを識別し、禁止に関する詳細情報を含みます。
snippet.liveChatId string
禁止が適用されるチャット。ブロードキャストに対応するチャット ID は、liveBroadcast リソースの snippet.liveChatId プロパティで返されます。
snippet.type string
禁止の種類。

このプロパティの有効な値は次のとおりです。
  • permanent
  • temporary
snippet.banDurationSeconds unsigned long
禁止の期間。このプロパティの値は、禁止のタイプが temporary の場合にのみ設定します。デフォルト値は 300（5 分）です。
snippet.bannedUserDetails object
このオブジェクトには、禁止されたユーザーを特定する情報が含まれます。
snippet.bannedUserDetails.channelId string
禁止されたユーザーの YouTube チャンネル ID。