Youtube · Schema

Comment

A comment resource contains information about a single YouTube comment.

GoogleMediaSocialStreamingVideoVideos

Properties

Name	Type	Description
kind	string	Identifies the API resource's type. Value is youtube#comment.
etag	string	The Etag of this resource.
id	string	The ID that YouTube uses to uniquely identify the comment.
snippet	object	The snippet object contains basic details about the comment.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Comment",
  "title": "Comment",
  "type": "object",
  "description": "A comment resource contains information about a single YouTube comment.",
  "required": [
    "kind",
    "etag"
  ],
  "properties": {
    "kind": {
      "type": "string",
      "description": "Identifies the API resource's type. Value is youtube#comment.",
      "default": "youtube#comment",
      "example": "youtube#video"
    },
    "etag": {
      "type": "string",
      "description": "The Etag of this resource.",
      "example": "XI7nbFXulYBIpL0ayR_gDh3eu1k"
    },
    "id": {
      "type": "string",
      "description": "The ID that YouTube uses to uniquely identify the comment.",
      "example": "abc123def456"
    },
    "snippet": {
      "type": "object",
      "description": "The snippet object contains basic details about the comment.",
      "properties": {
        "textOriginal": {
          "type": "string",
          "description": "The original text of the comment as it was initially posted."
        },
        "textDisplay": {
          "type": "string",
          "description": "The comment text as displayed to users."
        },
        "authorDisplayName": {
          "type": "string",
          "description": "The display name of the user who posted the comment."
        },
        "authorProfileImageUrl": {
          "type": "string",
          "description": "The URL for the avatar of the user who posted the comment."
        },
        "authorChannelUrl": {
          "type": "string",
          "description": "A link to the YouTube channel of the comment's author."
        },
        "authorChannelId": {
          "type": "object",
          "description": "An object that encapsulates information about the comment author's YouTube channel.",
          "properties": {
            "value": {
              "type": "string",
              "description": "The author's YouTube channel ID."
            }
          }
        },
        "likeCount": {
          "type": "integer",
          "description": "The total number of likes that the comment has received."
        },
        "viewerRating": {
          "type": "string",
          "description": "The rating the viewer has given to this comment. Note that this property does not currently identify dislike ratings."
        },
        "publishedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when the comment was originally published."
        },
        "updatedAt": {
          "type": "string",
          "format": "date-time",
          "description": "The date and time when the comment was last updated."
        },
        "videoId": {
          "type": "string",
          "description": "The ID of the video the comment refers to."
        },
        "parentId": {
          "type": "string",
          "description": "The unique ID of the parent comment."
        },
        "canRate": {
          "type": "boolean",
          "description": "Indicates whether the current viewer can rate the comment."
        },
        "moderationStatus": {
          "type": "string",
          "description": "The comment's moderation status.",
          "enum": [
            "heldForReview",
            "likelySpam",
            "published",
            "rejected"
          ]
        }
      },
      "example": "example_value"
    }
  }
}