LiveChatBans: insert

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストには、次のいずれかのスコープによる承認が必要です。認証と認可の詳細については、OAuth 2.0 認証の実装をご覧ください。

スコープ
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 - 次のいずれかのオプションを選択します: permanent または temporary
    • snippet.bannedUserDetails.channelId

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

    • snippet.banDurationSeconds

レスポンス

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

エラー

次の表に、このメソッドの呼び出しに対して API から返されるエラー メッセージを示します。詳しくは、YouTube Live Streaming 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 リクエストとレスポンスを確認します。