LiveChatBans: insert

特定のユーザーによるチャットへの参加を禁止します。API リクエストは、チャンネル所有者、または参加禁止に関連するチャットの管理メンバーによって承認される必要があります。

一般的なユースケース

リクエスト

HTTP リクエスト

POST https://www.googleapis.com/youtube/v3/liveChat/bans

承認

このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です（認証と承認の詳細をご確認ください）。

範囲
https://www.googleapis.com/auth/youtube
https://www.googleapis.com/auth/youtube.force-ssl

パラメータ

次の表に、このクエリがサポートするパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。

パラメータ
必須パラメータ
part string
このオペレーションでは、part パラメータに 2 つの目的があります。書き込みオペレーションで設定するプロパティと、API レスポンスが返すプロパティを指定します。パラメータ値を snippet に設定します。

リクエスト本文

リクエストの本文に liveChatBan リソースを指定します。対象リソース:

  • 以下のプロパティの値を指定する必要があります。

    • snippet.liveChatId
    • snippet.type
    • snippet.bannedUserDetails.channelId

  • 以下のプロパティの値を設定することができます。

    • snippet.banDurationSeconds

レスポンス

成功すると、このメソッドはレスポンスの本文で liveChatBan リソースを返します。

エラー

次の表に、このメソッドの呼び出しに応じて API から返される可能性のあるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。

エラーのタイプ エラーの詳細 説明
forbidden (403) insufficientPermissions 指定したチャットからユーザーを禁止するために必要な権限がありません。
forbidden (403) liveChatBanInsertionNotAllowed 指定した禁止を作成できません。このエラーは、そのリクエストがチャット オーナーや別のモデレーターの参加禁止を行おうとした場合に発生することがあります。
invalidValue (400) invalidChannelId 指定されたチャンネル ID が見つかりません。
invalidValue (400) invalidLiveChatId リクエストで指定された snippet.liveChatId 値は無効です。関連する liveBroadcast リソースをチェックして、正しい値であることを確認してください。
notFound (404) liveChatNotFound 指定されたチャットが見つかりません。関連する liveBroadcast リソースを調べて、snippet.liveChatId プロパティが正しい値に設定されていることを確認します。
notFound (404) liveChatUserNotFound 参加禁止のチャット ユーザーが見つかりません。
required (400) bannedUserChannelIdRequired リクエストの本文で送信する liveChatBan リソースは、snippet.bannedUserDetails.channelId プロパティの値を指定する必要があります。
required (400) liveChatIdRequired リクエストの本文で送信する liveChatBan リソースは、snippet.liveChatId プロパティの値を指定する必要があります。

実習

APIs Explorer を使用してこの API を呼び出し、API のリクエストとレスポンスを確認します。