comment
リソースには、1 つの YouTube コメントに関する情報が含まれます。comment
リソースは、動画またはチャンネルに関するコメントを表すことができます。また、トップレベルのコメントまたはトップレベルのコメントに対する返信をコメントにすることもできます。
Methods
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 になります。ユーザーがコメントに否定的な評価をした場合や、コメントを評価しなかった場合も同様です。このプロパティの有効な値は次のとおりです。
|
snippet.likeCount |
unsigned integer コメントに付けられた高評価(高評価の評価)の合計数。 |
snippet.moderationStatus |
string コメントの管理ステータス。このプロパティは、API リクエストが、リクエストされたコメントが行われたチャンネルまたは動画の所有者によって承認されている場合にのみ返されます。また、API リクエストで id フィルタ パラメータが使用された場合、このプロパティは設定されません。このプロパティの有効な値は次のとおりです。
|
snippet.publishedAt |
datetime コメントが最初に公開された日時。値は ISO 8601 形式で指定します。 |
snippet.updatedAt |
datetime コメントが最後に更新された日時。値は ISO 8601 形式で指定します。 |