特定のユーザーのチャットへの参加を禁止します。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.liveChatIdsnippet.typesnippet.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 のリクエストとレスポンスを確認します。