Comments: setModerationStatus

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 パラメータは、モデレーション ステータスを更新するコメントを識別する最大 50 個の ID のカンマ区切りリストを指定します。
moderationStatus string
指定したコメントの新しいモデレーション ステータスを指定します。

使用できる値は次のとおりです。
  • heldForReview – コメントにモデレーターによる確認待ちのマークを付けます。
  • published – コメントを一般公開します。不承認のコメントのモデレーション ステータスを published に変更することはできません。
  • rejected – コメントを不適切として不承認にします。この操作を行うと、不承認のコメントへの返信もすべて非表示になります。他のユーザーが作成したコメントをチャンネルまたは動画から削除するには、モデレーション ステータスを rejected に設定します。comments.delete メソッドは、コメントの元の作成者のみが使用できます。
オプション パラメータ
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 つ以上のコメントのモデレーション ステータスを設定できません。リクエストが承認されていない可能性があります。このエラーは、削除されたコメント ID または無効なコメント ID をモデレートしようとした場合にも返されます。
notFound (404) commentNotFound リクエストで更新しようとしているコメントの 1 つ以上が見つかりません。リクエストの id パラメータの値が正しいことを確認してください。

試してみよう:

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