CommentThreads

commentThread リソースには、YouTube のコメント スレッドに関する情報が含まれます。コメント スレッドは、トップレベルのコメントと、そのコメントに対する返信（存在する場合）で構成されます。commentThread リソースは動画に対するコメントを表します。

トップレベルのコメントと返信は、どちらも commentThread リソース内にネストされた comment リソースです。commentThread リソースには、コメントに対するすべての返信が含まれているとは限りません。特定のコメントに対するすべての返信を取得するには、comments.list メソッドを使用する必要があります。一部のコメントには返信がありません。

メソッド

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

list
API リクエスト パラメータに一致するコメント スレッドのリストを返します。 今すぐ試す
insert
新しいトップレベル コメントを作成します。既存のコメントに返信を追加するには、代わりに comments.insert メソッドを使用します。 こちらから今すぐお試しください。

リソース表現

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

{
  "kind": "youtube#commentThread",
  "etag": etag,
  "id": string,
  "snippet": {
    "channelId": string,
    "videoId": string,
    "topLevelComment": comments Resource,
    "canReply": boolean,
    "totalReplyCount": unsigned integer,
    "isPublic": boolean
  },
  "replies": {
    "comments": [
      comments Resource
    ]
  }
}

プロパティ

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

プロパティ
kind string
API リソースのタイプを指定します。値は youtube#commentThread です。
etag etag
このリソースの ETag。
id string
コメント スレッドを一意に識別するために YouTube によって使用される ID。
snippet object
snippet オブジェクトには、コメント スレッドに関する基本情報が格納されます。また、スレッドの最上位のコメント（comment リソース）も含まれます。
snippet.channelId string
スレッド内のコメントに関連付けられている YouTube チャンネル。snippet.videoId プロパティは動画を識別します。
snippet.videoId string
コメントが参照する動画の ID。
snippet.topLevelComment object
スレッドの最上位コメント。このプロパティの値は comment リソースです。
snippet.canReply boolean
この設定は、現在の閲覧者がスレッドに返信できるかどうかを示します。
snippet.totalReplyCount unsigned integer
最上位のコメントに対して送信された返信の合計数。
snippet.isPublic boolean
この設定は、スレッド（すべてのコメントとコメント返信を含む）をすべての YouTube ユーザーに表示するかどうかを指定します。
replies object
replies オブジェクトは、コメントに対する返信（存在する場合）のリストを含むコンテナです。replies.comments プロパティは、コメント自体のリストを表します。
replies.comments[] list
最上位のコメントに対する 1 つ以上の返信のリスト。リスト内の各項目は comment リソースです。

リストに含まれる返信の数には限りがあり、リスト内のアイテム数が snippet.totalReplyCount プロパティの値と等しくない限り、返信のリストは最上位のコメントに使用できる返信の総数のサブセットにすぎません。最上位コメントに対するすべての返信を取得するには、comments.list メソッドを呼び出し、parentId リクエスト パラメータを使用して、返信を取得するコメントを指定する必要があります。