1 つ以上のコメントの管理ステータスを設定します。API リクエストは、コメントに関連付けられたチャンネルまたは動画の所有者によって承認される必要があります。
割り当てへの影響: このメソッドの呼び出しには 50 ユニットの割り当てコストが発生します。
一般的なユースケース
リクエスト
HTTP リクエスト
POST https://www.googleapis.com/youtube/v3/comments/setModerationStatus
承認
このリクエストは、少なくとも次のうち 1 つのスコープでの承認が必要です(認証と承認の詳細をご確認ください)。
範囲 |
---|
https://www.googleapis.com/auth/youtube.force-ssl |
パラメータ
次の表に、このクエリでサポートされているパラメータを示します。このリストのパラメータはすべてクエリ パラメータです。
パラメータ | ||
---|---|---|
必須パラメータ | ||
id |
string id パラメータには、管理ステータスを更新するコメントを識別する ID のカンマ区切りのリストを指定します。 |
|
moderationStatus |
string 指定したコメントの新しい管理ステータスを示します。 使用できる値は次のとおりです。
|
|
オプション パラメータ | ||
banAuthor |
boolean banAuthor パラメータを使用すると、コメントの投稿者が追加したコメントを自動的に拒否できます。作成者を禁止するには、パラメータ値を true に設定します。注: このパラメータは、 moderationStatus パラメータも rejected に設定されている場合にのみ有効です。 |
リクエスト本文
このメソッドを呼び出す場合は、リクエストの本文を指定しないでください。
レスポンス
成功すると、このメソッドは HTTP 204
レスポンス コード(No Content
)を返します。
エラー
次の表に、このメソッドの呼び出しに対して API から返されるエラー メッセージを示します。詳細については、エラー メッセージのドキュメントを参照してください。
エラーのタイプ | エラーの詳細 | 説明 |
---|---|---|
badRequest (400) |
banWithoutReject |
banAuthor パラメータは、moderationStatus パラメータ値が rejected の場合にのみ使用できます。 |
badRequest (400) |
operationNotSupported |
Google+ に基づかないコメントについては、限定的な管理機能のみが提供されます。 |
badRequest (400) |
processingFailure |
API サーバーがリクエストを正常に処理できませんでした。これは一時的なエラーである可能性がありますが、通常はリクエストの入力が無効であることを示します。 |
forbidden (403) |
forbidden |
必要な権限がないため、1 つ以上のコメントの管理ステータスを設定できません。リクエストが適切に認証されない可能性があります。 |
notFound (404) |
commentNotFound |
このリクエストで更新しようとしているコメントの 1 つ以上が見つかりません。リクエストの id パラメータの値が正しいことを確認してください。 |
試してみよう:
APIs Explorer を使用してこの API を呼び出し、API リクエストとレスポンスを確認します。