Comments

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

メソッド

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

list

API リクエスト パラメータに一致するコメントのリストを返します。今すぐ試す

insert

既存のコメントへの返信を作成します。注: トップレベルのコメントを作成するには、commentThreads.insert メソッドを使用します。今すぐお試しください。

update

コメントを変更します。今すぐ試す

delete

コメントを削除します。今すぐ試す

setModerationStatus

1 つ以上のコメントのモデレーション ステータスを設定します。API リクエストは、コメントに関連付けられているチャンネルまたは動画の所有者によって承認されている必要があります。今すぐ試す

markAsSpam

注: このメソッドは非推奨となり、サポートが終了しました。

1 つ以上のコメントをスパムとして報告すべきであるという、呼び出し元の意見を表します。

リソース表現

次の 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 形式で指定します。