commentThread
リソースには YouTube のコメント スレッドに関する情報が含まれます。これは、そのコメントに対するトップレベルのコメントと返信(存在する場合)で構成されます。commentThread
リソースは、動画またはチャンネルに関するコメントを表します。
トップレベル コメントと返信の両方が comment
リソースであり、いずれも commentThread
リソース内にネストされています。commentThread
リソースには、コメントに対するすべての返信が含まれているとは限りません。特定のコメントに対するすべての返信を取得するには、comments.list
メソッドを使用する必要があります。また、一部のコメントには返信がない場合があります。
Methods
API は、commentThreads
リソースについて次のメソッドをサポートしています。
- list
- API リクエスト パラメータに一致するコメント スレッドのリストを返します。今すぐ試す
- 挿入
- 新しいトップレベル コメントを作成します。既存のコメントへの返信を追加するには、代わりに
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 リクエスト パラメータを使用して返信を取得するコメントを指定する必要があります。 |