Comments

comment リソースには、1 つの YouTube コメントに関する情報が含まれています。comment リソースは、動画またはチャンネルに関するコメントを表すことができます。また、コメントはトップレベルのコメントの場合もあれば、トップレベルのコメントへの返信の場合もあります。

メソッド

この API は、comments リソースに対して次のメソッドをサポートしています。

list
API リクエスト パラメータに一致するコメントのリストを返します。今すぐ試す
insert
既存のコメントに対する返信を作成します。注: 最上位のコメントを作成するには、commentThreads.insert メソッドを使用します。今すぐ試す。
update
コメントを変更します。今すぐ試す
delete
コメントを削除します。今すぐ試す
setModerationStatus
1 つ以上のコメントの管理ステータスを設定します。API リクエストは、コメントに関連付けられているチャンネルまたは動画の所有者によって承認される必要があります。今すぐ試す

リソース表現

次の JSON 構造は、comments リソースの形式を示しています。

{
  "kind": "youtube#comment",
  "etag": etag,
  "id": string,
  "snippet": {
    "authorDisplayName": string,
    "authorProfileImageUrl": string,
    "authorChannelUrl": string,
    "authorChannelId": {
      "value": string
    },
    "channelId": string,
    "textDisplay": string,
    "textOriginal": string,
    "parentId": string,
    "canRate": boolean,
    "viewerRating": string,
    "likeCount": unsigned integer,
    "moderationStatus": string,
    "publishedAt": datetime,
    "updatedAt": datetime
  }
}

プロパティ

次の表は、このリソースで使用されているプロパティの定義を示したものです。

プロパティ
kind string
API リソースのタイプを識別します。値は youtube#comment になります。
etag etag
このリソースの Etag。
id string
YouTube がコメントを一意に識別するために使用する ID。
snippet object
snippet オブジェクトには、コメントに関する基本情報が含まれます。
snippet.authorDisplayName string
コメントを投稿したユーザーの表示名。
snippet.authorProfileImageUrl string
コメントを投稿したユーザーのアバターの URL。
snippet.authorChannelUrl string
コメント投稿者の YouTube チャンネルの URL（利用可能な場合）。
snippet.authorChannelId object
このオブジェクトは、コメント投稿者の YouTube チャンネルに関する情報（利用可能な場合）をカプセル化します。
snippet.authorChannelId.value string
コメント投稿者の YouTube チャンネルの ID（利用可能な場合）。
snippet.channelId string
コメントに関連付けられている YouTube チャンネルの ID。
snippet.textDisplay string
コメントのテキスト。テキストは、プレーン テキストまたは HTML で取得できます。（comments.list メソッドと commentThreads.list メソッドはどちらも、選択したテキスト形式を指定する textFormat パラメータをサポートしています）。

プレーン テキストでさえ、元のコメント テキストと異なる場合があります。たとえば、動画リンクが動画のタイトルに置き換えられることがあります。
snippet.textOriginal string
コメントの元の未加工のテキスト。最初に投稿されたとき、または最後に更新されたときのテキスト。元のテキストは、認証されたユーザーがコメントの作成者である場合にのみ返されます。
snippet.parentId string
親コメントの一意の ID。このプロパティは、コメントが別のコメントへの返信として送信された場合にのみ設定されます。
snippet.canRate boolean
この設定は、現在の閲覧者がコメントを評価できるかどうかを示します。
snippet.viewerRating string
視聴者がこのコメントに付けた評価。このプロパティは dislike のレーティングを識別しませんが、この動作は変更される可能性があります。それまでの間、視聴者がコメントを高く評価している場合、プロパティ値は like になります。ユーザーがコメントに低評価を付けた場合や、コメントを評価しなかった場合など、その他のすべてのケースでは、値は none になります。

このプロパティの有効な値は次のとおりです。
  • like
  • none
snippet.likeCount unsigned integer
コメントが受け取った高評価（肯定的な評価）の合計数。
snippet.moderationStatus string
コメントの管理ステータス。このプロパティは、リクエストされたコメントが投稿されたチャンネルまたは動画の所有者によって API リクエストが承認された場合にのみ返されます。また、API リクエストで id フィルタ パラメータが使用された場合、このプロパティは設定されません。

このプロパティの有効な値は次のとおりです。
  • heldForReview
  • likelySpam
  • published
  • rejected
snippet.publishedAt datetime
コメントが最初に公開された日時。値は ISO 8601 形式で指定します。
snippet.updatedAt datetime
コメントが最後に更新された日時。値は ISO 8601 形式で指定します。