Comments

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

Methods

この API では、comments リソースについて次のメソッドがサポートされています。

list
API リクエストのパラメータに一致するコメントのリストを返します。今すぐ試す
挿入
既存のコメントへの返信を作成します。注: 最上位のコメントを作成するには、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 形式で指定します。