LiveChatBans

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

Methods

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

挿入
特定のユーザーによるチャットへの参加を禁止します。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。