LiveChatBans: insert

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

一般的なユースケース

リクエスト

HTTP リクエスト

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

承認

このリクエストは、少なくとも次のうち 1 つのスコープによる承認が必要です。認証と承認の詳細については、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
    • 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 リクエストとレスポンスを確認します。