Insert
|
|||||
|
|
||||
Creates a reply to an existing comment. Note: To create a top-level comment, use the commentThreads.insert method
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- See, edit, and permanently delete your YouTube videos, ratings, comments and captions
Input
This building block consumes 20 input parameters
| Name | Format | Description |
|---|---|---|
part Required |
STRING |
The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units |
etag |
STRING |
Etag of this resource |
id |
STRING |
The ID that YouTube uses to uniquely identify the comment |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#comment" |
snippet |
OBJECT |
Basic details about a comment, such as its author and text |
snippet.authorChannelId |
ANY |
The id of the author's YouTube channel, if any |
snippet.authorChannelUrl |
STRING |
Link to the author's YouTube channel, if any |
snippet.authorDisplayName |
STRING |
The name of the user who posted the comment |
snippet.authorProfileImageUrl |
STRING |
The URL for the avatar of the user who posted the comment |
snippet.canRate |
BOOLEAN |
Whether the current viewer can rate this comment |
snippet.channelId |
STRING |
The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel |
snippet.likeCount |
INTEGER |
The total number of likes this comment has received |
snippet.moderationStatus |
ENUMERATION |
The comment's moderation status. Will not be set if the comments were requested through the id filter |
snippet.parentId |
STRING |
The unique id of the parent comment, only set for replies |
snippet.publishedAt |
DATE_TIME |
The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.textDisplay |
STRING |
The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc |
snippet.textOriginal |
STRING |
The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author |
snippet.updatedAt |
DATE_TIME |
The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.videoId |
STRING |
The ID of the video the comment refers to, if any |
snippet.viewerRating |
ENUMERATION |
The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future |
= Parameter name
= Format
|
part STRING Required The part parameter identifies the properties that the API response will include. Set the parameter value to snippet. The snippet part has a quota cost of 2 units |
|
etag STRING Etag of this resource |
|
id STRING The ID that YouTube uses to uniquely identify the comment |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#comment" |
|
snippet OBJECT Basic details about a comment, such as its author and text |
|
snippet.authorChannelId ANY The id of the author's YouTube channel, if any |
|
snippet.authorChannelUrl STRING Link to the author's YouTube channel, if any |
|
snippet.authorDisplayName STRING The name of the user who posted the comment |
|
snippet.authorProfileImageUrl STRING The URL for the avatar of the user who posted the comment |
|
snippet.canRate BOOLEAN Whether the current viewer can rate this comment |
|
snippet.channelId STRING The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel |
|
snippet.likeCount INTEGER The total number of likes this comment has received |
|
snippet.moderationStatus ENUMERATION The comment's moderation status. Will not be set if the comments were requested through the id filter |
|
snippet.parentId STRING The unique id of the parent comment, only set for replies |
|
snippet.publishedAt DATE_TIME The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
snippet.textDisplay STRING The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc |
|
snippet.textOriginal STRING The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author |
|
snippet.updatedAt DATE_TIME The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
snippet.videoId STRING The ID of the video the comment refers to, if any |
|
snippet.viewerRating ENUMERATION The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future |
Output
This building block provides 19 output parameters
| Name | Format | Description |
|---|---|---|
etag |
STRING |
Etag of this resource |
id |
STRING |
The ID that YouTube uses to uniquely identify the comment |
kind |
STRING |
Identifies what kind of resource this is. Value: the fixed string "youtube#comment" |
snippet |
OBJECT |
Basic details about a comment, such as its author and text |
snippet.authorChannelId |
ANY |
The id of the author's YouTube channel, if any |
snippet.authorChannelUrl |
STRING |
Link to the author's YouTube channel, if any |
snippet.authorDisplayName |
STRING |
The name of the user who posted the comment |
snippet.authorProfileImageUrl |
STRING |
The URL for the avatar of the user who posted the comment |
snippet.canRate |
BOOLEAN |
Whether the current viewer can rate this comment |
snippet.channelId |
STRING |
The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel |
snippet.likeCount |
INTEGER |
The total number of likes this comment has received |
snippet.moderationStatus |
ENUMERATION |
The comment's moderation status. Will not be set if the comments were requested through the id filter |
snippet.parentId |
STRING |
The unique id of the parent comment, only set for replies |
snippet.publishedAt |
DATE_TIME |
The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.textDisplay |
STRING |
The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc |
snippet.textOriginal |
STRING |
The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author |
snippet.updatedAt |
DATE_TIME |
The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
snippet.videoId |
STRING |
The ID of the video the comment refers to, if any |
snippet.viewerRating |
ENUMERATION |
The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future |
= Parameter name
= Format
|
etag STRING Etag of this resource |
|
id STRING The ID that YouTube uses to uniquely identify the comment |
|
kind STRING Identifies what kind of resource this is. Value: the fixed string "youtube#comment" |
|
snippet OBJECT Basic details about a comment, such as its author and text |
|
snippet.authorChannelId ANY The id of the author's YouTube channel, if any |
|
snippet.authorChannelUrl STRING Link to the author's YouTube channel, if any |
|
snippet.authorDisplayName STRING The name of the user who posted the comment |
|
snippet.authorProfileImageUrl STRING The URL for the avatar of the user who posted the comment |
|
snippet.canRate BOOLEAN Whether the current viewer can rate this comment |
|
snippet.channelId STRING The id of the corresponding YouTube channel. In case of a channel comment this is the channel the comment refers to. In case of a video comment it's the video's channel |
|
snippet.likeCount INTEGER The total number of likes this comment has received |
|
snippet.moderationStatus ENUMERATION The comment's moderation status. Will not be set if the comments were requested through the id filter |
|
snippet.parentId STRING The unique id of the parent comment, only set for replies |
|
snippet.publishedAt DATE_TIME The date and time when the comment was orignally published. The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
snippet.textDisplay STRING The comment's text. The format is either plain text or HTML dependent on what has been requested. Even the plain text representation may differ from the text originally posted in that it may replace video links with video titles etc |
|
snippet.textOriginal STRING The comment's original raw text as initially posted or last updated. The original text will only be returned if it is accessible to the viewer, which is only guaranteed if the viewer is the comment's author |
|
snippet.updatedAt DATE_TIME The date and time when was last updated . The value is specified in ISO 8601 (YYYY-MM-DDThh:mm:ss.sZ) format |
|
snippet.videoId STRING The ID of the video the comment refers to, if any |
|
snippet.viewerRating ENUMERATION The rating the viewer has given to this comment. For the time being this will never return RATE_TYPE_DISLIKE and instead return RATE_TYPE_NONE. This may change in the future |